Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updates the section on how to cut a new release using lessons from today.
  • Loading branch information
corrieleech committed May 23, 2024
1 parent 2ba3d55 commit bad3173
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -781,11 +781,18 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
`rake spec` to run the tests. You can also run `bin/console` for an interactive
prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To
release a new version, update the version number in `version.rb`, and then run
`bundle exec rake release`, which will create a git tag for the version, push
git commits and tags, and push the `.gem` file to
[rubygems.org](https://rubygems.org).
To install this gem onto your local machine, run `bundle exec rake install`.

To release a new version:
- Update the CHANGELOG file with auto-generated release notes from Github (create
the next tag in Github releases)
- Update the version number in `version.rb`
- Commit these changes and push up a branch. Get it approved.
- From the updated `main` branch, run `bundle exec rake release`, which will
create a git tag for the version, push git commits and tags, and push
the `.gem` file to [rubygems.org](https://rubygems.org).
- Create a Github release using the tag you created in the first step, and mark
it as the latest.

## Contributing

Expand Down

0 comments on commit bad3173

Please sign in to comment.