Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 1.71 KB

RELEASING.md

File metadata and controls

69 lines (45 loc) · 1.71 KB

Releasing

This document describes the steps to release a new version of DNSimple/Ruby.

Prerequisites

  • You have commit access to the repository
  • You have push access to the repository
  • You have a GPG key configured for signing tags
  • You have permission to publish to RubyGems

Release process

  1. Determine the new version using Semantic Versioning

    VERSION=X.Y.Z
    • MAJOR version for incompatible API changes
    • MINOR version for backwards-compatible functionality additions
    • PATCH version for backwards-compatible bug fixes

    Check the ## Unreleased section in CHANGELOG.md for entries prefixed with **BREAKING**:. Any such entry requires a MAJOR version, whatever the other entries are. Raising the minimum supported Ruby version is always a breaking change, so its changelog entry must carry this prefix.

  2. Update the version file with the new version

    Edit version.rb and update the VERSION constant:

    VERSION = "$VERSION"
  3. Run tests and confirm they pass

    rake
  4. Update the changelog with the new version

    Finalize the ## Unreleased section in CHANGELOG.md assigning the version.

  5. Commit the new version

    git commit -a -m "Release $VERSION"
  6. Push the changes

    git push origin main
  7. Wait for CI to complete

  8. Create a signed tag

    git tag -a v$VERSION -s -m "Release $VERSION"
    git push origin --tags

Post-release

  • Verify the new version appears on RubyGems
  • Verify the GitHub release was created
  • Announce the release if necessary