ci: migrate docs deployment to GitHub Actions Pages#21
Merged
Conversation
Replace mkdocs gh-deploy (push-to-branch) with the official actions/upload-pages-artifact + actions/deploy-pages workflow. Changes: - Drop contents:write permission (no longer pushing to gh-pages branch) - Add pages:write and id-token:write for OIDC-based deployment - Split into build/deploy jobs for clearer separation of concerns - Add concurrency guard to prevent overlapping deployments - Add --strict flag to mkdocs build to catch doc warnings as errors After merging, change GitHub Pages source to 'GitHub Actions' in: Settings > Pages > Build and deployment > Source
Contributor
There was a problem hiding this comment.
Pull request overview
Migrates the documentation deployment workflow from mkdocs gh-deploy (branch push) to GitHub Pages’ official artifact-based deployment, aligning docs publishing with the modern GitHub Actions Pages model.
Changes:
- Replace
mkdocs gh-deploywithactions/upload-pages-artifact+actions/deploy-pages. - Split workflow into separate
buildanddeployjobs with a Pages concurrency guard. - Build docs with
mkdocs build --strictto fail on warnings.
Comment on lines
+8
to
+11
| permissions: | ||
| contents: write | ||
| contents: read | ||
| pages: write | ||
| id-token: write |
- cli_guide: remove 'modern, user-friendly', 'beautiful terminal output', 'intuitive command structure' - control_modes guide: 'comprehensive information' -> 'covers' - protocol/control_modes: 'comprehensive overview' -> 'covers' - protocol/schedules: 'includes comprehensive validation' -> 'validates' - protocol/architecture: 'unlock the pump's capabilities' -> factual description - TESTING_STRATEGY: 'comprehensive testing strategy, designed to ensure' -> direct - reference/data_models: 'with comprehensive validation' -> factual note - api/constants: 'comprehensive lookup table' -> 'lookup table'
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.
Replace mkdocs gh-deploy (push-to-branch) with the official actions/upload-pages-artifact + actions/deploy-pages workflow.
Changes:
After merging, change GitHub Pages source to 'GitHub Actions' in: Settings > Pages > Build and deployment > Source