Skip to content

docs: note v0.3.2 as first immutable release #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dominikschubert wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −9
Open

docs: note v0.3.2 as first immutable release #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -31,15 +33,15 @@ 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'

...

- name: Start LocalStack
uses: LocalStack/setup-localstack@v0.3.0
uses: LocalStack/setup-localstack@v0.3.2
with:
image-tag: 'latest'
env:
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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'
Expand All @@ -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
Expand Down
Loading