Serverless Prune Plugin

homepage icon https://github.com/claygregory/serverless-prune-plugin

Tracked

NPM Downloads Last Month
4251
Issues
0
Stars
17
Forks
1
Watchers
17

Repo README Contents:

Serverless Prune Plugin

Following deployment, the Serverless Framework does not purge previous versions of functions from AWS, so the number of deployed versions can grow out of hand rather quickly. This plugin allows pruning of all but the most recent version(s) of managed functions from AWS. This plugin targets Serverless 1.x.

Serverless Build Status Coverage Status

Installation

Install to project via npm:

npm install --save-dev serverless-prune-plugin

Add the plugin to your serverless.yml file:

plugins:
  - serverless-prune-plugin

Usage

In the project root, run:

sls prune -n <number of version to keep>

This will delete all but the n-most recent versions of each function deployed. Versions referenced by an alias are automatically preserved.

Single Function

A single function can be targeted for cleanup:

sls prune -n <number of version to keep> -f <function name>

Automatic Pruning

This plugin can also be configured to run automatically, following a deployment. Configuration of automatic pruning is within the custom property of serverless.yml. For example:

custom:
  prune:
    automatic: true
    number: 3

To run automatically, the automatic property of prune must be set to true and the number of versions to keep must be specified.

Additional Help

See:

sls prune --help

See Also

The Serverless Autoprune Plugin by arabold performs a similar role, but only targets Serverless 0.5.x projects.

License

See the included LICENSE for rights and limitations under the terms of the MIT license.