Skip to content

Commit

Permalink
doc(CHANGELOG): v5.7.2 (#830)
Browse files Browse the repository at this point in the history
  • Loading branch information
Integralist committed Apr 15, 2024
1 parent 1ac8dc0 commit 351d423
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -200,4 +200,4 @@ jobs:
with:
install-only: true
- name: Validate Goreleaser
run: make goreleaser GORELEASER_ARGS="--skip-validate --clean --snapshot" # snapshot is needed as local git has no tags
run: make goreleaser GORELEASER_ARGS="--skip=validate --clean --snapshot" # snapshot is needed as local git has no tags
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- name: Run GoReleaser
uses: goreleaser/goreleaser-action@v5
with:
version: latest
version: v1.21.2 # Last version to support Go 1.20.x
args: release --clean
env:
GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}
Expand Down
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
## 5.8.0 (Unreleased)

## 5.7.2 (April 15, 2024)

ENHANCEMENTS:

- fix: update the default timeout value for healthcheck consistency with Fastly App (UI) [#827](https://github.com/fastly/terraform-provider-fastly/pull/827)

BUG FIXES:

- fix(rate_limiter): persist uri_dictionary_name to state [#828](https://github.com/fastly/terraform-provider-fastly/pull/828)
- fix(tls_subscription): ensure configuration_id is current value (not initial) [#824](https://github.com/fastly/terraform-provider-fastly/pull/824)
- fix(tls_mutual_authentication): update activation after mtls creation [#829](https://github.com/fastly/terraform-provider-fastly/pull/829)

DOCUMENTATION:

- Update Certainly Documentation to Remove Beta Label [#826](https://github.com/fastly/terraform-provider-fastly/pull/826)

## 5.7.1 (March 15, 2024)

ENHANCEMENTS:
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ nilaway:
# --clean will save you deleting the dist dir
# --single-target will be quicker and only build for your os & architecture
# e.g.
# make goreleaser GORELEASER_ARGS="--skip-validate --clean"
# make goreleaser GORELEASER_ARGS="--skip=validate --clean"
goreleaser: goreleaser-bin
@GOHOSTOS="${GOHOSTOS}" GOHOSTARCH="${GOHOSTARCH}" goreleaser build ${GORELEASER_ARGS}

Expand Down
26 changes: 13 additions & 13 deletions RELEASE.md
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).
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ terraform {
required_providers {
fastly = {
source = "fastly/fastly"
version = ">= 5.7.1"
version = ">= 5.7.2"
}
}
}
Expand Down

0 comments on commit 351d423

Please sign in to comment.