jeremydaly / serverless-stage-manager Goto Github PK

View Code? Open in Web Editor NEW

Super simple serverless plugin for validating stage names before deployment

JavaScript 100.00%

serverless-stage-manager's Introduction

serverless-stage-manager

Super simple serverless plugin for validating stage names before deployment.

Installation

Install using Serverless plugin manager

serverless plugin install --name serverless-stage-manager

Install using npm

Install the module using npm:

npm install serverless-stage-manager --save-dev

Add serverless-stage-manager to the plugin list of your serverless.yml file:

plugins:
  - serverless-stage-manager

Configuration

Add a stages value in the custom section of your serverless.yml file and specify an array of valid stage names.

custom:
  stages:
    - dev
    - staging
    - prod

Usage

When running serverless deploy or serverless deploy function, it will check to make sure it is a valid stage name before continuing. For example:

# Given the above configuration of dev, staging & prod

# These will work
serverless deploy -s prod
serverless deploy -s staging
serverless deploy function -f funcName -s dev
serverless deploy # assuming default stage is in custom.stages config

# These will fail
serverless deploy -s foo
serverless deploy function -f funcName -s bar

serverless-stage-manager's People

Contributors

Stargazers

Watchers

serverless-stage-manager's Issues

Is it possible to use wildcards in stage name?

For my CI environment, I have a stage created with the naming pattern of ci-{git-commit-hash}. Would it be possible with this plugin to have an allowed stage name such as ci-*?

Recommend Projects