Skip to content

Latest commit

 

History

History
19 lines (17 loc) · 911 Bytes

RELEASE.md

File metadata and controls

19 lines (17 loc) · 911 Bytes
Raw

Releasing

Once the changes have been merged to main it's time to release a new version of the gem.

  1. Creating a PR with a semantic version bump to version and all the changes being released added to the CHANGELOG.
  2. After the PR has been merged, create a release on GitHub for the new version:
    • The tag should be in the format of: vX.Y.Z
      • You can think of X.Y.Z as such: X = breaking Y = feature Z = bugfix
    • The title should be in the format of: vX.Y.Z (same as tag)
    • The description should include all the changes being released in the format of:
      • #[PR #] - @[contributor] - [description]
  3. When the tag is created, a GitHub Actions workflow will publish the release to rubygems.