Skip to content

Latest commit

 

History

History
19 lines (16 loc) · 1.29 KB

RELEASING.md

File metadata and controls

19 lines (16 loc) · 1.29 KB
Raw

(Adapted from Ginkgo's RELEASING.md Copyright (c) 2013-2014 Onsi Fakhouri)

A satcon-client-go release is a tagged git sha and a GitHub release. Please follow best practices for naming/numbering versions as given in https://blog.golang.org/publishing-go-modules.

To cut a release:

  1. Run go mod tidy and run all tests (e.g. ginkgo ./... from top directory). Commit any changes.
  2. Ensure CHANGELOG.md is up to date.
    • Check dependency changes since last release: git diff vX.X.X HEAD -- go.mod
    • Use git log --pretty=format:'- %s [%h]' HEAD...vX.X.X to list all the commits since the last release
    • Categorize the changes into
      • Breaking Changes (requires a major version)
      • New Features (minor version)
      • Fixes (fix version)
      • Maintenance (which in general should not be mentioned in CHANGELOG.md as they have no user impact)
  3. Create a commit with the version number as the commit message (e.g. v1.3.0)
  4. Tag the commit with the version number as the tag name (e.g. v1.3.0)
  5. Push the commit and tag to GitHub
  6. Create a new GitHub release with the version number as the tag (e.g. v1.3.0). List the key changes in the release notes.