Skip to content

Commit 86441d6

Browse files
committed
DOCS: Add relevant documentation for new input variables
1 parent 8c6f7dc commit 86441d6

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ To get started, you can use this minimal example:
1515

1616
```yml
1717
- name: Start LocalStack
18-
uses: HarshCasper/[email protected].1
18+
uses: HarshCasper/[email protected].2
1919
with:
2020
image-tag: 'latest'
2121
install-awslocal: 'true'
@@ -25,10 +25,14 @@ To get started, you can use this minimal example:
2525
2626
### Inputs
2727
28-
|Input|Description |Default
29-
|--|--|--|
30-
|`image-tag` |Tag of the LocalStack Docker image to use |`latest`
31-
|`install-awslocal` |Whether to install the `awslocal` CLI into the build environment | `true`
28+
| Input | Description | Default |
29+
| ------------------ | -------------------------------------------------------------------------------- | -------- |
30+
| `image-tag` | Tag of the LocalStack Docker image to use | `latest` |
31+
| `install-awslocal` | Whether to install the `awslocal` CLI into the build environment | `true` |
32+
| `configuration` | Configuration variables to use while starting LocalStack container | `None` |
33+
| `use-pro` | Whether to use the Pro version of LocalStack (requires API key to be configured) | `false` |
34+
35+
> **NOTE**: The `LOCALSTACK_API_KEY` environment variable is required to be set if `use-pro` is set to `true`. While starting the [localstack-pro](https://hub.docker.com/r/localstack/localstack-pro) image, the DNS startup is skipped with `DNS_ADDRESS=0` configuration variable. It is required to properly start LocalStack in GitHub Actions runner environment.
3236

3337
### Example workflow
3438

@@ -44,10 +48,12 @@ jobs:
4448
- uses: actions/checkout@v3
4549
4650
- name: Start LocalStack
47-
uses: HarshCasper/[email protected].1
51+
uses: HarshCasper/[email protected].2
4852
with:
4953
image-tag: 'latest'
5054
install-awslocal: 'true'
55+
configuration: DEBUG=1
56+
use-pro: 'true'
5157
env:
5258
LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}
5359

0 commit comments

Comments
 (0)