Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 1.33 KB

File metadata and controls

59 lines (39 loc) · 1.33 KB

Releasing

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

Prerequisites

  • You have commit access to the repository
  • You have push access to the repository
  • You have a GPG key configured for signing tags
  • The repository GitHub Actions secrets required for release publishing are configured

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
  2. Run tests and confirm they pass

    go test -v ./...
  3. Update the changelog with the new version

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

  4. Commit the new version

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

    git push origin main
  6. Wait for CI to complete

  7. Create a signed tag

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

Post-release

  • Verify the GitHub release was created in dnsimple/cli
  • Verify the Homebrew formula was updated in dnsimple/homebrew-tap
  • Announce the release if necessary