Skip to content

dhollerbach/actions.serverless-with-python-requirements

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Serverless with Python Requirements

JavaScript GitHub Action that runs a Serverless deploy using the serverless-python-requirements plugin.
It also supports optional plugins such as serverless-domain-manager and serverless-plugin-canary-deployments.

See examples for multiple example configurations.

Inputs

Name Required Description
aws-access-key-id Conditional AWS Access Key ID. Required if using AWS credentials instead of Serverless Access Key. Serverless V4 requires a Serverless access key.
aws-secret-access-key Conditional AWS Secret Access Key. Required if using AWS credentials instead of Serverless Access Key. Serverless V4 requires a Serverless access key.
framework Optional The Serverless framework version to install. Defaults to latest.
serverless-access-key Conditional Serverless access key. Required if not using AWS credentials. Serverless V4 requires a Serverless access key.
working-directory Optional The working directory to run Serverless deploy in. Must contain the Serverless config file (e.g. serverless.yaml, serverless.yml). Defaults to the current directory.

Example Usage

AWS Credentials

- name: Serverless Deploy
  uses: dhollerbach/actions.serverless-with-python-requirements@v3
  with:
    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
    aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

Serverless Access Key (required if using Serverless V4)

- name: Serverless Deploy
  uses: dhollerbach/actions.serverless-with-python-requirements@v3
  with:
    serverless-access-key: ${{ secrets.SERVERLESS_ACCESS_KEY }}

Separate AWS Credentials Step

- name: Configure AWS Credentials
  uses: aws-actions/configure-aws-credentials@v4
  with:
    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
    aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
    aws-region: us-east-1

- name: Serverless Deploy
  uses: dhollerbach/actions.serverless-with-python-requirements@v3
  with:
    serverless-access-key: ${{ secrets.SERVERLESS_ACCESS_KEY }}

Directory Other Than Root

- name: Serverless Deploy
  uses: dhollerbach/actions.serverless-with-python-requirements@v3
  with:
    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
    aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
    working-directory: ./examples/

Specific Serverless Framework

- name: Serverless Deploy
  uses: dhollerbach/actions.serverless-with-python-requirements@v3
  with:
    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
    aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
    framework: 3.26.0

About

Installs Serverless and runs a deploy using the serverless-python-requirements plugin

Resources

Stars

Watchers

Forks

Packages

No packages published