Installations

npm install serverless-prune-plugin

Score

61.8

Supply Chain

97.8

Quality

78.6

Maintenance

100

Vulnerability

98.3

License

Pull Requests

Open

3

Total

40

Closed

3

Merged

34

Issues

Open

8

Total

37

Closed

29

Releases

27

Version 2.1.0

v.2.1.0

Published on 16 Oct 2024

Version 2.0.2

v.2.0.2

Published on 15 Feb 2023

Version 2.0.1

v.2.0.1

Published on 04 Jan 2022

Version 2.0.0

v.2.0.0

Published on 30 Dec 2021

Version 2.0.0 Beta 0

v.2.0.0-beta.0

Published on 22 Nov 2021

Version 1.6.1

v.1.6.1

Published on 07 Oct 2021

View all 27 releases

Developer

claygregory

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

NPM Version

Statistics

364 Stars

117 Commits

35 Forks

9 Watching

2 Branches

11 Contributors

Updated on 19 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

55,959,102

Last day

-4.1%

55,676

Compared to previous day

Last week

2.8%

301,440

Compared to previous week

Last month

7.4%

1,260,881

Compared to previous month

Last year

1.2%

14,740,017

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

bluebird

Peer Dependencies

1

serverless

Dev Dependencies

6

coveralls eslint istanbul mocha mocha-lcov-reporter sinon

Versions

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 is compatible with Serverless 1.x and higher.

Installation

Install with npm:

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

And then add the plugin to your serverless.yml file:

1plugins:
2  - serverless-prune-plugin

Alternatively, install with the Serverless plugin command (Serverless Framework 1.22 or higher):

1sls plugin install -n serverless-prune-plugin

Usage

In the project root, run:

1sls 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:

1sls prune -n <number of version to keep> -f helloWorld

Region/Stage

The previous usage examples prune the default stage in the default region. Use --stage and --region to specify:

1sls prune -n <number of version to keep> --stage production --region eu-central-1

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:

1custom:
2  prune:
3    automatic: true
4    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. It is possible to set number to 0. In this case, the plugin will delete all the function versions (except $LATEST); this is useful when disabling function versioning for an already-deployed stack.

Layers

This plugin can also prune Lambda Layers in the same manner that it prunes functions. You can specify a Lambda Layer, or add the flag, includeLayers:

1custom:
2  prune:
3    automatic: true
4    includeLayers: true
5    number: 3

Dry Run

A dry-run will preview the deletion candidates, without actually performing the pruning operations:

1sls prune -n <number of version to keep> --dryRun

Additional Help

See:

1sls prune --help

Permissions Required

To run this plugin, the user will need to be allowed the following permissions in AWS:

lambda:listAliases
lambda:listVersionsByFunction
lambda:deleteFunction
lambda:listLayerVersions
lambda:deleteLayerVersion

Common Questions

How do I set up different pruning configurations per region/stage?

Several suggestions are available in this thread.

Can I just disable versioning entirely?

Absolutely. While Serverless Framework has it enabled by default, versioning can be disabled.

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

Maintained

Determines if the project is "actively maintained".

5

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

5

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.2

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More