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

Add example for plugin usage definition in serverless.yaml file

Browse Source
This commit is contained in:
Philipp Muens 2016-06-06 08:02:16 +02:00
parent e0671671b4
commit aea591bc8b
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/concepts/plugins.md
View File

@ -182,9 +182,17 @@ of the corresponding hook function.
## Registering plugins for hooks and commands
A user has to define the plugins they want to use in the serverless.yaml. We do not auto-detect plugins from installed
dependencies so users do not run into any surprises and we cut down on the startup time of the tool. Through JSON-REF
users can share configuration for used plugins between serverless.yaml files in one repository.
A user has to define the plugins they want to use in the root level of the serverless.yaml file:
```yaml
plugins:
- custom_plugin_1
- custom_plugin_2
```
We do not auto-detect plugins from installed dependencies so users do not run into any surprises and we cut down on the
startup time of the tool. Through JSON-REF users can share configuration for used plugins between serverless.yaml files
in one repository.
After the serverless.yaml configuration file is loaded the plugin system will load all the commands and plugins and
initialize the plugin system.