Skip to content

Document new release workflow #830

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.

Sign up for GitHub

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
egiurleo merged 1 commit into from
Dec 17, 2025
Merged

Document new release workflow #830

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,24 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run

To install this gem onto your local machine, run `bundle exec rake install`.

## 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`
Copy link
Contributor

@Morriar Morriar Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`

- [ ] Push this change directly to main or open a PR
Copy link
Contributor

@Morriar Morriar Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [ ] Push this change directly to main or open a PR
- [ ] Push these changes 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`
Comment on lines +380 to +392
Copy link
Contributor

@Morriar Morriar Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`


### Release workflow will run automatically

We have a [release workflow](https://github.com/Shopify/spoom/actions/workflows/release.yml) that will publish your new gem version to rubygems.org via [Trusted Publishing](https://guides.rubygems.org/trusted-publishing/). This workflow must be approved by a member of the Ruby and Rails Infrastructure team at Shopify before it will run. Once it is approved, it will automatically publish a new gem version to rubygems.org and create a new GitHub release.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/spoom. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
Expand Down