Skip to content

feat: update pip conditionally #46

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: update pip conditionally #46

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
39 changes: 20 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,25 +104,26 @@ with:

## Inputs

| Input | Description | Default |
| ------------------ | -------------------------------------------------------------------------------- | -------- |
| `auto-load-pod` | Which pod to load on startup of LocalStack (application preview) | `None` |
| `ci-project` | Name of the CI project to track in LocalStack Cloud | |
| `configuration` | Configuration variables to use while starting LocalStack container | `None` |
| `extension-auto-install` | Which extensions to install on startup of LocalStack (application preview) | `None` |
| `github-token` | Github token used to create PR comments | |
| `image-tag` | Tag of the LocalStack Docker image to use | `latest` |
| `include-preview` | Whether to include the created Ephemeral Instance URL in the PR comment | `false` |
| `install-awslocal` | Whether to install the `awslocal` CLI into the build environment | `true` |
| `lifetime` | How long an ephemeral instance should live | 30 |
| `preview-cmd` | Command(s) used to create a Ephemeral Instance of the PR (can use `$AWS_ENDPOINT_URL`) | |
| `skip-ephemeral-stop` | Skip stopping LocalStack Ephemeral Instance | `false` |
| `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` |
| `skip-wait` | Skip waiting for LocalStack to start up | `false` |
| `state-action` | Valid values are `load`, `save`, `start`, `stop`, `` (empty, don't manage state). Values `start`/`stop` only usable with app previews. | `` |
| `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` |
| `state-name` | Name of the state artifact (without extension) | `false` |
| `use-pro` | Whether to use the Pro version of LocalStack (requires API key to be configured) | `false` |
| Input | Description | Default |
|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|
| `auto-load-pod` | Which pod to load on startup of LocalStack (application preview) | `None` |
| `ci-project` | Name of the CI project to track in LocalStack Cloud | |
| `configuration` | Configuration variables to use while starting LocalStack container | `None` |
| `extension-auto-install` | Which extensions to install on startup of LocalStack (application preview) | `None` |
| `github-token` | Github token used to create PR comments | |
| `image-tag` | Tag of the LocalStack Docker image to use | `latest` |
| `include-preview` | Whether to include the created Ephemeral Instance URL in the PR comment | `false` |
| `install-awslocal` | Whether to install the `awslocal` CLI into the build environment | `true` |
| `lifetime` | How long an ephemeral instance should live | 30 |
| `preview-cmd` | Command(s) used to create a Ephemeral Instance of the PR (can use `$AWS_ENDPOINT_URL`) | |
| `skip-ephemeral-stop` | Skip stopping LocalStack Ephemeral Instance | `false` |
| `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` |
| `skip-wait` | Skip waiting for LocalStack to start up | `false` |
| `state-action` | Valid values are `load`, `save`, `start`, `stop`, `` (empty, don't manage state). Values `start`/`stop` only usable with app previews. | `` |
| `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` |
| `state-name` | Name of the state artifact (without extension) | `false` |
| `update-pip` | Whether to update the current pip version when installing tools | `true` |
| `use-pro` | Whether to use the Pro version of LocalStack (requires API key to be configured) | `false` |

## Example workflow
```yml
Expand Down
8 changes: 7 additions & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ inputs:
description: 'The lifetime of the ephemeral instance, how long the instance should be available for'
required: false
default: '30'
update-pip:
description: 'Whether to update the current pip installation'
required: false
default: 'true'

runs:
using: "composite"
Expand All @@ -104,6 +108,7 @@ runs:
with: |-
{
"install-awslocal": ${{ toJSON(inputs.install-awslocal) }},
"update-pip": ${{ toJSON(inputs.update-pip) }},
}

- name: Start Localstack
Expand All @@ -121,7 +126,8 @@ runs:
"use-pro": ${{ toJSON(inputs.use-pro) }},
"configuration": ${{ toJSON(inputs.configuration) }},
"ci-project": ${{ toJSON(inputs.ci-project) }},
"skip-wait": ${{ toJSON(inputs.skip-wait) }}
"skip-wait": ${{ toJSON(inputs.skip-wait) }},
"update-pip": ${{ toJSON(inputs.update-pip) }},
}

- name: Create Ephemeral Instance
Expand Down
6 changes: 6 additions & 0 deletions startup/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ inputs:
description: 'Skip wait for LocalStack'
required: false
default: 'false'
update-pip:
description: 'Whether to update the current pip installation'
required: true
default: 'true'

runs:
using: "composite"
Expand Down Expand Up @@ -56,6 +60,7 @@ runs:
with: |-
{
"install-awslocal": ${{ toJSON(inputs.install-awslocal) }},
"update-pip": ${{ toJSON(inputs.update-pip) }},
}

- name: Start LocalStack
Expand Down Expand Up @@ -86,4 +91,5 @@ runs:
USE_PRO: ${{ inputs.use-pro }}
CONFIGURATION: ${{ inputs.configuration }}
SKIP_WAIT: ${{ inputs.skip-wait }}
UPDATE_PIP: ${{ inputs.update-pip }}

10 changes: 8 additions & 2 deletions tools/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,24 @@ inputs:
description: 'Whether to install the `awslocal` CLI into the environment'
required: true
default: 'true'
update-pip:
description: 'Whether to update the current pip installation'
required: true
default: 'true'

runs:
using: "composite"
steps:
- name: Start LocalStack
run: |
pip install --upgrade pip
if [ "$UPDATE_PIP" = true ]; then
pip install --upgrade pip
fi
which localstack > /dev/null || pip install localstack
if [ "$INSTALL_AWSLOCAL" = true ]; then
which awslocal > /dev/null || pip install awscli-local[ver1]
fi
shell: bash
env:
INSTALL_AWSLOCAL: "${{ inputs.install-awslocal }}"

UPDATE_PIP: "${{ inputs.update-pip }}"