RELEASE.md

Release Process

Prerequisites

For security we sign tags. To be able to sign tags you need to tell Git which key you would like to use. Please follow these steps to tell Git about your signing key.

Steps

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. Manually update generated docs/index.md.
5. Open a new PR to update CHANGELOG (example).
   • make sure to use the Skip-Docs label before opening to ensure the docs action doesn't fail with the new version.
   • We utilize semantic versioning and only include relevant/significant changes within the CHANGELOG.
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).
9. Create a new signed tag (replace {{remote}} with the remote pointing to the official repository i.e. origin or upstream depending on your Git workflow): tag=vX.Y.Z && git tag -s $tag -m $tag && git push {{remote}} $tag.
   • Triggers a github action that produces a 'draft' release.
10. Copy/paste CHANGELOG into the draft release.
11. Publish draft release.
    • Triggers a github webhook that produces a release on the terraform registry.