Skip to content

GitHub Action for Deploying AWS Lambda functions in a mono repo

License

Notifications You must be signed in to change notification settings

blombard/lambda-monorepo

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

Maintainability Test Coverage

AWS Lambda monorepo

Deploy your AWS Lambda functions based on the files changed in a mono repo with this Github Action.

Prerequisites

Set you AWS credentials in the secrets of your repo:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_REGION

Create a filters.yml file and put it in .github/worklows : .github/worklows/filters.yml

The structure of the file should be :

LambdaFunction1:
  - 'LambdaFunction1/**/*'
LambdaFunction2:
  - 'LambdaFunction2/**/*'

Example

on:
  push:
    branches:
      - master

jobs:
  deploy:
    name: Deploy to AWS Lambda
    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v3

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

    - uses: dorny/[email protected]
      id: filter
      with:
        filters: .github/filters.yml

    - uses: blombard/lambda-monorepo@master
      with:
        lambda-functions: '${{ toJson(steps.filter.outputs) }}'
        zip-params: '*.js *.json src/ node_modules/'
        alias-name: 'production'
        layer-name: 'MyLayer'

Inputs

lambda-functions

By default should be '${{ toJson(steps.filter.outputs) }}'. Update this only if you know what you are doing.

zip-params

Arguments of the command zip lambda.zip -r $ZIP_PARAMS. It is the files who will be uploaded to your Lambda function.

alias-name

A Lambda alias is like a pointer to a specific Lambda function version. This alias will now point to the new version of your function.

layer-name

If your Lambda use a layer, it will update you function with the latest version of this layer.

Build your own deploy function

If your deployment script is very specific to your project you can override the default deploy.sh script with your own. For that you'll need a deploy.sh file at the root of your project.

deploy.sh

FUNCTION_NAME=$1
PATH_NAME=$2
ZIP_PARAMS=$3

if [ -n "$PATH_NAME" ]; then cd $PATH_NAME; fi

zip lambda.zip -r $ZIP_PARAMS

aws lambda update-function-code --function-name $FUNCTION_NAME --zip-file fileb://lambda.zip
aws lambda update-function-configuration --function-name $FUNCTION_NAME --environment Variables="{`cat .env | xargs | sed 's/ /,/g'`}"

rm -f lambda.zip

exit 0

Note

Since the AWS CLI is really verbose, if you need to deploy sensitive data (in your env variables for example) you can use :

cmd > /dev/null

if you don't want to display stdout but still keep stderr.

Sources

This action is based on those Github actions :