Migrate Pages deploy from gh-pages branch to actions/deploy-pages#10
Merged
Conversation
GitHub Pages was switched to the workflow-based source (build_type=workflow) but the docs.yml job kept calling `mkdocs gh-deploy --force --clean`, which only writes to the gh-pages branch that the new Pages source no longer reads. Result: every Docs run was green while the live site stayed on the old Jekyll render of master. Rewrite the deploy job to use the proper Pages deployment actions: - build: still runs mkdocs build --strict on push and PR. On master push, also uploads the rendered site/ as a Pages artifact via actions/upload-pages-artifact@v5. - deploy: replaces the `mkdocs gh-deploy` step with actions/deploy-pages@v5. Adds the required `pages: write` + `id-token: write` permissions and the `environment: github-pages` declaration GitHub requires for OIDC-signed Pages deployments. - concurrency: group:pages, cancel-in-progress:false prevents racing deployments without aborting one already in flight. The gh-pages branch is no longer touched and can be deleted after the first successful workflow-based deploy.
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.
GitHub Pages was switched to the workflow-based source (build_type=workflow) but the docs.yml job kept calling
mkdocs gh-deploy --force --clean, which only writes to the gh-pages branch that the new Pages source no longer reads. Result: every Docs run was green while the live site stayed on the old Jekyll render of master.Rewrite the deploy job to use the proper Pages deployment actions:
mkdocs gh-deploystep with actions/deploy-pages@v5. Adds the requiredpages: write+id-token: writepermissions and theenvironment: github-pagesdeclaration GitHub requires for OIDC-signed Pages deployments.The gh-pages branch is no longer touched and can be deleted after the first successful workflow-based deploy.