Skip to content

Commit c6432ca

Browse files
committed
change referenced of LOCALSTACK_API_KEY to LOCALSTACK_AUTH_TOKEN in README
1 parent 22ab099 commit c6432ca

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
A GitHub Action to setup [LocalStack](https://github.com/localstack/localstack) on your GitHub Actions runner workflow by:
77

88
- Pulling a specific version of the LocalStack Docker Image into the GitHub Action runner.
9-
- Configuring the [LocalStack CLI](https://docs.localstack.cloud/get-started/#localstack-cli) to launch the Docker container with an optional API token for pro usage.
9+
- Configuring the [LocalStack CLI](https://docs.localstack.cloud/get-started/#localstack-cli) to launch the Docker container with an optional Auth Token for pro usage.
1010
- Installing [LocalStack AWS CLI](https://github.com/localstack/awscli-local), a thin wrapper around the `aws` command line interface for use with LocalStack to run integration tests over AWS services.
1111
- Export/import [LocalStack state](https://docs.localstack.cloud/user-guide/state-management/export-import-state/) as an artifact
1212
- Save/load [LocalStack Cloud Pods](https://docs.localstack.cloud/user-guide/state-management/cloud-pods/)
@@ -23,9 +23,9 @@ A GitHub Action to setup [LocalStack](https://github.com/localstack/localstack)
2323
image-tag: 'latest'
2424
install-awslocal: 'true'
2525
env:
26-
LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}
26+
LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
2727
```
28-
> **NOTE**: The `LOCALSTACK_API_KEY` environment variable is required to be set if `use-pro` is set to `true`.
28+
> **NOTE**: The `LOCALSTACK_AUTH_TOKEN` environment variable is required to be set if `use-pro` is set to `true`.
2929
If the key is not found LocalStack by default falls back to the CE edition and displays a warning.
3030

3131
### Install only CLIs and startup later
@@ -43,7 +43,7 @@ If the key is not found LocalStack by default falls back to the CE edition and d
4343
with:
4444
image-tag: 'latest'
4545
env:
46-
LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}
46+
LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
4747
```
4848

4949
### Save a state later on in the pipeline
@@ -56,9 +56,9 @@ If the key is not found LocalStack by default falls back to the CE edition and d
5656
state-action: save
5757
state-name: my-cloud-pod
5858
env:
59-
LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}
59+
LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
6060
```
61-
> **NOTE**: The `LOCALSTACK_API_KEY` environment variable is required to be set to save/load LocalStack's state either as a Cloud Pod or as a file artifact.
61+
> **NOTE**: The `LOCALSTACK_AUTH_TOKEN` environment variable is required to be set to save/load LocalStack's state either as a Cloud Pod or as a file artifact.
6262

6363
### Load an already saved state
6464
```yml
@@ -70,11 +70,11 @@ If the key is not found LocalStack by default falls back to the CE edition and d
7070
state-action: load
7171
state-name: my-cloud-pod
7272
env:
73-
LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}
73+
LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
7474
```
7575
> **NOTE**: To load a **local state** from a different GitHub Actions workflow, one must set the `WORKFLOW_ID` environment variable.
7676

77-
> **NOTE**: The `LOCALSTACK_API_KEY` environment variable is required to be set to **save/load** LocalStack's state either as a Cloud Pod or as a file artifact.
77+
> **NOTE**: The `LOCALSTACK_AUTH_TOKEN` environment variable is required to be set to **save/load** LocalStack's state either as a Cloud Pod or as a file artifact.
7878

7979
### Manage Application Previews (on an Ephemeral Instance)
8080
```yml
@@ -88,7 +88,7 @@ uses: LocalStack/setup-localstack@v0.2.3
8888
# Optional script/command to run
8989
preview-cmd: deploy.sh
9090
env:
91-
LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}
91+
LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
9292

9393
...
9494

@@ -99,7 +99,7 @@ with:
9999
state-backend: ephemeral
100100
state-action: stop
101101
env:
102-
LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}
102+
LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
103103
```
104104
105105
## Inputs
@@ -119,10 +119,10 @@ with:
119119
| `skip-ephemeral-stop` | Skip stopping LocalStack Ephemeral Instance | `false` |
120120
| `skip-startup` | Explicitly prevent LocalStack start up, only installs CLI(s). Recommended to manage state later on in the pipeline or start up an ephemeral instance. | `false` |
121121
| `skip-wait` | Skip waiting for LocalStack to start up | `false` |
122-
| `state-action` | Valid values are `load`, `save`, `start`, `stop`, `` (empty, don't manage state). Values `start`/`stop` only usable with app previews. | `` |
122+
| `state-action` | Valid values are `load`, `save`, `start`, `stop`, `''` (empty, don't manage state). Values `start`/`stop` only usable with app previews. | `''` |
123123
| `state-backend` | Either store the state of LocalStack locally, as a Cloud Pod or start an Ephemeral Instance. Valid values are `cloud-pods`, `ephemeral` or `local`. Use this option in unison with `state-action` to control behaviour. | `cloud-pods` |
124124
| `state-name` | Name of the state artifact (without extension) | `false` |
125-
| `use-pro` | Whether to use the Pro version of LocalStack (requires API key to be configured) | `false` |
125+
| `use-pro` | Whether to use the Pro version of LocalStack (requires Auth Token to be configured) | `false` |
126126

127127
## Example workflow
128128
```yml
@@ -147,7 +147,7 @@ jobs:
147147
state-action: load
148148
state-name: my-cloud-pod
149149
env:
150-
LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}
150+
LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
151151
152152
- name: Run Tests against LocalStack
153153
run: |
@@ -162,7 +162,7 @@ jobs:
162162
state-action: save
163163
state-name: my-ls-state-artifact
164164
env:
165-
LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}
165+
LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
166166
WORKFLOW_ID: ${{ env.MY_GOLDEN_LS_STATE }}
167167
```
168168

0 commit comments

Comments
 (0)