archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-18 14:58:43 +00:00
Code Issues Projects Releases Wiki Activity

update readme for package plugin about globs

Browse Source
This commit is contained in:
Jon Sharratt 2016-09-24 10:55:59 +01:00
parent 204632b10e
commit e17e4e44cf
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
lib/plugins/package/README.md
View File

@ -9,8 +9,17 @@ This plugin creates a deployment package on a per service basis (it will zip up
It will zip the whole service directory. The artifact will be stored in the `.serverless` directory which will be created
upon zipping the service. The resulting path to the artifact will be appended to the `service.package.artifact` property.
The services `include` and `exclude` arrays are considered during zipping. At first the `exclude` will be applied. After
that the `include` will be applied to ensure that previously excluded files and folders can be included again.
Services can use `exclude` as an array. The array should be a series of
globs to be considered for exclusion.
For example in serverless.yaml:
``` yaml
package:
exclude:
- "test/**"
- "**/spec.js"
```
Serverless will automatically exclude `.git`, `.gitignore`, `serverless.yml`, and `.DS_Store`.