-
Notifications
You must be signed in to change notification settings - Fork 4.5k
chore: tweak release docs #6571
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
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e483d99
tweak release docs
michaelneale 5039748
Update RELEASE.md
michaelneale 7cf8de7
Apply suggestions from code review
michaelneale 0fe5669
Apply suggestions from code review
michaelneale bb7048e
Merge branch 'main' into micn/release-doc-tweak
michaelneale 79ad93f
Merge branch 'micn/release-doc-tweak' of github.com:block/goose into …
michaelneale File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,29 @@ | ||
| # Making a Release | ||
|
|
||
| You'll generally create one of two release types: a regular feature release (minor version bump) or a bug-fixing patch release (patch version bump). Regular releases start on main, while patch releases start with an existing release tag. goose uses GitHub actions to automate the creation of release branches. The actual releases are triggered by tags. | ||
| You'll generally create one of two release types: a regular feature release (minor version bump like 1.20) or a bug-fixing patch release (patch version bump like 1.20.1). | ||
|
|
||
| Regular releases start on main, while patch releases start with an existing release tag. goose uses GitHub actions to automate the creation of release branches. The actual releases are triggered by tags. | ||
| With bug fixing releases you will be cherry picking fixes to that branch, testing, and then releasing from that. | ||
|
|
||
| ## Minor version releases | ||
|
|
||
| These are typically done once per week. There is an [action](https://github.com/block/goose/actions/workflows/minor-release.yaml) that cuts the branch every Tuesday, but it can also be triggered manually. Commits from main can be cherry-picked into this branch. | ||
| These are typically done once per week. There is an [action](https://github.com/block/goose/actions/workflows/minor-release.yaml) that cuts the branch every Tuesday, but it can also be triggered manually. Commits from main can be cherry-picked into this branch as needed before release. | ||
|
|
||
| To trigger the release, find [the corresponding PR](https://github.com/block/goose/pulls?q=is%3Apr+%22chore%28release%29%22+%22%28minor%29%22+author%3Aapp%2Fgithub-actions+) and follow the instructions in the PR description. | ||
|
|
||
| ## Patch version releases | ||
|
|
||
| Minor and patch releases both trigger the creation of a branch for a follow-on patch release. These branches can be used to create patch releases, or can be safely ignored/closed. | ||
| You can cherry pick fixes into this branch. | ||
|
|
||
| To trigger the release, find [the corresponding PR](https://github.com/block/goose/pulls?q=is%3Apr+%22chore%28release%29%22+%22%28patch%29%22+author%3Aapp%2Fgithub-actions+) and follow the instructions in the PR description. | ||
|
|
||
|
|
||
| ## High level release flow: | ||
|
|
||
| * check out and cherry pick (if needed) changes to the branch you are going to release (eg the patch branch) | ||
|
michaelneale marked this conversation as resolved.
Outdated
michaelneale marked this conversation as resolved.
Outdated
|
||
| * Test locally if you can (just run-ui) | ||
| * Push changes to that branch, wait for build | ||
| * Download and test the .zip from the release PR | ||
| * If happy, follow the instructions on the release PR to tag and release (tagging will trigger the real release from there) | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.