docs: make linkcheck more forgiving
Metadata
Current evaluation
Merged canonical/starbase#444 as 9cbbaf5, reducing CI link-check noise with targeted URL and anchor ignores while retaining link checking.
Resolution: closed resolved
Reason: PR #444 was approved and merged with all CI checks passing. Commit 9cbbaf5 adds targeted linkcheck exclusions for known unreliable sites and problematic anchors without disabling the checker.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `make lint && make test`?
---
We get a lot of linkcheck errors in CI. I don't want to disable it as it's very useful, so I want to see if we can make it more forgiving instead.
I've also proposed what I think is a better (more resilient) solution upstream, since that solution will handle it when sites give 500-series errors for a long time.: https://github.com/sphinx-doc/sphinx/issues/13898
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged canonical/starbase#444 as 9cbbaf5, reducing CI link-check noise with targeted URL and anchor ignores while retaining link checking. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/starbase#444 (9cbbaf5), making CI link checking less noisy with targeted ignore rules, anchor exceptions, and the Ubuntu base domain excluded. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged updates to make the CI linkcheck more forgiving. Added ignore rules for unstable domains, problematic anchors, and the Ubuntu base domain. Reviewer feedback refined patterns to avoid overly broad root ignores, reducing false positives. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged to make Sphinx linkcheck CI more forgiving. Added specific URL and anchor ignore patterns, excluding ubuntu.com while removing broad root ignores per feedback, reducing false positives without disabling the check. |
Update history
No update history recorded yet.
Related work
-
Related To:
sphinx#13898
(confidence 100%)
Upstream Sphinx issue proposed a more resilient long-term solution for persistent 500-series link-check failures.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #398 docs: add linkcheck to doc checks | starbase | merged | Merged in canonical/starbase#398 as d240af2, adding Sphinx linkcheck to documentation checks after the scope was narrowed to linkcheck only. | |
| #980 build(docs): add starbase linkcheck filters | rockcraft | merged | Merged PR #980 as commit 1e5304ea, adding Starbase linkcheck filters to the docs build; all CI checks passed. | |
| #410 docs: update code of conduct link | starbase | merged | Merged canonical/starbase#410, correcting the Code of Conduct link; all CI checks passed with two approvals. | |
| #1321 style(docs): make linkcheck quieter and faster | craft-parts | merged | Merged #1321 as commit 73d25ad5, enabling linkcheck retries while excluding irrelevant checks to reduce noise and runtime; all CI checks passed. | |
| #2715 docs: linkchecker stopgap fix | charmcraft | merged | Merged #2715 in commit 57fa88a3, adding temporary link-check exclusions for intermittent snapcraft.io and juju.is failures pending restored availability. | |
| #630 docs: add docs-linkcheck to the commands to test | starbase | closed | Test PR verifying starflow's docs-only path filter; not intended to merge. Closed after testing purpose was served. |