From 7550d9b252a29cf2ebd658d7dcfcb712a74a902e Mon Sep 17 00:00:00 2001 From: Dominik Date: Tue, 14 Apr 2026 14:46:12 +0200 Subject: [PATCH] docs: note v0.3.2 as first immutable release Immutable Releases is enabled at the repository level, but GitHub applies it only to releases published after the setting was flipped. Publish v0.3.2 as the first immutable tag and document in the README/CHANGELOG so users know which tag to pin for supply-chain hardening. Also bump example snippets from @v0.3.0 to @v0.3.2 and backfill the skipped v0.3.1 changelog entry. Co-Authored-By: Claude Opus 4.6 (1M context) --- CHANGELOG.md | 10 ++++++++++ README.md | 20 +++++++++++--------- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0b31faf..da63c93 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Changelog +## [0.3.2] + +### Notes + +- **First immutable release.** This is the first release published with [GitHub Immutable Releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-immutable-releases) enabled on the repository. The `v0.3.2` tag and its assets cannot be modified or deleted, and the release carries a signed attestation. Users are encouraged to pin to `v0.3.2` (or later) for supply-chain hardening. + +## [0.3.1] + +- Only show `use-pro` deprecation message on top action input ([#67](https://github.com/LocalStack/setup-localstack/pull/67)). + ## [0.3.0] ### Breaking Changes diff --git a/README.md b/README.md index 25ef9eb..243ef2a 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,13 @@ A GitHub Action to setup [LocalStack](https://github.com/localstack/localstack) ## Usage +> **Pin to `v0.3.2` or later.** `v0.3.2` is the first release published with [GitHub Immutable Releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-immutable-releases) enabled, meaning its tag and assets cannot be modified or deleted. Pinning to an immutable tag (or its commit SHA) protects your workflow from supply-chain tampering. + ### Get started with a minimal example ```yml - name: Start LocalStack - uses: LocalStack/setup-localstack@v0.3.0 + uses: LocalStack/setup-localstack@v0.3.2 with: image-tag: 'latest' install-awslocal: 'true' @@ -31,7 +33,7 @@ A GitHub Action to setup [LocalStack](https://github.com/localstack/localstack) ### Install only CLIs and startup later ```yml - name: Install LocalStack CLIs - uses: LocalStack/setup-localstack@v0.3.0 + uses: LocalStack/setup-localstack@v0.3.2 with: skip-startup: 'true' install-awslocal: 'true' @@ -39,7 +41,7 @@ A GitHub Action to setup [LocalStack](https://github.com/localstack/localstack) ... - name: Start LocalStack - uses: LocalStack/setup-localstack@v0.3.0 + uses: LocalStack/setup-localstack@v0.3.2 with: image-tag: 'latest' env: @@ -49,7 +51,7 @@ A GitHub Action to setup [LocalStack](https://github.com/localstack/localstack) ### Save a state later on in the pipeline ```yml - name: Save LocalStack State - uses: LocalStack/setup-localstack@v0.3.0 + uses: LocalStack/setup-localstack@v0.3.2 with: install-awslocal: 'true' state-backend: cloud-pods @@ -63,7 +65,7 @@ A GitHub Action to setup [LocalStack](https://github.com/localstack/localstack) ### Load an already saved state ```yml - name: Start LocalStack and Load State - uses: LocalStack/setup-localstack@v0.3.0 + uses: LocalStack/setup-localstack@v0.3.2 with: install-awslocal: 'true' state-backend: cloud-pods @@ -78,7 +80,7 @@ A GitHub Action to setup [LocalStack](https://github.com/localstack/localstack) ### Manage Application Previews (on an Ephemeral Instance) ```yml -uses: LocalStack/setup-localstack@v0.3.0 +uses: LocalStack/setup-localstack@v0.3.2 with: github-token: ${{ secrets.GITHUB_TOKEN }} state-backend: ephemeral @@ -93,7 +95,7 @@ uses: LocalStack/setup-localstack@v0.3.0 ... with: - uses: LocalStack/setup-localstack@v0.3.0 + uses: LocalStack/setup-localstack@v0.3.2 with: github-token: ${{ secrets.GITHUB_TOKEN }} state-backend: ephemeral @@ -137,7 +139,7 @@ jobs: - uses: actions/checkout@v3 - name: Start LocalStack - uses: LocalStack/setup-localstack@v0.3.0 + uses: LocalStack/setup-localstack@v0.3.2 with: image-tag: 'latest' install-awslocal: 'true' @@ -155,7 +157,7 @@ jobs: echo "Test Execution complete!" - name: Save LocalStack State - uses: LocalStack/setup-localstack@v0.3.0 + uses: LocalStack/setup-localstack@v0.3.2 with: state-backend: local state-action: save