Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 1.55 KB

README.md

File metadata and controls

59 lines (43 loc) · 1.55 KB

Github Action for Serverless

This Action wraps the Serverless Framework to enable common Serverless commands.

This project is looking for maintainers!

If you would like to be a maintainer of this project, please reach out to one of the active Serverless organization members to express your interest.

Welcome, and thanks in advance for your help!

Usage

An example workflow to deploy a project with serverless:

name: Deploy master branch

on:
  push:
    branches:
      - master

jobs:
  deploy:
    name: deploy
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [14.x]
    steps:
    - uses: actions/checkout@v2
    - name: Use Node.js ${{ matrix.node-version }}
      uses: actions/setup-node@v1
      with:
        node-version: ${{ matrix.node-version }}
    - run: npm ci
    - name: serverless deploy
      uses: serverless/github-action@master
      with:
        args: deploy
      env:
        SERVERLESS_ACCESS_KEY: ${{ secrets.SERVERLESS_ACCESS_KEY }}
        # or if using AWS credentials directly
        # AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
        # AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

Serverless v1.x

Change serverless/github-action@master to serverless/github-action@v1

Usage with plugins

See example in this issue

License

The Dockerfile and associated scripts and documentation in this project are released under the Apache-2 license.