Skip to content

docs: release-notes-from-GitHub-Releases (#135) and stable-link follow-up (#131); #133 needs no code change here - #153

Merged
seabbs merged 2 commits into
mainfrom
fix/docs-build-133
Aug 12, 2026
Merged

seabbs merged 2 commits into
mainfrom
fix/docs-build-133

Conversation

@seabbs-bot

Copy link
Copy Markdown
Collaborator

#133 — docs build MethodError: no code change in this repo, root cause is upstream

#133 is NOT fixed by a commit in this PR — I could not find anything to
fix here, because there is nothing broken on current main. Details:

#135 — point release notes at GitHub Releases

  • Rewrote docs/release_notes_header.jl to introduce the fetched-at-build
    GitHub releases instead of describing NEWS.md, matching
    EpiAwarePackageTools#368's convention.
  • docs/pages.jl already had the "Release notes" nav entry from an earlier
    kit sync — no change needed.
  • Updated docs/src/developer/release-process.md's "Release notes" section
    and pre-release checklist to stop telling contributors to write NEWS.md
    entries.
  • Kept NEWS.md rather than deleting it (this repo caps
    EpiAwarePackageTools at compat "0.2" in both docs/Project.toml and
    test/Project.toml, which share one Manifest via the Julia workspace
    feature; Dependabot's grouped Julia PR is what bumps all of them together,
    not a per-file hand-edit). Until that lands, the currently-resolved 0.2.0
    kit still literally concatenates this header with NEWS.md; deleting it
    now would make the release-notes page render nothing in the interim. The
    new header is inert either way and starts working the moment the compat
    bump merges.

#131 — stable-link follow-ups

  • Switched the ConvolvedDistributions related-package link to /stable/
    (confirmed 200 today). Left ComposedDistributions at /dev/ (confirmed
    still 404).
  • Left this package's own /dev → /stable switch and the /stable
    linkcheck-ignore drop out of scope: v0.1.0 is registered in General,
    but no git tag/GitHub release exists yet, so
    https://modifieddistributions.epiaware.org/stable/ still 404s. Filed
    #150
    — TagBot's only post-registration run fired before the registry PR
    merged and logged "This package is not registered, skipping"; nothing has
    re-dispatched it since.
  • Item 3 (Discussions linkcheck ignore) was already handled by docs: point the FAQ at Discourse and the forum, not GitHub Discussions #134 before
    I started; nothing to do.

Overlap with PR #140

None. #140 touches docs/docs_config.jl's LINKCHECK_IGNORE (the
community.epinowcast.org 429 flake); this PR doesn't touch that file. I
did confirm from the CI logs that the actual failing main Documenter run
(2026-08-05) failed on exactly that flaky linkcheck, not on anything related
to #133 — so #140 is the real fix for that failure, and this PR is unrelated
to it.

Verification

task docs-fast builds clean on this branch (confirmed twice, most recently
after all commits above).

This was opened by a bot. Please ping @seabbs for any questions.

EpiAwarePackageTools#368 (kit v0.3.0) moves the release-notes docs page
off a hand-maintained NEWS.md and onto the repo's published GitHub
releases, fetched at build time. Rewrite the package-owned
release_notes_header.jl to introduce those releases rather than
describe a changelog file, and update the developer release-process
docs to match. `docs/pages.jl` already carries the "Release notes" nav
entry, so no change needed there.

Keep NEWS.md rather than delete it: the docs env's EpiAwarePackageTools
compat is still capped at 0.2 here (the workspace shares one Manifest
across docs/, test/ and the root package, and test/Project.toml also
caps it at 0.2 -- Dependabot's grouped Julia PR is what bumps all three
together, not a hand-edit to one). Until that bump lands, the currently
resolved 0.2.0 build_release_notes still literally prepends this header
to NEWS.md; deleting NEWS.md now would make it skip generating
release-notes.md entirely in the interim. The new header is inert
either way, and starts working as soon as the compat bump merges.
#131 left this at /dev/ because both sibling /stable docs 404'd when it
was filed. ConvolvedDistributions' stable docs have since deployed
(confirmed 200); ComposedDistributions' have not (confirmed still
404), so that one stays at /dev/ for now.

This package's own /dev -> /stable switch and the /stable linkcheck
ignore (#131 items 1-2) stay out of scope: v0.1.0 is registered in
General, but no git tag/GitHub release exists yet (see #150), so
https://modifieddistributions.epiaware.org/stable/ still 404s.
@github-actions

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-build-133")
using ModifiedDistributions

Option 2: Local Checkout

If you have the repo locally:

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

@github-actions

Copy link
Copy Markdown
Contributor

📖 Documentation preview is ready!

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

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

@codecov

codecov Bot commented Aug 10, 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.

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