2021-05-20 08:22:42 +00:00
name : Check for bad links in documentation
2020-11-13 02:20:30 +00:00
2022-02-02 02:02:37 +00:00
on :
pull_request :
paths :
# Only run on changes to .md files -- this check is too flakey to run on every PR
- '**.md'
workflow_dispatch : # Manual
schedule :
- cron : '0 6 * * *' # Nightly 6AM UTC
2022-10-07 15:43:56 +00:00
2022-10-24 20:01:00 +00:00
# This allows a subsequently queued workflow run to interrupt previous runs
concurrency :
group : ${{ github.workflow }}-${{ github.head_ref || github.run_id}}
cancel-in-progress : true
2022-10-07 15:43:56 +00:00
defaults :
run :
# fail-fast using bash -eo pipefail. See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#exit-codes-and-error-action-preference
shell : bash
2022-03-28 20:20:31 +00:00
permissions :
contents : read
2020-11-13 02:20:30 +00:00
jobs :
markdown-link-check :
2022-10-07 15:43:56 +00:00
permissions :
contents : read # to read files to check dead links
2020-11-13 02:20:30 +00:00
runs-on : ubuntu-latest
steps :
2023-08-31 17:09:21 +00:00
- uses : actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
- uses : gaurav-nelson/github-action-markdown-link-check@d53a906aa6b22b8979d33bc86170567e619495ec # v1.0.15
2020-11-13 03:06:06 +00:00
with :
use-quiet-mode : 'yes'
2022-10-07 15:43:56 +00:00
config-file : .github/workflows/config/markdown-link-check-config.json
2021-06-07 02:18:28 +00:00
base-branch : ${{ github.base_ref }}
