Skip to content

docs: stop the flaky linkcheck 429 failing the docs build - #140

Merged
seabbs merged 1 commit into
mainfrom
fix/docs-linkcheck-epinowcast
Aug 12, 2026
Merged

seabbs merged 1 commit into
mainfrom
fix/docs-linkcheck-epinowcast

Conversation

@seabbs-bot

Copy link
Copy Markdown
Collaborator

Problem

The Documenter linkcheck step intermittently fails the docs build on main (and every open PR) with:

[error] linkcheck 'https://community.epinowcast.org' status: 429.
ERROR: `makedocs` encountered an error [:linkcheck] -- terminating build before rendering.

The epinowcast Discourse forum rate-limits CI requests, returning HTTP 429. build_docs (via EpiAwarePackageTools) passes warnonly = [:docs_block, :missing_docs, :autodocs_block, :cross_references] — not :linkcheck — so the 429 is fatal and the build aborts before rendering. It's intermittent: the Aug 3 build (run 30834932552) passed on the same code.

Fix

Add community.epinowcast.org to LINKCHECK_IGNORE in docs/docs_config.jl, matching the existing entries for other external sites that intermittently time out / rate-limit under CI linkcheck (code.visualstudio.com, github.com/go-task/task/releases). The linked forum pages are stable; only the throttled check flakes.

Notes (non-blocking — pre-existing warnings, not build failures)

While investigating, the docs build also emits these @ref/@example warnings that are not fatal:

  • docs/src/lib/public.md cannot resolve @ref for ModifiedDistributions.update/prune/splice (referenced from the effective_intensity docstring at src/Transformed.jl:291-292 but not in the @docs blocks).
  • A few unresolved @ref for external built-in symbols (Distributions.gradlogpdf, Base.missing, etc.) in docs/src/lib/internals.md.
  • An un-expanded @example block on docs/src/lib/public.md.

These don't break the build and are out of scope here.

The Documenter linkcheck step occasionally fails on main (and any PR) with
'linkcheck https://community.epinowcast.org status: 429' — the epinowcast
Discourse forum rate-limits CI requests under the full build. 429 is not in
the warnonly list, so linkcheck errors are fatal and the build terminates
before rendering.

This adds the forum to LINKCHECK_IGNORE, matching the existing pattern for
external sites that intermittently time out / rate-limit under CI linkcheck.
The link itself is stable; only the throttled check flakes.
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Try this Pull Request!

Option 1: Julia Package Manager

Open Julia and type:

import Pkg
Pkg.activate(temp=true)
Pkg.add(url="https://github.com/EpiAware/ModifiedDistributions.jl", rev="fix/docs-linkcheck-epinowcast")
using ModifiedDistributions

Option 2: Local Checkout

If you have the repo locally:

git checkout fix/docs-linkcheck-epinowcast
julia --project=. -e "using Pkg; Pkg.instantiate()"

@codecov

codecov Bot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
unit 97.42% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

📖 Documentation preview is ready!

View the docs for this PR at: https://EpiAware.github.io/ModifiedDistributions.jl/previews/PR140/

This preview will be updated automatically when you push new commits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants