Fix Haddock dead-link CI failure: add fs-api's doc site - #1284
Open
palas wants to merge 1 commit into
Open
Conversation
palas
requested review from
CarlosLopezDeLara,
Jimbo4350,
carbolymer,
disassembler and
erikd
as code owners
August 8, 2026 00:01
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes the Haddock dead-link CI failure by extending the doc-site probing configuration used by scripts/fix-haddock-links.sh, so that CHaP package links for fs-api (and fs-sim) can resolve during the Haddock link check.
Changes:
- Add
https://input-output-hk.github.io/fs-simas an additional candidate inIOG_DOC_BASESfor doc-index probing. - Add a Herald changelog fragment documenting the maintenance change and referencing issue #1279.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| scripts/fix-haddock-links.sh | Adds fs-sim GitHub Pages base URL to the fallback doc-site probe list (IOG_DOC_BASES). |
| .changes/20260807_cardano_api_haddock_fs_api_doc_site.yml | Records the maintenance change in the project changelog fragment system. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Since the node-11.1 integration (#1221) the generated haddocks contain cross-package links to fs-api, and the "Update github pages" workflow fails because scripts/fix-haddock-links.sh cannot resolve a doc site for it: fs-api lives in the fs-sim repository, which publishes its Haddocks from gh-pages of the input-output-hk organisation (the repo was never migrated to IntersectMBO), so the *.cardano.intersectmbo.org name-suffix heuristic cannot derive the URL. Add https://input-output-hk.github.io/fs-sim to IOG_DOC_BASES. The site serves doc-index.html and module pages for both fs-api and fs-sim, so cross-package links resolve instead of failing the build. Fixes #1279
palas
force-pushed
the
fix-haddock-links
branch
from
August 8, 2026 00:03
37e662f to
b784228
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
Since #1221, the CI action that generates haddocks for
cardano-apinoticed there are broken links that couldn't be solved using the heuristics available so far. That resulted on the automatically generated issue: #1279This PR addresses this issue by Adding https://input-output-hk.github.io/fs-sim to
IOG_DOC_BASES. The site serves doc-index.html and module pages for both fs-api and fs-sim, so cross-package links resolve instead of failing the build.How to trust this PR
The functional change is a single probe-configuration line — one new entry in IOG_DOC_BASES — plus the changelog fragment. It is strictly additive: the new base is the last candidate probed, so every package that resolved before this PR still resolves to exactly the same site; the only behavioural change is that fs-api (and fs-sim, hosted on the same site) now resolve instead of failing the run.
Checklist
.changes/