Build rc-0.5.0 docs from a single monorepo checkout - #25
Merged
Conversation
The RC version pinned its R and Python builds to the generated r-rc-0.5.0 / py-rc-0.5.0 deploy branches, which exist solely to ship installable packages. Because r-rc-0.5.0 carries no _pkgdown.yml, the RC R docs fell back to pkgdown's auto-generated reference index, and cpp_ref pointed at main, so the RC sub-site published main's Doxygen output. Point every ref at the monorepo rc-0.5.0 branch and bootstrap the CRAN package the same way `latest` does. This picks up the branch's own _pkgdown.yml, builds the RC C++ docs from RC sources, and sources the changelog from the monorepo NEWS.md rather than the packaged branch's copy. No change to the code that gets installed: py-rc-0.5.0 is deployed from rc-0.5.0 HEAD exactly, and r-rc-0.5.0 trailed it only by Python-only commits. Verified against rc-0.5.0: cran-bootstrap.R 0 1 0 then pkgdown::check_pkgdown() reports no problems, and build_site_github_pages(install = TRUE) exits 0 with all nine previously unindexed topics present in the reference index. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
What
Points every
rc-0.5.0ref inversions.jsonat the monoreporc-0.5.0branch and bootstraps the CRAN package the same waylatestdoes.Why
The RC version pinned its R and Python builds to the generated
r-rc-0.5.0/py-rc-0.5.0deploy branches, which exist solely to ship installable packages. That caused three problems:r-rc-0.5.0carries no_pkgdown.yml, so the RC R docs fell back to pkgdown's auto-generated reference index.cpp_refpointed atmain, so the RC sub-site published main's Doxygen output.NEWS.mdrather than the monorepo copy, so RC release notes could lag.Consolidating onto the monorepo branch fixes all three, and drops two moving parts from the matrix.
No change to installed code
py-rc-0.5.0is deployed fromrc-0.5.0HEAD exactly, andr-rc-0.5.0trailed it only by Python-only commits — so the R and Python packages built here are the same code that was being built before.Verification
Run locally against a fresh
rc-0.5.0checkout:Rscript cran-bootstrap.R 0 1 0— clean, emitsstochtree_cran/with_pkgdown.ymlandNEWS.mdpkgdown::check_pkgdown()— No problems foundpkgdown::build_site_github_pages(install = TRUE)— exit 0, no errors in the logcontinueSampling,extractForest,extractRandomEffectSamples, each plus.bartmodel/.bcfmodel) have reference pages and index entriespip install .stepDoxyfileonrc-0.5.0carries the exactOUTPUT_DIRECTORY/GENERATE_XML/GENERATE_HTMLlines the workflow'ssedrewritesDepends on StochasticTree/stochtree@b420d079, which fixes the
_pkgdown.ymlreference index and points the pkgdownurlat the sub-site. Already pushed torc-0.5.0.Note on testing
This workflow has no
pushtrigger, so this PR buildslatestonly and does not exercise the RC path. After merge, run it viaworkflow_dispatchto test the consolidated RC build — the first real RC run will be a deploy.Also updates two workflow comments that this change makes inaccurate.
🤖 Generated with Claude Code