Skip to content

Commit c519b3a

Browse files
committed
[#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: * #3 * #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
1 parent 388194c commit c519b3a

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

.github/workflows/checks.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,14 @@ jobs:
108108

109109
- name: Diff plans
110110
run: GH=1 ./scripts/release/cabal-plan-diff.sh
111+
112+
xrefcheck:
113+
114+
name: Check references
115+
runs-on: ubuntu-latest
116+
117+
steps:
118+
- uses: actions/checkout@v4
119+
- uses: serokell/xrefcheck-action@v1
120+
with:
121+
xrefcheck-version: 0.3.1

0 commit comments

Comments
 (0)