Repository navigation
ci: publish documentation through GitHub Pages Actions - #14
Open
beardedeagle wants to merge 2 commits into
Open
beardedeagle wants to merge 2 commits into
beardedeagle wants to merge 2 commits into
Conversation
|
Note The title starts with
|
There was a problem hiding this comment.
🔵 Needs a closer look
The cutover depends on out-of-repository Pages settings and main-only environment restrictions that require maintainer verification, along with the first hosted deployment.
No open issues 🎉
What changed in this PR
Moves documentation publishing from the existing gh-pages snapshot to GitHub Pages Actions. Pull requests build and upload the book without deploying; pushes and manual runs on main publish it.
Changes:
- Adds commit-pinned Pages configuration, artifact upload, and deployment actions.
- Restricts write/OIDC permissions to deployment and preserves active main-branch runs.
- Expands documentation triggers and updates contributor guidance and the changelog.
| File | Description |
|---|---|
| CHANGELOG.md | Records the documentation build and publishing workflow. |
| .github/workflows/docs.yml | Adds artifact upload, main-only deployment, and expanded triggers. |
| .github/CONTRIBUTING.md | Documents hosted builds and main-only publishing behavior. |
Review effort: Balanced
7 tasks done
This branch has not been deployed
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
The Docs job stops after building, leaving the published site on the old
gh-pagessnapshot. Upload the built book and deploy it through GitHub Pages for pushes and manual runs onmain. Pull requests build and upload an artifact without deploying.configure-pagesv6.0.0,upload-pages-artifactv5.0.0 anddeploy-pagesv5.0.1 to their full release commits.How was this verified?
actionlint .github/workflows/docs.ymlpasses.just docspasses with the existing mdbook-mermaid version warning.gh actions-lock --verifypass. The released upload action's nested SHA matches the officialupload-artifactv7.0.0 tag. The two unchanged local setup actions contain only run steps.2656667, including native Nix builds and all-system evaluation. The preceding macOS failures stop before Postmaster compilation/tests on unauthenticated GitHub API rate limits.Pages is configured for Actions publication, and the
github-pagesenvironment permits onlymain. The generatedgh-pagesbranch is removed; its history is preserved in a verified Git bundle. The first main deployment and served-artifact verification remain after merge. Rust runtime code and Cargo dependencies are unchanged.Checklist
just ci-rustpasses locally.just docssucceeds and documentation describes the resulting behavior.