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.
Install with npm:
npm install --save-dev serverless-prune-plugin
And then add the plugin to your serverless.yml
file:
plugins:
- serverless-prune-plugin
Alternatively, install with the Serverless plugin command (Serverless Framework 1.22 or higher):
sls plugin install -n serverless-prune-plugin
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.
A single function can be targeted for cleanup:
sls prune -n <number of version to keep> -f helloWorld
The previous usage examples prune the default stage in the default region. Use --stage
and --region
to specify:
sls prune -n <number of version to keep> --stage production --region eu-central-1
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.
A dry-run will preview the deletion candidates, without actually performing the pruning operations:
sls prune -n <number of version to keep> --dryRun
See:
sls prune --help
The Serverless Autoprune Plugin by arabold performs a similar role, but targets Serverless 0.5.x projects.
See the included LICENSE for rights and limitations under the terms of the MIT license.