From 3ab24e5d20af01439e7daccb6437e73114df9fd5 Mon Sep 17 00:00:00 2001 From: per1234 Date: Thu, 22 Oct 2020 06:47:08 -0700 Subject: [PATCH] Add CI workflow to check for broken links in documentation --- .github/workflows/check-links.yml | 32 +++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/workflows/check-links.yml diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml new file mode 100644 index 000000000..41474a04c --- /dev/null +++ b/.github/workflows/check-links.yml @@ -0,0 +1,32 @@ +name: Check documentation links + +on: + push: + paths: + - ".github/workflows/check-links.yml" + - "Taskfile.yml" + - "**.md" + pull_request: + paths: + - ".github/workflows/check-links.yml" + - "Taskfile.yml" + - "**.md" + schedule: + # Run every Tuesday at 03:00 UTC to catch broken links caused by external changes + - cron: "0 3 * * 2" + +jobs: + check-links: + runs-on: ubuntu-latest + steps: + - name: Checkout local repository + uses: actions/checkout@v2 + + - name: Install Taskfile + uses: arduino/actions/setup-taskfile@master + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + version: 3.x + + - name: Check links + run: task --silent docs:check-links