weekly-docs

feat: add --use-parameter-defaults flag #6224

Sign in to view logs

Summary
Jobs
- check-docs
Run details
- Usage
- Workflow file

Workflow file for this run

.github/workflows/weekly-docs.yaml at 5645473

	name: weekly-docs
	# runs every monday at 9 am
	on:
	schedule:
	- cron: "0 9 * * 1"
	workflow_dispatch: # allows to run manually for testing
	pull_request:
	branches:
	- main
	paths:
	- "docs/**"

	permissions:
	contents: read

	jobs:
	check-docs:
	# later versions of Ubuntu have disabled unprivileged user namespaces, which are required by the action
	runs-on: ubuntu-22.04
	permissions:
	pull-requests: write # required to post PR review comments by the action
	steps:
	- name: Harden Runner
	uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2
	with:
	egress-policy: audit

	- name: Checkout
	uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
	with:
	persist-credentials: false

	- name: Check Markdown links
	uses: umbrelladocs/action-linkspector@652f85bc57bb1e7d4327260decc10aa68f7694c3 # v1.4.0
	id: markdown-link-check
	# checks all markdown files from /docs including all subfolders
	with:
	reporter: github-pr-review
	config_file: ".github/.linkspector.yml"
	fail_on_error: "true"
	filter_mode: "file"

	- name: Send Slack notification
	if: failure() && github.event_name == 'schedule'
	run: \|
	curl \
	-X POST \
	-H 'Content-type: application/json' \
	-d '{"msg":"Broken links found in the documentation. Please check the logs at '"${LOGS_URL}"'"}' "${{ secrets.DOCS_LINK_SLACK_WEBHOOK }}"
	echo "Sent Slack notification"
	env:
	LOGS_URL: https://github.com/coder/coder/actions/runs/${{ github.run_id }}