Repository navigation
Make docs publishing a manual pipeline - #1
Merged
Merged
Conversation
The Pages deployment previously ran on every push to the default branch. Publishing is now driven only by a workflow_dispatch with a `deploy` input, so the live website changes only when asked for. Pushes to main and pull requests still build the docs, run docs/check.py on both sources and generated HTML, and treat Sphinx warnings as errors, but they no longer upload a Pages artifact or receive pages:write. Unticking `deploy` on a manual run rehearses a publish without touching the site. Adds a concurrency group so superseded build checks cancel themselves, and updates DOCUMENTATION.md and docs/publishing.md to describe the triggers. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The README pointed at three individual files under docs/ but never at the published site. Adds the URL near the top, where someone landing on the repository will see it before the install instructions. Co-Authored-By: Claude Opus 5 (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.
Publishing the documentation website is now a deliberate, manual action instead of a side effect of pushing to
main.What changes
.github/workflows/docs.ymlkeeps one build job and one deploy job, but re-wires the triggers:deploytickeddeployuntickedmaingithub.event_name == 'workflow_dispatch' && inputs.deploy, so pushes and PRs never upload a Pages artifact and never receivepages: write/id-token: write.docs-${{ github.ref }}concurrency group so superseded build checks cancel themselves. Thegithub-pagesdeploy group still hascancel-in-progress: false.pushtrigger is now scoped tomainrather than every branch.Because the branch is chosen at dispatch time, the site can be published from a non-
mainbranch when that is wanted.Docs updated to match
DOCUMENTATION.mdanddocs/publishing.mdsaid to publish by pushing to the default branch. Both now describe the manual Actions → Documentation → Run workflow path and the trigger table.Verification
Built locally against
docs/requirements.txtwith the same commands CI runs:docs/check.py— 19 markdown pages, 58 source targets, 0 errorssphinx -b html -W --keep-going -E -a— build succeeded, no warningsdocs/check.py --html— 47 HTML pages, 4521 internal links and assets, 0 errorsThis PR's own check run exercises the new
pull_requestpath; it should build and stop short of deploying.🤖 Generated with Claude Code