ci: build pkgdown site via Actions to gh-pages - #14
Merged
Conversation
Move the documentation site off the force-committed `docs/` folder on main and onto a CI-built `gh-pages` branch. - Add .github/workflows/pkgdown.yaml (r-lib/actions): builds the pkgdown site and deploys it to gh-pages. The deploy action is pinned to a commit SHA (v4.8.0) since it runs with contents: write. - DESCRIPTION: Config/Needs/website: tidyverse/tidytemplate so the website theme is installed in CI (it is not on CRAN). - Untrack docs/ (git rm --cached); it stays gitignored and is now produced by CI. - Cross-reference the Python port (dt2): README note + a "Python" navbar link to https://strategicprojects.github.io/dt2py/ . After merge: in repo Settings → Pages, switch the source from "main /docs" to the gh-pages branch (the workflow creates it on the first main build). Co-Authored-By: Claude Opus 4.8 (1M context) <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
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.
Migrates the documentation site off the force-committed `docs/` folder on `main` and onto a CI-built gh-pages branch.
Changes
.github/workflows/pkgdown.yaml(r-lib/actions): builds the pkgdown site on push/PR/release and deploys to `gh-pages`. The deploy action (JamesIves/github-pages-deploy-action) is pinned to a commit SHA (v4.8.0) because it runs with `contents: write`.docs/(`git rm --cached`, 872 files) — it stays gitignored and is now produced by CI, not committed.In Settings → Pages, switch the source from "main /docs" to the gh-pages branch (the workflow creates it on the first `main` build). Until then the live site keeps serving the old `docs/` from the last commit that had it.
Notes
🤖 Generated with Claude Code