ci: merge generated docs PRs from the docs workflow - #1806
Merged
Merged
Conversation
The docs PR targets gh-pages and only carried an automerge label that nothing acted on, so every docs PR was merged by hand. Merge it right after creating it instead.
Contributor
Code Coverage
|
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
3 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.
Problem
The
Update documentationworkflow opens adocs: Update docsPR againstgh-pagesand labels itautomerge, but nothing acts on that label. Every docs PR so far has been merged by hand, sometimes days after the release.Fix
Give the
create-pull-requeststep anidand add a step that merges the PR it created withgh pr merge --squash --delete-branch, using the same bot token.pull_requestworkflow, which would have to live ongh-pagesto run for these PRs.gh-pageshas no branch protection or rulesets, so no approval is needed.create-pull-requestreturns a PR number, so a release with no docs changes is a no-op.Trade-off: generated docs go live without a human looking at them, which is effectively what happens today when the PR is merged without review.
Testing
The workflow YAML parses. The merge step only runs on a release or a manual dispatch, so it will first be exercised on the next release.