ci: publish a pkgdown site for fireSense_SpreadPredict - #14
Merged
Merged
Conversation
Thin caller for the shared pkgdown-module reusable workflow, which renders fireSense_SpreadPredict.Rmd as a pkgdown article via SpaDES.core::moduleRmdToVignette(). Builds on pull requests to development and deploys to gh-pages on push. Same caller already running on fireSense_SpreadFit (#21). See PredictiveEcology/SpaDES-modules#40.
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
1 participant
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.
Adds a thin caller so this module publishes a pkgdown site, extending the pilot
done for
fireSense_SpreadFit(PredictiveEcology/SpaDES-modules#40).The work happens in the shared reusable workflow
pkgdown-module.yaml,which runs
SpaDES.core::convertToPackage(), turns<module>.Rmdinto a vignettewith
SpaDES.core::moduleRmdToVignette(), then builds and deploys the site.Nothing module-specific lives here beyond the module name, so pins and setup move
once, in
actions.What it does
pushtodevelopment-> build and deploy togh-pages.pull_requesttodevelopment-> build only, no deploy.workflow_dispatchfor manual runs.permissions: contents: writeis granted in the caller because a called workflowcan only narrow the caller's scopes, never widen them; the deploy job needs it to
push to
gh-pages.Precedent
The same caller has been running on
fireSense_SpreadFitsince #21, publishinghttps://predictiveecology.github.io/fireSense_SpreadFit/ — article with metadata
tables and resolved cross-references, a reference index for the roxygen-documented
R/functions, and a news page.After merging
GitHub Pages must be enabled once, manually, and it must point at
gh-pages,root — not
development. Thegh-pagesbranch does not exist until this mergesand the push run completes, so Pages cannot be enabled beforehand. Note that
changing an existing Pages source does not itself trigger a rebuild; if the site
404s after repointing, request a build (
POST /repos/{owner}/{repo}/pages/builds).The PR checks here build the site without deploying, so a green check confirms the
module renders before anything is published.