RELEASING.md

Releasing

1. Update version file accordingly

Include an RC (release candidate) number if appropriate, e.g. 2.0.0.rc.

2. Update CHANGELOG.md to reflect the changes since last release

You can copy GitHub automatically generated release notes for this step.

3. Commit changes

There shouldn't be code changes, and thus CI doesn't need to run. Add "[ci skip]" to the commit message.

4. Tag the release: git tag -s vVERSION

We recommend the quick guide on how to sign a release from git ready.

5. Push changes

Push the changes with git push --tags

6. Build and publish

gem build project-name.gemspec
gem push project-name-*.gem

If the project is hosted on RubyGems, consider using RubyGems Trusted Publication to automatically push the release using a GitHub action.

7. Add a new GitHub release using the recent CHANGELOG.md as the content

Sample URL: https://github.com/thoughtbot/project-name/releases/new?tag=vVERSION

8. Announce the new release

Make sure to say "thank you" to the contributors who helped shape this version!