Skip to content

Commit 3301c34

Browse files
committed
package: individually documentation updates
1 parent da40023 commit 3301c34

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,14 @@ When `serverless deploy` is run, the plugin will:
8383
The Serverless framework will then pickup each zip file and upload it to your provider.
8484

8585
Here's a simple `serverless.yml` configuration for this plugin, assuming the project structure above
86-
one of the fuctions we add `-${opt:stage}` to the name in order to append the stage to the function name
86+
one of the functions we add `-${opt:stage}` to the name in order to append the stage to the function name
8787

8888
```
8989
service: your-awesome-project
9090
91+
package:
92+
individually: true
93+
9194
plugins:
9295
- serverless-package-python-functions
9396
@@ -136,6 +139,9 @@ At the function level, you:
136139
- Use `include` to specify what function-level files you want to include in your artifact. Simply specifying the path to the function's folder will include every file in the folder in the function's zip artifact
137140
- Use `artifact` to tell Serverless where to find the zip artifact. The plugin creates the zip artifact for the function at `buildDir`/`name`.zip, so using `${self:custom.pkgPyFuncs.buildDir}/[function-name-here].zip` is advised.
138141

142+
At the package level, you may need to:
143+
- Specify the `individually` parameter as `true` to ensure that zip artifacts are generated properly. You may need this if you are getting file not found errors about your zip artifact.
144+
139145
Now, you may be wondering, doesn't the [Serverless documentation say](https://serverless.com/framework/docs/providers/aws/guide/packaging#artifact):
140146
> Serverless won't zip your service if [artifact] is configured and therefore exclude and include will be ignored. Either you use artifact or include / exclude.
141147

0 commit comments

Comments
 (0)