chore(pkgdown): wire GH Actions deploy to gh-pages - #15
Merged
Conversation
* Add _pkgdown.yml with site URL (https://vincentguyader.github.io/shiny2docker/) and bootstrap 5 template. * Add .github/workflows/pkgdown.yaml: build on push to main / PR / release, deploy to gh-pages via JamesIves/github-pages-deploy-action. * Rbuildignore: exclude _pkgdown.yml, docs/, pkgdown/. * gitignore: exclude /docs/ (generated, deployed via Action, not committed). After first run on main, enable GitHub Pages in repo settings: Source = "Deploy from a branch", Branch = gh-pages, Folder = /.
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.
Summary
Sets up pkgdown site generation and automated deployment to GitHub Pages via GitHub Actions.
Changes
_pkgdown.yml(new): site URLhttps://vincentguyader.github.io/shiny2docker/, Bootstrap 5 template..github/workflows/pkgdown.yaml(new): standard r-lib/actions setup; runs on push tomain, on PRs (build only), on release, and on manual dispatch. Usespkgdown::build_site_github_pages()thenJamesIves/github-pages-deploy-action@v4.5.0to push to thegh-pagesbranch (deploy step skipped on PRs)..Rbuildignore: exclude_pkgdown.yml,docs/,pkgdown/from the package tarball..gitignore: exclude/docs/(site is deployed via Action, not committed to main).After merge
Enable GitHub Pages in repo Settings -> Pages:
The first push to main after merge triggers the workflow, creates the
gh-pagesbranch, and publishes the site.Local validation
pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)-> clean build, no URL warning, 12 pages +.nojekyll.Test plan
gh-pagesbranch._pkgdown.yml.