Skip to content

Commit 1edced2

Browse files
committed
Document master-vs-release drift as a fourth unfixable sub-cause
Our haddocks are built from cardano-api master against pinned upstream releases, but the upstream doc sites we link to publish from their own master. Symbols moved or removed between the pinned release and current master surface as 404s through no fault of this script. Pointed out by palas in PR review.
1 parent b85cc4a commit 1edced2

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

scripts/fix-haddock-links.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,13 @@
9191
# c. Haddock-emitted absolute Hackage URLs that lack a package
9292
# version (Hackage's routing requires one). A handful, out
9393
# of our control, treated as noise.
94+
# d. Master-vs-release drift between us and our dependencies.
95+
# Our haddocks are built from cardano-api master, which pins
96+
# specific releases of upstream packages. The linked upstream
97+
# doc sites publish from their master, which may have moved
98+
# or removed symbols since the release we pin. Our hrefs are
99+
# correct against the pinned release but 404 against current
100+
# master haddocks.
94101
#
95102
# Escape hatch: FIX_HADDOCK_LINKS_ALLOW_DEAD=1 exits 0 even if there
96103
# are actionable entries, e.g. to deploy while investigating. Under

0 commit comments

Comments
 (0)