Scripts¶
Run Script¶
Runs one .bat/.cmd, PowerShell, Python or shell script from a folder released by the host, once per input item.
Inputs: main · Outputs: main
| Parameter | Type | Description |
|---|---|---|
Script folderroot |
text | A folder released by the host. |
Scriptscript |
text | The file to run, from the chosen script folder. |
Argumentsarguments |
text | Supports expressions. |
Environment variablesenvironment |
key/value pairs | Name → value; next to PIPE_ITEM, PIPE_WORKFLOW, PIPE_EXECUTION, PIPE_ENVIRONMENT and the variables of workflow, group and instance, which these override. |
CredentialcredentialId |
credential | Its fields are passed as PIPE_CREDENTIAL_<FIELD>; their values are masked in output and logs. |
Error patternerrorPattern |
text | Regex; a script fails if a line of its output matches (besides a non-zero exit code). |
Ignore caseignoreCase |
true/false | Default: true. |
Timeout per script (minutes)timeoutMinutes |
number | Default: 10. |
Run Scripts Folder¶
Runs the switched-on scripts of a folder released by the host, in order, once per input item. One output item per script with exit code and output.
Inputs: main · Outputs: main
| Parameter | Type | Description |
|---|---|---|
Script folderroot |
text | A folder released by the host. |
Pathpath |
text | File or folder inside the script folder; empty for all of it. |
Include subfoldersincludeSubfolders |
true/false | Default: false. |
Scriptsscripts |
list | Run top to bottom, each in its own process; files added later are off until switched on. |
Stop on first failurestopOnFirstFailure |
true/false | Default: true. |
Argumentsarguments |
text | Supports expressions. |
Environment variablesenvironment |
key/value pairs | Name → value; next to PIPE_ITEM, PIPE_WORKFLOW, PIPE_EXECUTION, PIPE_ENVIRONMENT and the variables of workflow, group and instance, which these override. |
CredentialcredentialId |
credential | Its fields are passed as PIPE_CREDENTIAL_<FIELD>; their values are masked in output and logs. |
Error patternerrorPattern |
text | Regex; a script fails if a line of its output matches (besides a non-zero exit code). |
Ignore caseignoreCase |
true/false | Default: true. |
Timeout per script (minutes)timeoutMinutes |
number | Default: 10. |
Run Scripts Repo¶
Clones a repository of a configured Git server for the run and runs its switched-on scripts in order, with the repository root as working directory (PIPE_WORK_DIRECTORY). The clone is deleted afterwards.
Inputs: main · Outputs: main
| Parameter | Type | Description |
|---|---|---|
Git serverserver |
text | A Git server configured by the host. |
Repositoryrepository |
text | A repository of the chosen Git server. |
Branchbranch |
text | Empty for the repository's default branch. |
Pathpath |
text | File or folder inside the repository; empty for all of it. |
Include subfoldersincludeSubfolders |
true/false | Default: false. |
Scriptsscripts |
list | Run top to bottom, each in its own process; files added later are off until switched on. |
Stop on first failurestopOnFirstFailure |
true/false | Default: true. |
Argumentsarguments |
text | Supports expressions. |
Environment variablesenvironment |
key/value pairs | Name → value; next to PIPE_ITEM, PIPE_WORKFLOW, PIPE_EXECUTION, PIPE_ENVIRONMENT and the variables of workflow, group and instance, which these override. |
CredentialcredentialId |
credential | Its fields are passed as PIPE_CREDENTIAL_<FIELD>; their values are masked in output and logs. |
Error patternerrorPattern |
text | Regex; a script fails if a line of its output matches (besides a non-zero exit code). |
Ignore caseignoreCase |
true/false | Default: true. |
Timeout per script (minutes)timeoutMinutes |
number | Default: 10. |