-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1ac8dc0
commit 351d423
Showing
6 changed files
with
33 additions
and
17 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
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
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
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
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 |
---|---|---|
@@ -1,20 +1,20 @@ | ||
# Release Process | ||
|
||
1. Merge all PRs intended for the release. | ||
2. Rebase latest remote main branch locally (`git pull --rebase origin main`). | ||
3. Ensure all analysis checks and tests are passing (`TEST_PARALLELISM=8 make testacc`). | ||
4. Run `go mod vendor` and `make goreleaser GORELEASER_ARGS="--skip-validate --clean"`. | ||
5. Open a new PR to update CHANGELOG ([example](https://github.com/fastly/terraform-provider-fastly/pull/498/files))<sup>[1](#note1)</sup>. | ||
6. 🚨 Ensure any _removals_ are considered a BREAKING CHANGE and must be published in a major release. | ||
7. Merge CHANGELOG. | ||
8. Rebase latest remote main branch locally (`git pull --rebase origin main`)<sup>[2](#note2)</sup>. | ||
9. Tag a new release (`tag=vX.Y.Z && git tag -s $tag -m "$tag" && git push origin $tag`)<sup>[3](#note3)</sup>. | ||
10. Copy/paste CHANGELOG into the [draft release](https://github.com/fastly/terraform-provider-fastly/releases). | ||
11. Publish draft release<sup>[4](#note4)</sup>. | ||
1. Rebase latest remote main branch locally (`git pull --rebase origin main`). | ||
1. Ensure all analysis checks and tests are passing (`TEST_PARALLELISM=8 make testacc`). | ||
1. Run `go mod vendor` and `make goreleaser GORELEASER_ARGS="--skip=validate --clean"`. | ||
1. Open a new PR to update CHANGELOG ([example](https://github.com/fastly/terraform-provider-fastly/pull/498/files))<sup>[1](#note1)</sup>. | ||
1. 🚨 Ensure any _removals_ are considered a BREAKING CHANGE and must be published in a major release. | ||
1. Merge CHANGELOG. | ||
1. Rebase latest remote main branch locally (`git pull --rebase origin main`)<sup>[2](#note2)</sup>. | ||
1. Tag a new release (`tag=vX.Y.Z && git tag -s $tag -m "$tag" && git push origin $tag`)<sup>[3](#note3)</sup>. | ||
1. Copy/paste CHANGELOG into the [draft release](https://github.com/fastly/terraform-provider-fastly/releases). | ||
1. Publish draft release<sup>[4](#note4)</sup>. | ||
|
||
## Footnotes | ||
|
||
1. <a name="note1"></a>We utilize [semantic versioning](https://semver.org/) and only include relevant/significant changes within the CHANGELOG. | ||
2. <a name="note2"></a>🚨 Manually update generated `docs/index.md` and force push (as we're not able to update the git tag until the next step). | ||
3. <a name="note3"></a>Triggers a [github action](https://github.com/fastly/terraform-provider-fastly/blob/main/.github/workflows/release.yml) that produces a 'draft' release. | ||
4. <a name="note4"></a>Triggers a [github webhook](https://github.com/fastly/terraform-provider-fastly/settings/hooks) that produces a release on the [terraform registry](https://registry.terraform.io/providers/fastly/fastly/latest). | ||
1. <a name="note2"></a>🚨 Manually update generated `docs/index.md` and force push (as we're not able to update the git tag until the next step). | ||
1. <a name="note3"></a>Triggers a [github action](https://github.com/fastly/terraform-provider-fastly/blob/main/.github/workflows/release.yml) that produces a 'draft' release. | ||
1. <a name="note4"></a>Triggers a [github webhook](https://github.com/fastly/terraform-provider-fastly/settings/hooks) that produces a release on the [terraform registry](https://registry.terraform.io/providers/fastly/fastly/latest). |
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