Document new release workflow#830
Merged
Merged
Conversation
vinistock
approved these changes
Dec 17, 2025
egiurleo
force-pushed
the
document-release-workflow
branch
from
eb95afd to
5361399
Compare
Morriar
reviewed
Dec 18, 2025
|
|
||
| - [ ] Locally, update the version number in [`version.rb`](https://github.com/Shopify/spoom/blob/main/lib/spoom/version.rb) | ||
| - [ ] Run `bundle install` to update the version number in `Gemfile.lock` | ||
| - [ ] Commit this change with the message `Bump version to vx.y.z` |
Contributor
There was a problem hiding this comment.
For me it sounds like we should commit only the Gemfile.lock change?
Suggested change
| - [ ] Commit this change with the message `Bump version to vx.y.z` | |
| - [ ] Commit these changes with the message `Bump version to vX.Y.Z` |
| - [ ] Locally, update the version number in [`version.rb`](https://github.com/Shopify/spoom/blob/main/lib/spoom/version.rb) | ||
| - [ ] Run `bundle install` to update the version number in `Gemfile.lock` | ||
| - [ ] Commit this change with the message `Bump version to vx.y.z` | ||
| - [ ] Push this change directly to main or open a PR |
Contributor
There was a problem hiding this comment.
Suggested change
| - [ ] Push this change directly to main or open a PR | |
| - [ ] Push these changes directly to main or open a PR |
Comment on lines
+380
to
+392
| ## Releasing | ||
|
|
||
| ### Bump the gem version | ||
|
|
||
| - [ ] Locally, update the version number in [`version.rb`](https://github.com/Shopify/spoom/blob/main/lib/spoom/version.rb) | ||
| - [ ] Run `bundle install` to update the version number in `Gemfile.lock` | ||
| - [ ] Commit this change with the message `Bump version to vx.y.z` | ||
| - [ ] Push this change directly to main or open a PR | ||
|
|
||
| ### Create a new tag | ||
|
|
||
| - [ ] Locally, create a new tag with the new version number: `git tag vx.y.z` | ||
| - [ ] Push this tag up to the remote `git push origin vx.y.z` |
Contributor
There was a problem hiding this comment.
I think we can merge both sections and push in one command.
Maybe also use a numbered list for the steps?
Suggested change
| ## Releasing | |
| ### Bump the gem version | |
| - [ ] Locally, update the version number in [`version.rb`](https://github.com/Shopify/spoom/blob/main/lib/spoom/version.rb) | |
| - [ ] Run `bundle install` to update the version number in `Gemfile.lock` | |
| - [ ] Commit this change with the message `Bump version to vx.y.z` | |
| - [ ] Push this change directly to main or open a PR | |
| ### Create a new tag | |
| - [ ] Locally, create a new tag with the new version number: `git tag vx.y.z` | |
| - [ ] Push this tag up to the remote `git push origin vx.y.z` | |
| ## Releasing | |
| 1. Locally, update the version number in [`version.rb`](https://github.com/Shopify/spoom/blob/main/lib/spoom/version.rb) | |
| 2. Run `bundle install` to update the version number in `Gemfile.lock` | |
| 3. Commit these changes with the message `Bump version to vX.Y.Z` | |
| 4. Create a new tag with the new version number: `git tag vX.Y.Z` | |
| 5. Push to the remote `git push origin main vX.Y.Z` |
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.
No description provided.