Use actions/deploy-pages to deploy docs in template
#578
Conversation
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
This reverts commit c897075.
samcunliffe
reviewed
Jul 23, 2025
|
Note to us: we should publish a new version once this is merged... it's a user-facing improvement.
|
samcunliffe
approved these changes
Jul 23, 2025
matt-graham
commented
Jul 23, 2025
|
According to the CONTRIBUTING rules, I am merging because I don't have any comments. (Saransh is on holiday and I don't think this is controversial). |
This was referenced Sep 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Resolves #561
Resolve #574
Switches from the current branch based workflow for deploying MkDocs documentation to GitHub Pages in template to instead use
actions/deploy-pagesand removes suggestion in post-generation message displayed to user to set repository wide write permissions for Github Actions workflows in favour of using granular permissions in workflow file.I originally completely removed the post-generation message as I thought by using the
actions/deploy-pagesapproach we might be able to avoid having to do additional configuration of repository before site will deploy, but unfortunately it seems the default source setting for GitHub Pages on a new repository is branch so unless this is switched to GitHub Actions before doing the initial workflow run, the deploy job fails. I couldn't see any options for configuring this via CLI undergh repo edit.Tested this works at https://github.com/matt-graham/docs-deploy-test and everything seems to work as expected provided manual configuration steps are done as indicated in updated message.