From bad3173b6d7da7ddbe87e232aad6cf396a2cc86a Mon Sep 17 00:00:00 2001 From: Corrie <87617609+corrieleech@users.noreply.github.com> Date: Thu, 23 May 2024 10:23:54 -0500 Subject: [PATCH] Update README.md Updates the section on how to cut a new release using lessons from today. --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b394b5d..d46375a 100644 --- a/README.md +++ b/README.md @@ -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