-
Notifications
You must be signed in to change notification settings - Fork 44
Create a GH action to prepare a new release #744
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
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
Closed
Contributor
|
Neat! 🎉 |
Contributor
|
QA checks out. I left one suggestion on formatting of the PR title and description, otherwise looks great! See #747 |
Closed
Co-authored-by: Drew Jaynes <[email protected]>
ajaynes-godaddy
approved these changes
Mar 6, 2025
Contributor
ajaynes-godaddy
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
QA checks out, see #747.
LGTM!
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.
Summary
This creates a new GitHub workflow "Prepare Release" which handles everything necessary to... prepare a new release! Specifically:
Details
The workflow is a manual trigger only. It can be run from any branch.
After making the necessary changes, the workflow will commit them and push to a new
release/x.x.xbranch and open a PR for you.Here's an example PR made by the workflow: #743 The main PR was created by the workflow, but after the fact I did add a few commits just to confirm tests pass.
Example usage
The intended usage is this:
masterbranch (could technically be any branch, butmasteris most common I imagine).5.16.0)release/5.16.0(or relevant version) branch.Limitation
There's one limitation: the newly created PR will not automatically have tests run against it. When a workflow creates a PR, GitHub does not trigger other workflows that use the "on PR" trigger. This is intentional to prevent against accidental infinite loops. See https://github.com/orgs/community/discussions/65321
There are a few workarounds but they're kind of gross (e.g. use a different GH token in workflows as one example). The simplest way around it is just to manually close and then re-open the PR. That will trigger tests to run lol.
QA
Optional:
feature/prep-release-script. Once this PR is merged you can use any branch, but for now the workflow code only exists in this one!5.15.5. Do not use5.16.0because I already have a branch/PR for that one.Before merge
After merge