Pipelines Extension Resource Model - Files

JFrog Pipelines Documentation
Products
JFrog Pipelines
Content Type
User Guide
ft:sourceType
Paligo

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 named type 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

resourceModel.yml

Syntax model for the resource.

Required

onInput.sh

and/or

onInput.ps1

Shell script to execute when named in a step's inputResources.

Optional

onOutput.sh

and/or

onOutput.ps1

Shell script to execute when named in a step's outputResources.

Optional

ReadMe.md

Documentation for the custom resource.

Optional

icon.svg

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.