ci: gate documentation pointers so a dead one fails the build
Pointing at a doc instead of duplicating its prose next to the code is what the comment-block lint pushes people toward, and nothing checked that the pointers still resolve. The reorg that prompted the preceding commit broke 41 references and every one of them merged green. Two arms: repo-root-relative `docs/` paths, and relative markdown links resolved against the linking file. Scope is every tracked file rather than a type list — the dead references were in css, html and an ignore file as well as in markdown and nix. Three controls, because a link checker whose extractor quietly matches nothing passes forever while checking nothing: each arm must have found candidates, and at least one pointer must have resolved. Any of those failing exits non-zero and says the script is broken rather than the tree. Escape hatch is the `lint:allow` marker the tracker-tag lint already uses. Its only current users are in reference-docs.nix, where a path naming a file the derivation synthesizes into $out is correct precisely because the repo does not have it. Also runs in the pre-push hook alongside the other two.
This commit is contained in:
parent
caf5896303
commit
54daf9ac60
4 changed files with 127 additions and 3 deletions
|
|
@ -53,3 +53,17 @@ jobs:
|
|||
# protection) — a hit blocks merge. See
|
||||
# scripts/check-comment-blocks.sh.
|
||||
run: sh scripts/check-comment-blocks.sh
|
||||
|
||||
doc-refs:
|
||||
name: doc-pointer lint
|
||||
runs-on: [hive-ci]
|
||||
# Pure git+grep — seconds.
|
||||
timeout-minutes: 5
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: lint
|
||||
# Flags `docs/…md` paths and relative markdown links that no
|
||||
# longer resolve. Pointing at a doc is what the comment-block
|
||||
# lint above pushes people toward, so the pointers need a gate of
|
||||
# their own. See scripts/check-doc-refs.sh.
|
||||
run: sh scripts/check-doc-refs.sh
|
||||
|
|
|
|||
Loading…
Reference in a new issue