vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

check-issue-refs: catch full forge issue URLs too, drop internal links from docs entirely

Browse source
This commit is contained in:
damocles 2026-09-09 21:15:28 +02:00
commit a4f72365c7
22 changed files with 59 additions and 80 deletions
Download patch file Download diff file Expand all files Collapse all files

53
scripts/check-issue-refs.sh
View file

@ -1,40 +1,35 @@
#!/bin/sh
# CI lint: flags tracker tags (a hash followed by an issue number) anywhere
# in tracked text, source or docs. The hive convention is prose, not
# tracker tags — in code because tags rot (they point at moving targets and
# leak tracker coupling into the source tree); in markdown because the
# forge's public mirror carries no issue/PR data at all, so *any* `#N`
# form — bare, qualified `owner/repo#N`, or an ambiguous glued `owner#N` —
# is equally dead weight for a public reader. No exemption for markdown:
# that used to exist ("prose docs may cite the tracker with a bare `#N`")
# and got dropped once that read as still allowing exactly the kind of
# reference the public-mirror problem rules out.
# CI lint: flags tracker references — a `#N` tag or a full `.../issues/N`
# forge URL — anywhere in tracked text, source or docs. Prose, not tracker
# references: in code because tags rot; in markdown because the forge's
# public mirror carries no issue/PR data at all, so bare/qualified/glued
# `#N` and a full link are equally dead weight for a public reader — a
# full URL is the same problem spelled out longer, not a safer swap for a
# short tag. No markdown exemption: one used to exist, dropped once that
# read as still allowing exactly this.
#
# Emits a CI error annotation per hit and exits 1 if any tag is found, 0
# otherwise. It runs as its own CI job and IS a required check on the forge
# (branch protection) — a hit blocks merge.
# Emits a CI error annotation per hit, exits 1 if any hit is found. Its own
# required CI job (branch protection) — a hit blocks merge.
#
# Scope: every tracked `*.rs *.nix *.js *.ts *.tsx *.css *.html *.md`. The
# pattern matches a hash, 2-5 digits, then a non-alphanumeric char or
# end-of-line. A real tracker tag is never glued to a letter, so the
# trailing class skips both letter-bearing / 6-8-digit hex colours (the
# digit run breaks or overruns) and digit-runs followed by a letter — e.g.
# hash-route fragments like #24h. Residual: a pure-numeric short hex (e.g.
# three identical digits) trips it — write the six-digit form to dodge.
# Scope: every tracked `*.rs *.nix *.js *.ts *.tsx *.css *.html *.md`. Two
# alternatives: a hash, 2-5 digits, then non-alphanumeric-or-EOL (skips
# letter-bearing hex colours and digit-runs-then-letter, e.g. `#24h`;
# residual: a pure-numeric short hex trips it, write the six-digit form to
# dodge); or an `/issues/N` path segment, catching a full link via
# `$HIVE_FORGE_URL` or a literal domain alike.
#
# Escape hatch: a line containing the marker `lint:allow` is exempt.
# Reserve it for genuine `#<digits>` that aren't tracker tags — e.g. a
# `#123` markdown-heading example or hash-prefixed test-input data — and
# keep a short reason next to the marker. Don't use it to keep a real
# tracker tag; rewrite those to prose (or a full issue URL) instead.
# Escape hatch: a line with the marker `lint:allow` is exempt. Reserve it
# for a genuine non-tag hit (a `#123` heading example, test-input data) and
# keep a short reason next to it — not for a real reference of either
# form; rewrite those to prose that stands on its own instead.
set -eu
pattern='#[0-9]{2,5}([^0-9a-zA-Z]|$)'
pattern='#[0-9]{2,5}([^0-9a-zA-Z]|$)|/issues/[0-9]+([^0-9a-zA-Z]|$)'
# `/dev/null` forces grep to always print a filename prefix, even when
# xargs hands it a single file. `-r`/`-0` keep it robust to odd paths and
# an empty file list. Lines carrying the `lint:allow` marker are dropped
# (legitimate non-tracker `#<digits>`; see the header).
# (legitimate non-tracker hit; see the header).
hits="$(
git ls-files -z '*.rs' '*.nix' '*.js' '*.ts' '*.tsx' '*.css' '*.html' '*.md' \
| xargs -0 -r grep -nE "$pattern" /dev/null 2>/dev/null \
@ -43,10 +38,10 @@ hits="$(
if [ -n "$hits" ]; then
echo "$hits" | while IFS=: read -r file lineno _; do
printf '::error file=%s,line=%s::tracker tag — write prose or a full issue URL, not a hash-number tag (see /knowledge/hive-rules.md)\n' "$file" "$lineno"
printf '::error file=%s,line=%s::tracker reference — write prose that stands on its own, not a hash-number tag or a full issue URL (see /knowledge/hive-rules.md)\n' "$file" "$lineno"
done
count="$(printf '%s\n' "$hits" | wc -l | tr -d ' ')"
printf 'check-issue-refs: %s tracker tag(s) found\n' "$count" >&2
printf 'check-issue-refs: %s tracker reference(s) found\n' "$count" >&2
exit 1
fi
exit 0