Skip to content

Commit

Permalink
Update RELEASES.md
Browse files Browse the repository at this point in the history
  • Loading branch information
brandonc committed Jul 25, 2022
1 parent 8bd9134 commit cfcfa2a
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
## Release Process

Documentation updates and test fixes that only touch test files don't require a release or tag. You can just merge these changes into `main` once they have been approved.
go-tfe can be released as often as required. Documentation updates and test fixes that only touch test files don't require a release or tag. You can just merge these changes into `main` once they have been approved.

### Preparing a release

Start by comparing the main branch with the last release in order to fully understand which changes are being released. Compare the last release tag with main ([example](https://github.com/hashicorp/go-tfe/compare/v1.5.0...main)). For each meaningful change, double check the following:

1. Is the change added to CHANGELOG.md?
2. Does the public package API follow all endpoint conventions, such as naming, pointer usage, and options availability? Once these are released, they are permanent in the current major release version. Are new features generally available in the Terraform Cloud API? Or is there another considered reason to release them?

Ensure CHANGELOG.md is up to date with the next release version before proceeding.

### Creating a release

Expand Down

0 comments on commit cfcfa2a

Please sign in to comment.