From cff5ed560d25ec1b6d3d37a3a216eb41ce559b55 Mon Sep 17 00:00:00 2001 From: Ivan Gromakovskii Date: Tue, 23 Jan 2024 17:04:56 +0100 Subject: [PATCH] [#4] Use xrefcheck to check links on CI Problem: Markdown files contain a plenty of links which tend to get outdated occasionally. It's hard to notice when a certain link (local or global) becomes broken. Solution: in the past, the `xrefcheck` tool was used to find broken links: * https://github.com/IntersectMBO/ouroboros-consensus/pull/3 * https://github.com/IntersectMBO/ouroboros-consensus/pull/454 See https://github.com/serokell/xrefcheck This PR automates `xrefcheck` running by adding it as a new GitHub Action job. It uses [xrefcheck-action](https://github.com/serokell/xrefcheck-action) under the hood. Resolves #4 --- .github/workflows/checks.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 4a168b787c..1d72749a78 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -108,3 +108,14 @@ jobs: - name: Diff plans run: GH=1 ./scripts/release/cabal-plan-diff.sh + + xrefcheck: + + name: Check references + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - uses: serokell/xrefcheck-action@v1 + with: + xrefcheck-version: 0.2.2