id: String
name: String
depends: [String]
tags: [String]
condition: String
ignore_errors: Boolean
properties:
path: String
content: String
args: String
cwd: String
env:
- name: String
value: String
Property | Details |
---|---|
id * | String A unique identifier for the step. Can contain hyphens and underscores, but not spaces. |
name * | String A friendly name for the step. This name will appear in the pipeline designer and run output. |
depends[] | [String] A list of dependencies of this step. This step will not be executed until all steps with |
tags[] | [String] Tags are used to group related steps. Steps with the same tag can be retrieved using the Can contain hyphens and underscores, but not spaces. |
condition | String An expression which is evaluated before the step executes. If it evaluates to false, the step will be skipped. The |
ignore_errors | Boolean If |
properties.path | String Path to an existing script to execute. Provide one of |
properties.content | String Inline script content. Provide one of |
properties.args | String Arguments that will be provided to the script. |
properties.cwd | String If provided, the script will use this path as its working directory. |
properties.env[] | [Object] A list of environment variables that will be set for script execution. |
properties.env[].name * | String Environment variable name. |
properties.env[].value * | String Environment variable value. |
The following are the step execution result fields available at step.result
after a step executes.
Key | Details |
---|---|
result.status | String A string indicating the step execution status. Can be Succeeded, Failed, or Skipped. |
result.exit_code | Number Exit code of the Node.js process. |
result.stdout | String Stdout of the Node.js process. |
result.stderr | String Stderr of the Node.js process. |