Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 1.7 KB

RELEASE.md

File metadata and controls

20 lines (17 loc) · 1.7 KB
Raw

4# Release Process

  1. Merge all PRs intended for the release.
  2. Rebase latest remote main branch locally (git pull --rebase origin main).
  3. Ensure all analysis checks and tests are passing (TEST_PARALLELISM=8 make testacc).
  4. Run go mod vendor and make goreleaser GORELEASER_ARGS="--snapshot --skip=validate --clean".
  5. Open a new PR to update CHANGELOG (example)1.
  6. 🚨 Ensure any removals are considered a BREAKING CHANGE and must be published in a major release.
  7. Merge CHANGELOG.
  8. Rebase latest remote main branch locally (git pull --rebase origin main)2.
  9. Tag a new release (tag=vX.Y.Z && git tag -s $tag -m $tag && git push $(git config branch.$(git symbolic-ref -q --short HEAD).remote) $tag)3.
  10. Copy/paste CHANGELOG into the draft release.
  11. Publish draft release4.

Footnotes

  1. We utilize semantic versioning and only include relevant/significant changes within the CHANGELOG.
  2. 🚨 Manually update generated docs/index.md and force push (as we're not able to update the git tag until the next step).
  3. Triggers a github action that produces a 'draft' release.
  4. Triggers a github webhook that produces a release on the terraform registry.