@ipcrm/sdm-pack-serverless NPM

@ipcrm/sdm-pack-serverless

This SDM Extension pack adds functionality to integrate with Serverless.com.

Usage

Note: This pack does not require being registered via sdm.AddExtensionPacks.

To define a new Serverless deploy goal:

    const dev = new ServerlessDeploy()
        .with({
            deployArgs: { stage: "dev" },
        });

Within the ServerlessDeploy constructor you may supply any of the values in PredicateGoalDefinition or Goal to customize the display values or behavior of the goal. The registration (passed to the with method) uses the ServerlessDeployDetails interface (see typings for details) allows you to customize the details of how the serverless command is called.

Important: The Serverless.com command must be installed in the environment the SDM is running on

This goal can be scheduled (if desired) using the push test in the pack:

    sdm.withPushRules(
        whenPushSatisfies(IsServerlessDeployable)
            .setGoals(dev),
    );

This pack expects to find a serverless.yaml (or yml) file in the project, by default (you can customize the file location, name, etc in ServerlessDeployDetails). If found, the goal will continue to execute the deployment process.

Getting started

See the Developer Quick Start to jump straight to creating an SDM.

Contributing

Contributions to this project from community members are encouraged and appreciated. Please review the Contributing Guidelines for more information. Also see the Development section in this document.

Code of conduct

This project is governed by the Code of Conduct. You are expected to act in accordance with this code by participating. Please report any unacceptable behavior to code-of-conduct@atomist.com.