Fix docs deploy CI permissions and document build commands#164
Merged
Conversation
- Grant contents: write so mike can push to the gh-pages branch (fixes 403 on tag-triggered deploy) - Pin docs dependency versions in docs/requirements.txt - Add docs/README.md with local build and manual deploy commands
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.
Summary
The docs deploy workflow (
.github/workflows/docs.yml) builds the site successfully but fails whenmikepushes togh-pages:mike deploy --pushcommits the built site to thegh-pagesbranch, which needscontents: write. The workflow grantedcontents: read(pluspages/id-tokenwrite, whichmikedoesn't use since it pushes to a branch rather than the Pages artifact API).Changes
docs.yml: replacecontents: read+pages: write+id-token: writewithcontents: writeso the CI token can push togh-pages.docs/requirements.txt: pin docs dependency versions for reproducible/secure builds.docs/README.md: document local preview/build and manual deploy commands (viauvephemeral envs).