Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create RELEASE.md document #368

Closed
neufeldtech opened this issue Mar 3, 2022 · 0 comments · Fixed by #369
Closed

Create RELEASE.md document #368

neufeldtech opened this issue Mar 3, 2022 · 0 comments · Fixed by #369
Assignees
Labels

Comments

@neufeldtech
Copy link
Contributor

Had a conversation with @miry about the current release process and what further info we need to port from the readme to a dedicated document with release instructions.

In general, the process is similar to this:

  • PREREQUISITE: Shopify employees performing releases should have their workstation configured to have their commits signed (verified). See Docs
  • Prepare for the release locally.
    • Update the CHANGELOG.md with 2 changes
      1. Add a new version header at the top of the 'unreleased' section
      2. Update links at bottom of changelog
    • Update any version references in the README to point to the new version
  • Commit this locally (and sign the commit) - Commit message should be something like Release 2.x.x
  • Create a tag locally and sign it - git tag -s v2.x.x
  • Run make test-release locally - this will run tests and final verifications
  • Push the release commit to github (either through a PR, or straight to master branch if you have permissions)
  • Wait for tests to turn green after the change is on the master branch (merge your PR as necessary)
  • Push your local tag to github
  • Goreleaser should create the release on Github via Github Actions
  • Verify release notes were generated correctly
  • Update Homebrew versions
    1. Update app_version string
    2. Update hashes for all versions (find the hashes in the checksums.txt from your release notes)
    3. Do a manual smoketest of installing toxiproxy via brew while in the shopify-homebrew repo locally brew install ./toxiproxy.rb --debug
@neufeldtech neufeldtech self-assigned this Mar 3, 2022
@miry miry added this to the 2.5.0 milestone Mar 3, 2022
@miry miry mentioned this issue Mar 3, 2022
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants