This guide outlines the steps to release the custom Terraform provider, ensuring it is published on GitHub and verified on the Terraform Registry.
- Perform thorough testing to ensure all functionalities are working as expected.
- Ensure that the code adheres to best practices and is well-documented.
- Ensure that the release notes reflect release changes. Check with engineering manager if there is a doubt.
- Ensure that latest documentation is merged to the branch. Work with engineering manager to sign off that documentation is latest.
- Navigate to the Releases section of the GitHub repository.
- Click on "Draft a new release" and fill in the tag version, release title, and a description of the changes. Default process is for example named and tagged as
v0.15.0frommainbranch. If custom branch is used it should be specified in the release ticket.
- Binary files will be built by github action. Monitor the progress of the build and attach the binary files to the release once the build is complete.
- If it fails and retry is needed new version should be released.
- Binaries are uploaded to terraform registry automatically see next steps.
- After publishing the release on GitHub, check the Terraform Registry page to ensure the new version is available. Publish to terraform registry is done automatically.
- It may take some time usually 20 minutes for the new version to be reflected on the Terraform Registry from the previous release published.
- Ensure that the documentation on the Terraform Registry is accurate and reflects the latest changes.
- Implement the provider in a Terraform configuration and initialize it using
terraform init. - Ensure that the provider is fetched from the Terraform Registry and works as expected in a sanity test scenario.