Repository navigation
CI: Create a release PR from the release workflow - #128
Open
pniedzielski wants to merge 1 commit into
Open
pniedzielski wants to merge 1 commit into
pniedzielski wants to merge 1 commit into
Conversation
This patch makes the Prepare Release workflow generate a pull request after bumping the version. Right now, there is no automation to publish a release to GitHub and PyPI when a PR is approved and merged. We use the `peter-evans/create-pull-request` GitHub Action to make this easier. While this introduces an external dependency, it handles idempotency in case this workflow is run multiple times for the same release version, and also gives us a more declarative syntax for generating PRs. When this PR is created, it will be authored by `github-actions[bot]` and include only the version bump and the towncrier changes. Unfortunately, PRs generated by GitHub Actions get their own workflows queued in an “approval-required” state, which means someone will have to click a button on the PR to run the CI. This is to avoid infinite chains of CI workflows being run automatically with no human involved. We can provide a separate token, which we can generate independently and store as a secret, which is not subject to this restriction if we find it annoying. See [the GitHub docs on this](https://docs.github.com/en/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow#triggering-a-workflow-from-a-workflow) for more details.
pniedzielski
added
skip news
This branch has not been deployed
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.
This patch makes the Prepare Release workflow generate a pull request after bumping the version. Right now, there is no automation to publish a release to GitHub and PyPI when a PR is approved and merged.
We use the
peter-evans/create-pull-requestGitHub Action to make this easier. While this introduces an external dependency, it handles idempotency in case this workflow is run multiple times for the same release version, and also gives us a more declarative syntax for generating PRs.When this PR is created, it will be authored by
github-actions[bot]and include only the version bump and the towncrier changes. Unfortunately, PRs generated by GitHub Actions get their own workflows queued in an “approval-required” state, which means someone will have to click a button on the PR to run the CI. This is to avoid infinite chains of CI workflows being run automatically with no human involved. We can provide a separate token, which we can generate independently and store as a secret, which is not subject to this restriction if we find it annoying. See the GitHub docs on this for more details.