Extension resource definitions must be stored in a subdirectory path of the form: resources/<namespace>/<resourceTypeName>.
namespace
is the namespace for the set of extension sets. This parent subdirectory may contain multiple step definition subdirectories.resourceTypeName
is the namedtype
of resource. Must be alphabetic characters only, and is case-sensitive. The subdirectory can hold the following files to define the resource.
File | Description | Required/Optional |
---|---|---|
| Syntax model for the resource. | Required |
and/or
| Shell script to execute when named in a step's | Optional |
and/or
| Shell script to execute when named in a step's | Optional |
| Documentation for the custom resource. | Optional |
| Icon graphic to represent the resource type in the interactive diagram. If not provided, Pipelines will use the default icon for the resource. | Optional |
Extension resrouce definitions are loaded from the source repository when it is configured in the Pipelines UI as an extension source.
Note
For information on administering extension sources and extension version lifecycle staging, see Managing Pipelines Extensions.