GitHub Action
Setup LocalStack
v0.1.2
Latest version
A GitHub Action to setup LocalStack on your GitHub Actions runner workflow by:
- Pulling a specific version of the LocalStack Docker Image into the GitHub Action runner.
- Configuring the LocalStack CLI to launch the Docker container with an optional API token for pro usage.
- Installing LocalStack AWS CLI, a thin wrapper around the
awscommand line interface for use with LocalStack to run integration tests over AWS services.
To get started, you can use this minimal example:
- name: Start LocalStack
uses: LocalStack/setup-localstack@v0.1.2
with:
image-tag: 'latest'
install-awslocal: 'true'
env:
LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}| 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_KEYenvironment variable is required to be set ifuse-prois set totrue.
name: LocalStack Test
on: [ push, pull_request ]
jobs:
localstack-action-test:
name: 'Test LocalStack GitHub Action'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Start LocalStack
uses: LocalStack/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 }}
- name: Run Tests against LocalStack
run: |
awslocal s3 mb s3://test
awslocal s3 ls
echo "Test Execution complete!"