|
4 | 4 |
|
5 | 5 | - [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator)
|
6 | 6 |
|
7 |
| -# Generating the CHANGELOG.md |
8 |
| -Run: |
9 |
| -```bash |
10 |
| -github_changelog_generator -u mongodb -p terraform-provider-mongodbatlas --enhancement-label "**Enhancements**" --bugs-label "**Bug Fixes**" |
11 |
| -``` |
| 7 | +## Steps |
| 8 | +### Generate the CHANGELOG.md |
| 9 | +- Run |
| 10 | + |
| 11 | + ```bash |
| 12 | + github_changelog_generator -u mongodb -p terraform-provider-mongodbatlas --enhancement-label "**Enhancements**" --bugs-label "**Bug Fixes**" |
| 13 | + ``` |
| 14 | +- Open a PR against the release branch |
| 15 | + |
| 16 | +### Pre-release the provider |
| 17 | +We pre-release the provider to make for testing purpose. **A Pre-release is not published to the Hashicorp Terraform Registry**. |
| 18 | + |
| 19 | +- Open the GitHub repository release page and click draft a new release |
| 20 | +- Fill the pre-release tag and select the correct target branch |
| 21 | + |
| 22 | + <img width="370" alt="image2" src="https://github.com/mongodb/terraform-provider-mongodbatlas/assets/5663078/e710c0ff-dc00-44c2-9eb6-146cd791d47e"> |
| 23 | + |
| 24 | +- Generate Release Notes: Click Generate release notes button to populate release notes |
| 25 | +- Set publishing to Pre-release |
| 26 | + |
| 27 | + <img width="477" alt="image3" src="https://github.com/mongodb/terraform-provider-mongodbatlas/assets/5663078/30d2db83-6b2d-4eb2-9da6-93fc34d64c09"> |
| 28 | + |
| 29 | +- **There is a bug in the GitHub release page**: after binaries get created, GitHub flips backthe status of release as Draft so you have to set it to Pre-Release again. |
| 30 | + |
| 31 | +### Release the provider |
| 32 | +- Follow the same steps in the pre-release but provide the final release tag (example `v1.9.0`). This will trigger the release action that will release the provider to the GitHub Release page. Harshicorp has a process in place that will retrieve the latest release from the GitHub repository and add the binaries to the Hashicorp Terraform Registry. |
| 33 | +- Merge the release branch into master |
| 34 | +- **CDKTF Update**: Once the provider has been released, we need to update the provider version in our CDKTF. Raise a PR against [cdktf/cdktf-repository-manager](https://github.com/cdktf/cdktf-repository-manager). |
| 35 | + - Example PR: [#183](https://github.com/cdktf/cdktf-repository-manager/pull/183) |
| 36 | + |
0 commit comments