Skip to content

Latest commit

 

History

History
18 lines (17 loc) · 1.07 KB

RELEASING.md

File metadata and controls

18 lines (17 loc) · 1.07 KB

Releasing

  1. Merge all your changes to the stable branch
  2. If releasing a new major version, ensure that package name has been updated, e.g. if new version is v6 package name in go.mod and every import should be github.com/UpCloudLtd/upcloud-go-api/v6
  3. Update CHANGELOG.md
    1. Add new heading with the correct version e.g. ## [6.7.0]
    2. Update links at the bottom of the page
    3. Leave ## Unreleased section at the top empty
    4. Check that Version in upcloud/client/client.go is up-to-date. The value is automatically updated by GitHub Actions.
  4. Test GoReleaser config with goreleaser check
  5. Tag a commit with the version you want to release e.g. v6.7.0
  6. Push the tag & commit to GitHub
    • GitHub action automatically
      • sets the version based on the tag
      • creates a draft release to GitHub
      • populates the release notes from CHANGELOG.md with make release-notes
  7. Verify that release notes are in line with CHANGELOG.MD
  8. Publish the drafted release