From 86441d6228ffd1faa324da0810143e40693d36f0 Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Sun, 12 Mar 2023 19:49:53 +0530 Subject: [PATCH] DOCS: Add relevant documentation for new input variables --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0636b79..1993dc3 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To get started, you can use this minimal example: ```yml - name: Start LocalStack - uses: HarshCasper/setup-localstack@v0.1.1 + uses: HarshCasper/setup-localstack@v0.1.2 with: image-tag: 'latest' install-awslocal: 'true' @@ -25,10 +25,14 @@ To get started, you can use this minimal example: ### Inputs -|Input|Description |Default -|--|--|--| -|`image-tag` |Tag of the LocalStack Docker image to use |`latest` -|`install-awslocal` |Whether to install the `awslocal` CLI into the build environment | `true` +| Input | Description | Default | +| ------------------ | -------------------------------------------------------------------------------- | -------- | +| `image-tag` | Tag of the LocalStack Docker image to use | `latest` | +| `install-awslocal` | Whether to install the `awslocal` CLI into the build environment | `true` | +| `configuration` | Configuration variables to use while starting LocalStack container | `None` | +| `use-pro` | Whether to use the Pro version of LocalStack (requires API key to be configured) | `false` | + +> **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. ### Example workflow @@ -44,10 +48,12 @@ jobs: - uses: actions/checkout@v3 - name: Start LocalStack - uses: HarshCasper/setup-localstack@v0.1.1 + uses: HarshCasper/setup-localstack@v0.1.2 with: image-tag: 'latest' install-awslocal: 'true' + configuration: DEBUG=1 + use-pro: 'true' env: LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}