RELEASE.md

Releasing

• Releasing
  • Before You Begin
  • Local Release Preparation
    • Checkout latest code
    • Update the CHANGELOG.md
    • Create Release Commit and Tag
    • Run Pre-Release Tests
  • Push Release Tag
  • Verify Github Release
  • Update Homebrew versions

Before You Begin

Ensure your local workstation is configured to be able to Sign commits

Local Release Preparation

Checkout latest code

git checkout main
git pull origin main

Update the CHANGELOG.md

• Add a new version header at the top of the document, just after # [Unreleased]
• Update links at bottom of changelog

Create Release Commit and Tag

export RELEASE_VERSION=2.x.y
git commit -a -S -m "Release $RELEASE_VERSION"
git tag -s "v$RELEASE_VERSION" # When prompted for a commit message, enter the 'release notes' style message, just like on the releases page

Run Pre-Release Tests

make test-release

• Push to Main Branch

git push origin main --follow-tags

Push Release Tag

• On your local machine again, push your tag to github

git push origin "v$RELEASE_VERSION"

Verify Github Release

• Github Actions should kick off a build and release after the tag is pushed.
• Verify that a Release gets created in Github and verify that the release notes look correct
• Github Actions should also attatch the built binaries to the release (it might take a few mins)

Update Homebrew versions

• Update homebrew-shopify toxiproxy.rb manifest

  1. Update app_version string to your released version
  2. Update hashes for all platforms (find the hashes in the checksums.txt from your release notes)

• Do a manual check of installing toxiproxy via brew

  1. While in the homebrew-shopify directory...

  brew install ./toxiproxy.rb --debug

  Note: it's normal to get some errors when homebrew attempts to load the file as a Cask instead of a formula, just make sure that it still gets installed.

• PR the version update change and merge