docs: migrate to artifact-based GitHub Pages deployment#42
Merged
Conversation
Replace legacy `mkdocs gh-deploy --force` (branch push) with the GitHub-recommended upload-pages-artifact + deploy-pages pattern. Also adds pinned docs dependencies, workflow_dispatch trigger, dark mode, and richer markdown extensions. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace pip + requirements.txt with uv + pyproject.toml dependency group and lockfile. Move CNAME back to docs/ root since mkdocs copies it to site/ automatically without needing a custom_dir overlay. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Reflect artifact-based Pages deploy, uv dependency management, CODEOWNERS, tag creation rule, SHA pinning enforcement, and disabled workflow PR approvals. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The workflow-level permissions remain as the ceiling (union of all jobs), but each job now narrows to only what it needs: integration gets id-token+contents:read, nat-images gets id-token+contents:write+ pull-requests:write, and clear-trigger-label gets only issues:write. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The repo-level SHA pinning enforcement rejects transitive tag references inside composite actions (pre-commit/action uses actions/cache@v4 internally), breaking precommit CI. Pinning remains enforced by convention in our own workflow files. Co-Authored-By: Claude Opus 4.6 (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.
Summary
mkdocs gh-deploy --force(pushes built HTML togh-pagesbranch) with GitHub's recommendedupload-pages-artifact+deploy-pagespattern (artifact-based deployment with environment tracking)docs/requirements.txtwith pinned version floors (mkdocs>=1.6,mkdocs-material>=9.5) — previously installed unpinned via barepip installworkflow_dispatchtrigger and self-watching (.github/workflows/docs.ymlpath) so docs can be manually re-deployed and workflow changes auto-trigger a rebuilddocs/CNAMEtodocs/overrides/CNAMEso the custom domain file is included inmkdocs buildoutput (required for artifact-based deploy)site/to.gitignore.github/CODEOWNERSassigning@leonardosuland@monk-eeas code owners for all filesMigration note
After merging, the repo's GitHub Pages settings need to be updated:
gh-pagesbranch can be deleted once the first artifact-based deploy succeedsTest plan
mkdocs buildsucceeds locallynat-zero.machine.dev) present insite/output🤖 Generated with Claude Code