Skip to content

Commit

Permalink
Merge pull request #249 from hashicorp/d-contributing-md-update
Browse files Browse the repository at this point in the history
docs: Update release instructions
  • Loading branch information
mutahhir authored Sep 11, 2024
2 parents 6a5aa83 + 34f38b0 commit d78b328
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@ Release process:

1. Update [`version/VERSION`](https://github.com/hashicorp/hc-install/blob/main/version/VERSION) to remove `-dev` suffix and set it to the intended version to be released
1. Wait for [`build` workflow](https://github.com/hashicorp/hc-install/actions/workflows/build.yml) to finish
1. Run the Release workflow with the appropriate version (matching the one in `version/VERSION`) & SHA (long one).
1. Wait for a message in the Slack channel saying that authorisation is needed to promote artifacts to production. Click on the link and approve.
1. Once notified that promotion is successful, go to <https://github.com/hashicorp/crt-workflows-common/actions/workflows/promote-production-packaging.yml>, locate the hc-install promote-production-packaging workflow, and approve.
1. Wait for [`prepare` workflow](https://github.com/hashicorp/crt-workflows-common/actions/workflows/crt-prepare.yml) to finish
1. Run the [`release` workflow](https://github.com/hashicorp/hc-install/actions/workflows/release.yml) with the appropriate version (matching the one in `version/VERSION`) & SHA (long one).
- This will kick off staging and then production promotions. However, there is currently no way of blocking the production promotion until (staging) artifacts are in place, so **the production promotion is likely to fail**.
1. Wait for [`promote-staging` workflow](https://github.com/hashicorp/crt-workflows-common/actions/workflows/crt-promote-staging.yml) to finish.
1. Retry the failed `production` job of the `release` workflow
1. Wait for a message [in the Slack channel](https://hashicorp.enterprise.slack.com/archives/C01QDH3Q37W) saying that authorisation is needed to promote artifacts to production. Click on the link and approve.
1. Wait for the [`promote-production` workflow](https://github.com/hashicorp/crt-workflows-common/actions/workflows/crt-promote-production.yml) to finish
1. Click on the pencil icon of [the latest release](https://github.com/hashicorp/hc-install/releases), click `Generate release notes`, make any manual changes if necessary (e.g. to call out any breaking changes) and `Update release`.
1. Update [`version/VERSION`](https://github.com/hashicorp/hc-install/blob/main/version/VERSION) and add `-dev` suffix and set it to the expected next version to be released

0 comments on commit d78b328

Please sign in to comment.