Skip to content

Commit eb95afd

Browse files
committed
Document new release workflow
1 parent 210e014 commit eb95afd

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -377,6 +377,21 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
377377

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

380+
## Releasing
381+
382+
### Bump the gem version
383+
- [ ] Locally, update the version number in [`version.rb`](https://github.com/Shopify/spoom/blob/main/lib/spoom/version.rb)
384+
- [ ] Run `bundle install` to update the version number in `Gemfile.lock`
385+
- [ ] Commit this change with the message `Bump version to vx.y.z`
386+
- [ ] Push this change directly to main or open a PR
387+
388+
### Create a new tag
389+
- [ ] Locally, create a new tag with the new version number: `git tag vx.y.z`
390+
- [ ] Push this tag up to the remote `git push origin vx.y.z`
391+
392+
### Release workflow will run automatically
393+
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.
394+
380395
## Contributing
381396

382397
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.

0 commit comments

Comments
 (0)