ci: add workflow to deploy pkgdown site #46
Merged
Conversation
This file contains 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
news.md should be NEWS.md, but instead update it to a link that will also work for when the README is rendered as part of the pkgdown site. Fixes #36
pkgdown requires listing the pkgdown site in the DESCRIPTION's URL in order to be able to link to this package from another pkgdown site: https://pkgdown.r-lib.org/articles/linking.html#across-packages While at it, also add the typical repo URLs.
This follows pmplots in using the default theme.
This will help catch pkgdown issues when they are introduced rather than when the site is built on release.
kylebaron
approved these changes
Dec 20, 2024
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.
This PR wires up GitHub Actions to publish the pkgdown site via gh-pages on push of a release tag. (The deploy can also be triggered manually or by push of a specific branch,
scratch/deploy-site.)In addition to adding the workflow, this PR makes several related changes:
add pkgdown configuration
untrack and ignore the
docs/directoryregister pkgdown site URL for pkgdown linking
fix a link in the README
run
check_pkgdownas part of the main CI checkThe workflow has already been triggered to render https://metrumresearchgroup.github.io/mrggsave/:
last build: https://github.com/metrumresearchgroup/mrggsave/actions/runs/12418731065
Note that the scratch branch has a temporary commit on top to undo the dev version bump in aa22ad5 (update development version, 2023-08-14).