README.md

Warning: work in progress.

This directory contains plugins extending the project configuration format .

Plugin registration

In your package.json file, add the following entry:

{
    "wskp": {
        "<extension-point>": "<plugin-name>",
        ...
    }
}

Where extension-point is one of the following values:

• resource: contributes to an resource
• resourceBinding: contributes to an resource binding
• action: contributes to an action
• api: contributes to an api
• builder: contributes to an action builder

A plugin can contribute to multiple extension point. See types for the signature definition for each extension point

Extension points

action

The plugin plugin-name is activated during this initialization phase when plugin-name occurs within the configuration of an action, for instance:

...
actions:
  <action-name>:
    <plugin-name>: ...

Multiple plugins can be activated for the same action, until the action has no properties other than the one defined by the action type.

builder

The plugin plugin-name is activated during the build phase when name of a builder matches plugin-name.

...
actions:
  <action-name>:
    builder:
      name: <plugin-name>

resource

...
resources:
  <resource-name>:
    type: <plugin-name>

Plugin submission

This is done via PR:

• Clone https://github.com/lionelvillard/openwhisk-project
• edit plugins/package.json to include your extension
• submit PR.