-
Notifications
You must be signed in to change notification settings - Fork 140
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* RELEASE.md * Add step for test suite * Clarify expectations for the CHANGELOG * Add communication channels
- Loading branch information
1 parent
14acd4f
commit ba74fa1
Showing
1 changed file
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Release Process | ||
|
||
1. Merge PR. | ||
2. Run full acceptance test suite (to be sure all is well before 'cutting a new release'). | ||
3. Open a new PR to update CHANGELOG ([example](https://github.com/fastly/terraform-provider-fastly/pull/348)). | ||
4. Rebase latest remote master branch locally (`git pull --rebase origin master`). | ||
5. Tag a new release (`git tag -s vX.Y.Z -m "vX.Y.Z" && git push origin vX.Y.Z`). | ||
6. Copy/paste CHANGELOG into the [draft release](https://github.com/fastly/terraform-provider-fastly/releases). | ||
7. Publish draft release. | ||
8. Communicate the release in the relevant Slack channels. | ||
|
||
## Notes | ||
|
||
Step 3. we utilize [semantic versioning](https://semver.org/) and only include relevant/significant changes within the CHANGELOG. | ||
|
||
Step 5. causes a [github action](https://github.com/fastly/terraform-provider-fastly/blob/master/.github/workflows/release.yml) to be triggered which produces a 'draft' release. | ||
|
||
Step 7. causes a [github webhook](https://github.com/fastly/terraform-provider-fastly/settings/hooks) to be triggered which produces a release on the [terraform registry](https://registry.terraform.io/providers/fastly/fastly/latest) and which can take a while to publish, so check back later if it doesn't show up within a few minutes. | ||
|
||
Step 8. `#api-clients`, `#ecp-languages`. |