Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 3.61 KB

RELEASING.md

File metadata and controls

34 lines (24 loc) · 3.61 KB

Releasing

Prerequisites

Steps

Pre-release the provider

We pre-release the provider to make for testing purpose. A Pre-release is not published to the Hashicorp Terraform Registry.

Generate the CHANGELOG.md

We use a tool called github changelog generator to automatically update our changelog. It provides options for downloading a CLI or using a docker image with interactive mode to update the CHANGELOG.md file locally.

  • Update since_tag and future-release in .github_changelog_generator
  • There is a bug with github_changelog_generator (#971): Make sure to update the future-tag with the pre-release tag. Once you generate the changelog, update future-tag with the final release tag in .github_changelog_generator. Then, manually update the generated changelog to remove references to the pre-release tag
  • Run the following command: 
    docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u mongodb -p terraform-provider-mongodbatlas -t <GH_TOKEN> --enhancement-label "**Enhancements**" --bugs-label "**Bug Fixes**"  --issues-label "**Closed Issues**" --pr-label "**Internal Improvements**"
    To obtain your github personal access token you can use the following guide: Authorizing a personal access token for use with SAML single sign-on
  • Create a JIRA ticket and open a PR against the master branch. Make any manual adjustments if needed taking into account date format and format parameter names and resources/data source names if they begin with mongodbatlas.
  • Example: #1478.
  • If the right most version digit is 0 then create a new doc in /website/docs/guides/X.Y.0-upgrade-guide.html

Release the provider

  • 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.
  • CDKTF Update - Only for major release, i.e. the left most version digit increment (see this comment): Once the provider has been released, we need to update the provider version in our CDKTF. Raise a PR against cdktf/cdktf-repository-manager.