serverless-framework Orb

Use the Serverless Framework orb for CircleCI to easily deploy to your favorite cloud platform.

Usage

Example use-cases are provided on the orb registry page. Source for these examples can be found within the src/examples directory.

Example Use the Serverless Framework orb's "setup" command to install the Serverless Framework CLI and authenticate with your account if an API key is provided. This example shows how to construct a custom "deploy" job using the Serverless and AWS CLI orbs to deploy an app to AWS.

  version: 2.1
  orbs:
    serverless: circleci/serverless-framework@x.y
    aws-cli: circleci/aws-cli@x.y
  jobs:
    deploy:
      executor: serverless/default
      steps:
        - checkout
        - aws-cli/setup
        - serverless/setup:
            app-name: serverless-framework-orb
            org-name: circleci
        - run:
            name: deploy
            command: serverless deploy -v
  workflows:
    deploy:
      jobs:
        - deploy

View your deployments at https://dashboard.serverless.com/

Resources

CircleCI Orb Registry Page - The official registry page of this orb for all versions, executors, commands, and jobs described.
CircleCI Orb Docs - Docs for using and creating CircleCI Orbs.

How To Contribute

We welcome issues to and pull requests against this repository!

To publish a new production version:

• Create a PR to the Alpha branch with your changes. This will act as a "staging" branch.
• When ready to publish a new production version, create a PR from Alpha to master. The Git Subject should include [semver:patch|minor|release|skip] to indicate the type of release.
• On merge, the release will be published to the orb registry automatically.

For further questions/comments about this or other orbs, visit the Orb Category of CircleCI Discuss.