ci: add pkgdown site workflow#20
Merged
Merged
Conversation
Build pkgdown site on push to master and pull requests. Deploys to gh-pages branch via GitHub Actions.
The existing docs/ contained a manually-built site that blocked pkgdown::build_site_github_pages(). Removed it so pkgdown can build from scratch and deploy to gh-pages branch.
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.
This PR adds a pkgdown workflow so the package website can be built from the source documentation and vignettes. This is part of #11 and prepares the site to show the newly added vignettes.
What this adds
.github/workflows/pkgdown.yaml— builds and deploys the pkgdown siteBehavior
gh-pagesbranchDeployment note
The repository currently has a
docs/directory onmasterwith a previously generated site. After this PR merges, the site will be served from thegh-pagesbranch instead. The existingdocs/directory can be removed in a follow-up PR oncegh-pagesis confirmed working.Verification
r-lib/actions/setup-r@v2,r-lib/actions/setup-r-dependencies@v2, andpkgdown::build_site_github_pages()