Pipelines Extension Step Model - Files

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

Extension step definitions must be stored in a subdirectory path of the form: steps/<namespace>/<stepTypeName>.

  • namespace is the namespace for the set of extension sets. This parent subdirectory may contain multiple step definition subdirectories.

  • stepTypeName is the named type of the step. Must be alphabetic characters only, and is case-sensitive.

The subdirectory can hold the following files to define the step:

File

Description

Required/Optional

stepModel.yml

Syntax model for the step.

Required

onExecute.sh

and/or

onExecute.ps1

Shell script to be executed in the onExecute block. No user commands will be permitted.

onExecute.sh is required if:

  • Platforms tag is not set, in which case the default OS is Linux.

    or

  • Platforms tag is set to Linux.

onExecute.ps1 is required if Platforms tag is set to Windows.

onSuccess.sh

and/or

onSuccess.ps1

Shell script to be executed in the onSuccess block, in advance of user commands. No user commands will be permitted.

Optional

onFailure.sh

and/or

onFailure.ps1

Shell script to be executed in the onFailure block, in advance of user commands. No user commands will be permitted.

Optional

onComplete.sh

and/or

onComplete.ps1

Shell script to be executed in the onComplete block, in advance of user commands. No user commands will be permitted.

Optional

ReadMe.md

Documentation for the extension step

Optional

icon.svg

Icon graphic to represent the step type in the interactive diagram.

If not provided, Pipelines will use the default icon for the step.

Optional

Extension step 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.