diff --git a/pages/pipelines/configure/step_types/block_step.md b/pages/pipelines/configure/step_types/block_step.md
index 96cb9a6ad3..c07f52e636 100644
--- a/pages/pipelines/configure/step_types/block_step.md
+++ b/pages/pipelines/configure/step_types/block_step.md
@@ -57,60 +57,62 @@ Optional attributes:
prompt |
- The instructional message displayed in the dialog box when the unblock step is activated.
- Example:
+ The instructional message displayed in the dialog box when the unblock step is activated.
+ Example:
-
"Release to production?" "Fill out the details for this release"
|
fields |
- A list of input fields required to be filled out before unblocking the step.
- Available input field types: text, select
+ A list of input fields required to be filled out before unblocking the step.
+ Available input field types: text, select
|
blocked_state |
- The state that the build is set to when the build is blocked by this block step. The default is passed. When the blocked_state of a block step is set to failed, the step that triggered it will be stuck in the running state until it is manually unblocked.
- Default: passed
- Values: passed, failed, running
- If you're using GitHub, you can also configure which GitHub status to use for blocked builds on a per-pipline basis.
+ The state that the build is set to when the build is blocked by this block step. The default is passed. When the blocked_state of a block step is set to failed, the step that triggered it will be stuck in the running state until it is manually unblocked.
+ Default: passed
+ Values: passed, failed, running
+ If you're using GitHub, you can also configure which GitHub status to use for blocked builds on a per-pipeline basis.
|
branches |
- The branch pattern defining which branches will include this block step in their builds.
- Example: "main stable/*"
+ The branch pattern defining which branches will include this block step in their builds.
+ Example: "main stable/*"
|
if |
- A boolean expression that omits the step when false. See Using conditionals for supported expressions.
- Example: build.message != "skip me"
+ A boolean expression that omits the step when false. See Using conditionals for supported expressions.
+ Example: build.message != "skip me"
|
depends_on |
- A list of step keys that this step depends on. This step will only proceed after the named steps have completed. See managing step dependencies for more information.
- Example: "test-suite"
+ A list of step keys that this step depends on. This step will only proceed after the named steps have completed. See managing step dependencies for more information.
+ Example: "test-suite"
|
key |
- A unique string to identify the block step.
- Example: "test-suite"
+ A unique string to identify the block step.
+ Keys can not have the same pattern as a UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
+ Example: "test-suite"
+ Alias: identifier
|
allow_dependency_failure |
- Whether to continue to proceed past this step if any of the steps named in the depends_on attribute fail.
- Default: false
+ Whether to continue to proceed past this step if any of the steps named in the depends_on attribute fail.
+ Default: false
|
@@ -133,9 +135,9 @@ Required attributes:
key |
- The meta-data key that stores the field's input (using the buildkite-agent meta-data command)
- The key may only contain alphanumeric characters, slashes, dashes, or underscores.
- Example: "release-name"
+ The meta-data key that stores the field's input (using the buildkite-agent meta-data command)
+ The key may only contain alphanumeric characters, slashes, dashes, or underscores.
+ Example: "release-name"
|
@@ -156,22 +158,22 @@ Optional attributes:
hint |
- The explanatory text that is shown after the label.
- Example: "What's the code name for this release? \:name_badge\:"
+ The explanatory text that is shown after the label.
+ Example: "What's the code name for this release? \:name_badge\:"
|
required |
- A boolean value that defines whether the field is required for form submission.
- Default value: true
+ A boolean value that defines whether the field is required for form submission.
+ Default value: true
|
default |
- The value that is pre-filled in the text field.
- Example: "Flying Dolphin"
+ The value that is pre-filled in the text field.
+ Example: "Flying Dolphin"
|
@@ -197,7 +199,7 @@ Required attributes:
key |
- The meta-data key that stores the field's input (using the buildkite-agent meta-data command)
+ The meta-data key that stores the field's input (using the buildkite-agent meta-data command)
The key may only contain alphanumeric characters, slashes, dashes, or underscores.
Example: "release-stream"
|
@@ -205,8 +207,8 @@ Required attributes:
options |
- The list of select field options.
- For 6 or less options they'll be displayed as radio buttons, otherwise they'll be displayed in a dropdown box.
+ The list of select field options.
+ For 6 or less options they'll be displayed as radio buttons, otherwise they'll be displayed in a dropdown box.
If selecting multiple options is permitted the options will be displayed as checkboxes.
|
@@ -218,14 +220,14 @@ Each select option has the following _required_ attributes:
label |
- The text displayed for the option.
+ The text displayed for the option.
Example: "Stable"
|
value |
- The value to be stored as meta-data (to be later retrieved using the buildkite-agent meta-data command)
+ The value to be stored as meta-data (to be later retrieved using the buildkite-agent meta-data command)
Example: "stable"
|
@@ -252,31 +254,31 @@ Optional attributes:
hint |
- The text displayed directly under the select field's label.
+ The text displayed directly under the select field's label.
Example: "Which release stream does this belong in? \:fork\:"
|
required |
- A boolean value that defines whether the field is required for form submission.
- When this value is set to false and users can only select one option, the options display in a dropdown menu, regardless of how many options there are.
+ A boolean value that defines whether the field is required for form submission.
+ When this value is set to false and users can only select one option, the options display in a dropdown menu, regardless of how many options there are.
Default: true
|
multiple |
- A boolean value that defines whether multiple options may be selected.
- When multiple options are selected, they are delimited in the meta-data field by a line break (\n)
+ A boolean value that defines whether multiple options may be selected.
+ When multiple options are selected, they are delimited in the meta-data field by a line break (\n)
Default: false
|
default |
- The value of the option or options that will be pre-selected.
- When multiple is enabled, this can be an array of values to select by default.
+ The value of the option or options that will be pre-selected.
+ When multiple is enabled, this can be an array of values to select by default.
Example: "beta"
|
diff --git a/pages/pipelines/configure/step_types/command_step.md b/pages/pipelines/configure/step_types/command_step.md
index c78ce8a02d..ba84ccecc0 100644
--- a/pages/pipelines/configure/step_types/command_step.md
+++ b/pages/pipelines/configure/step_types/command_step.md
@@ -22,9 +22,12 @@ Required attributes:
command |
- The shell command/s to run during this step. This can be a single line of commands, or a list of commands that must all pass. Also available as the alias commands.
- Example: "build.sh"
- Example:
- "npm install"
- "tests.sh"
+ The shell command/s to run during this step. This can be a single line of commands, or a list of commands that must all pass.
+ Example: "build.sh"
+ Example:
+ - "npm install"
+ - "tests.sh"
+ Alias: commands
|
@@ -38,7 +41,7 @@ steps:
```
{: codeblock-file="pipeline.yml"}
->📘 Pipelines without command steps
+> 📘 Pipelines without command steps
> Although the command attribute is required for a command step, some plugins work without a command step, so it isn't strictly necessary for your pipeline to have an explicit command step.
Optional attributes:
@@ -47,130 +50,133 @@ Optional attributes:
agents |
- A map of agent tag keys to values to target specific agents for this step.
+ A map of agent tag keys to values to target specific agents for this step.
Example: npm: "true"
|
allow_dependency_failure |
- Whether to continue to run this step if any of the steps named in the depends_on attribute fail.
+ Whether to continue to run this step if any of the steps named in the depends_on attribute fail.
Default: false
|
artifact_paths |
- The glob path or paths of artifacts to upload from this step. This can be a single line of paths separated by semicolons, or a list.
- Example: "logs/**/*;coverage/**/*"
- Example:
- "logs/**/*"
- "coverage/**/*"
+ The glob path or paths of artifacts to upload from this step. This can be a single line of paths separated by semicolons, or a list.
+ Example: "logs/**/*;coverage/**/*"
+ Example:
+ - "logs/**/*"
+ - "coverage/**/*"
|
branches |
- The branch pattern defining which branches will include this step in their builds.
+ The branch pattern defining which branches will include this step in their builds.
Example: "main stable/*"
|
cancel_on_build_failing |
- Setting this attribute to true cancels the job as soon as the build is marked as failing.
+ Setting this attribute to true cancels the job as soon as the build is marked as failing.
Default: "false"
|
concurrency |
- The maximum number of jobs created from this step that are allowed to run at the same time. If you use this attribute, you must also define a label for it with the concurrency_group attribute.
+ The maximum number of jobs created from this step that are allowed to run at the same time. If you use this attribute, you must also define a label for it with the concurrency_group attribute.
Example: 3
|
concurrency_group |
- A unique name for the concurrency group that you are creating. If you use this attribute, you must also define the concurrency attribute.
+ A unique name for the concurrency group that you are creating. If you use this attribute, you must also define the concurrency attribute.
Example: "my-app/deploy"
|
depends_on |
- A list of step keys that this step depends on. This step will only run after the named steps have completed. See managing step dependencies for more information.
+ A list of step keys that this step depends on. This step will only run after the named steps have completed. See managing step dependencies for more information.
Example: "test-suite"
|
env |
- A map of environment variables for this step.
+ A map of environment variables for this step.
Example: RAILS_ENV: "test"
|
if |
- A boolean expression that omits the step when false. See Using conditionals for supported expressions.
+ A boolean expression that omits the step when false. See Using conditionals for supported expressions.
Example: build.message != "skip me"
|
key |
- A unique string to identify the step. The value is available in the BUILDKITE_STEP_KEY environment variable.
- Keys can not have the same pattern as a UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
- Example: "linter"
+ A unique string to identify the command step. The value is available in the BUILDKITE_STEP_KEY environment variable.
+ Keys can not have the same pattern as a UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
+ Example: "linter"
Alias: identifier
|
label |
- The label that will be displayed in the pipeline visualisation in Buildkite. Supports emoji.
- Example: "\:hammer\: Tests" will be rendered as "🔨 Tests"
+ The label that will be displayed in the pipeline visualization in Buildkite. Supports emoji.
+ Example: "\:hammer\: Tests" will be rendered as ":hammer: Tests"
|
matrix |
- Either an array of values to be used in the matrix expansion, or a single setup key, and an optional adjustments key.
- steps:
-- label: "{{matrix}} build"
- command: "echo '.buildkite/steps/build-binary.sh {{matrix}}'"
- matrix:
- - "macOS"
+ Either an array of values to be used in the matrix expansion, or a single setup key, and an optional adjustments key.
+ steps:
+- label: "{{matrix}} build"
+ command: "echo '.buildkite/steps/build-binary.sh {{matrix}}'"
+ matrix:
+ - "macOS"
- "Linux"
|
parallelism |
- The number of parallel jobs that will be created based on this step.
+ The number of parallel jobs that will be created based on this step.
Example: 3
|
plugins |
- An array of plugins for this step.
- Example:
- - docker-compose#v1.0.0:
+ An array of plugins for this step.
+ Example:
+ - docker-compose#v1.0.0:
run: app
|
priority |
- Adjust the priority for a specific job, as a positive or negative integer.
- Example:
- - command: "will-run-first.sh"
priority: 1
+ Adjust the priority for a specific job, as a positive or negative integer.
+ Example:
+ - command: "will-run-first.sh"
+ priority: 1
|
retry |
- The conditions for retrying this step.
+ The conditions for retrying this step.
Available types: automatic, manual
|
@@ -178,9 +184,9 @@ Optional attributes:
skip |
Whether to skip this step or not. Passing a string (with a 70-character limit) provides a reason for skipping this command. Passing an empty string is equivalent to false.
- Note: Skipped steps will be hidden in the pipeline view by default, but can be made visible by toggling the 'Skipped jobs' icon.
- Example: true
- Example: false
+ Note: Skipped steps will be hidden in the pipeline view by default, but can be made visible by toggling the 'Skipped jobs' icon.
+ Example: true
+ Example: false
Example: "My reason"
|
@@ -188,10 +194,10 @@ Optional attributes:
soft_fail |
Allow specified non-zero exit statuses not to fail the build.
- Can be either an array of allowed soft failure exit statuses or true to make all exit statuses soft-fail.
- Example: true
- Example:
- - exit_status: 1
+ Can be either an array of allowed soft failure exit statuses or true to make all exit statuses soft-fail.
+ Example: true
+ Example:
+ - exit_status: 1
|
@@ -212,20 +218,20 @@ At least one of the following attributes is required:
automatic |
- Whether to allow a job to retry automatically. This field accepts a boolean value, individual retry conditions, or a list of multiple different retry conditions.
If set to true, the retry conditions are set to the default value.
- Default value:
- exit_status: "*"
- signal: "*"
- signal_reason: "*"
- limit: 2
+ Whether to allow a job to retry automatically. This field accepts a boolean value, individual retry conditions, or a list of multiple different retry conditions.
If set to true, the retry conditions are set to the default value.
+ Default value:
+ exit_status: "*"
+ signal: "*"
+ signal_reason: "*"
+ limit: 2
Example: true
|
manual |
- Whether to allow a job to be retried manually. This field accepts a boolean value, or a single retry condition.
- Default value: true
+ Whether to allow a job to be retried manually. This field accepts a boolean value, or a single retry condition.
+ Default value: true
Example: false
|
@@ -275,7 +281,7 @@ Conditions on retries can be specified. For example, it's possible to set steps
command: "deploy.sh"
branches: "main"
retry:
- manual:
+ manual:
allowed: false
reason: "Deploys shouldn't be retried"
```
@@ -289,7 +295,7 @@ Optional attributes:
exit_status |
- The exit status value that causes this job to retry, and can include any value between 0-255. Other valid exit status values include * for any value between 1-255 (excluding 0), as well as -1 (the value returned when an agent is lost and Buildkite no longer receives contact from agent).
+ The exit status value that causes this job to retry, and can include any value between 0-255. Other valid exit status values include * for any value between 1-255 (excluding 0), as well as -1 (the value returned when an agent is lost and Buildkite no longer receives contact from agent).
Examples:
"*"
signal_reason |
- The reason a process was signaled.
+ The reason a process was signaled.
Examples:
"*"
limit |
- The number of times this job can be retried. The maximum value this can be set to is 10.
+ The number of times this job can be retried. The maximum value this can be set to is 10.
Example: 3
|
@@ -358,22 +364,22 @@ Optional attributes:
allowed |
- A boolean value that defines whether or not this job can be retried manually.
- Default value: true
+ A boolean value that defines whether or not this job can be retried manually.
+ Default value: true
Example: false
|
permit_on_passed |
- A boolean value that defines whether or not this job can be retried after it has passed.
+ A boolean value that defines whether or not this job can be retried after it has passed.
Example: false
|
reason |
- A string that will be displayed in a tooltip on the Retry button in Buildkite. This will only be displayed if the allowed attribute is set to false.
+ A string that will be displayed in a tooltip on the Retry button in Buildkite. This will only be displayed if the allowed attribute is set to false.
Example: "No retries allowed on deploy steps"
|
@@ -407,8 +413,8 @@ Optional attributes:
exit_status |
Allow specified non-zero exit statuses not to fail the build.
-
- Example: "*"
+
+ Example: "*"
Example: 1
|
|
@@ -436,7 +442,7 @@ steps:
adjustments |
- A array of with keys, each mapping an element to each dimension listed in the `array.setup`, as well as the attribute to modify for that combination.
+ A array of with keys, each mapping an element to each dimension listed in the array.setup, as well as the attribute to modify for that combination.
Currently, only soft_fail and skip can be modified.
|
diff --git a/pages/pipelines/configure/step_types/group_step.md b/pages/pipelines/configure/step_types/group_step.md
index 0aeb776ba1..ce2730099f 100644
--- a/pages/pipelines/configure/step_types/group_step.md
+++ b/pages/pipelines/configure/step_types/group_step.md
@@ -41,14 +41,14 @@ Required attributes:
group |
- Name of the group in the UI. In YAML, if you don't want a label, pass a `~`. Can also be provided in the `label` attribute if `null` is provided to the `group` attribute.
+ Name of the group in the UI. In YAML, if you don't want a label, pass a `~`. Can also be provided in the `label` attribute if `null` is provided to the `group` attribute.
Type: string or null
|
steps |
- A list of steps in the group; at least 1 step is required. Allowed step types: wait, trigger, command/commands, block, input.
+ A list of steps in the group; at least 1 step is required. Allowed step types: wait, trigger, command/commands, block, input.
Type: array
|
@@ -60,52 +60,54 @@ Optional attributes:
allow_dependency_failure |
- Whether to continue to run this step if any of the steps named in the depends_on attribute fail.
+ Whether to continue to run this step if any of the steps named in the depends_on attribute fail.
Default: false
|
depends_on |
- A list of step or group keys that this step depends on. This step or group will only run after the named steps have completed. See managing step dependencies for more information.
+ A list of step or group keys that this step depends on. This step or group will only run after the named steps have completed. See managing step dependencies for more information.
Example: "test-suite"
|
if |
- A boolean expression that omits the step when false. See Using conditionals for supported expressions.
+ A boolean expression that omits the step when false. See Using conditionals for supported expressions.
Example: build.message != "skip me"
|
key |
- A unique string to identify the step, block, or group. Alias: `identifier` or `id`.
- Example: "test-suite"
+ A unique string to identify the step, block, or group.
+ Keys can not have the same pattern as a UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
+ Example: "test-suite"
+ Alias: identifier
|
label |
- The label that will be displayed in the pipeline visualisation in Buildkite (name of the group in the UI). Supports emoji.
- Example: "\:hammer\: Tests" will be rendered as "🔨 Tests"
+ The label that will be displayed in the pipeline visualisation in Buildkite (name of the group in the UI). Supports emoji.
+ Example: "\:hammer\: Tests" will be rendered as ":hammer: Tests"
|
notify |
- Allows you to trigger build notifications to different services. You can also choose to conditionally send notifications based on pipeline events.
- Example: "github_commit_status:"
+ Allows you to trigger build notifications to different services. You can also choose to conditionally send notifications based on pipeline events.
+ Example: "github_commit_status:"
|
skip |
Whether to skip this step or not. Passing a string provides a reason for skipping this command. Passing an empty string is equivalent to false.
- Note: Skipped steps will be hidden in the pipeline view by default, but can be made visible by toggling the 'Skipped jobs' icon.
- Example: true
- Example: false
+ Note: Skipped steps will be hidden in the pipeline view by default, but can be made visible by toggling the 'Skipped jobs' icon.
+ Example: true
+ Example: false
Example: "My reason"
|
diff --git a/pages/pipelines/configure/step_types/input_step.md b/pages/pipelines/configure/step_types/input_step.md
index bc63528dcb..0bb008ba42 100644
--- a/pages/pipelines/configure/step_types/input_step.md
+++ b/pages/pipelines/configure/step_types/input_step.md
@@ -55,50 +55,52 @@ Optional attributes:
prompt |
- The instructional message displayed in the dialog box when the step is activated.
- Example: "Release to production?"
+ The instructional message displayed in the dialog box when the step is activated.
+ Example: "Release to production?"
Example: "Fill out the details for this release"
|
fields |
- A list of input fields required to be filled out before the step will be marked as passed.
+ A list of input fields required to be filled out before the step will be marked as passed.
Available input field types: text, select
|
branches |
- The branch pattern defining which branches will include this input step in their builds.
+ The branch pattern defining which branches will include this input step in their builds.
Example: "main stable/*"
|
if |
- A boolean expression to restrict the running of the step. See Using conditionals for supported expressions.
+ A boolean expression to restrict the running of the step. See Using conditionals for supported expressions.
Example: build.message != "skip me"
|
depends_on |
- A list of step keys that this step depends on. This step will only proceed after the named steps have completed. See managing step dependencies for more information.
+ A list of step keys that this step depends on. This step will only proceed after the named steps have completed. See managing step dependencies for more information.
Example: "test-suite"
|
key |
- A unique string to identify the input step.
- Example: "test-suite"
+ A unique string to identify the input step.
+ Keys can not have the same pattern as a UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
+ Example: "test-suite"
+ Alias: identifier
|
allow_dependency_failure |
- Whether to continue to proceed past this step if any of the steps named in the depends_on attribute fail.
+ Whether to continue to proceed past this step if any of the steps named in the depends_on attribute fail.
Default: false
|
@@ -121,7 +123,7 @@ Required attributes:
key |
- The meta-data key that stores the field's input (using the buildkite-agent meta-data command)
+ The meta-data key that stores the field's input (using the buildkite-agent meta-data command)
The key may only contain alphanumeric characters, slashes, dashes, or underscores.
Example: "release-name"
|
@@ -143,28 +145,28 @@ Optional attributes:
text |
- The text input name.
+ The text input name.
Example: "Release Name"
|
hint |
- The explanatory text that is shown after the label.
+ The explanatory text that is shown after the label.
Example: "What's the code name for this release? \:name_badge\:"
|
required |
- A boolean value that defines whether the field is required for form submission.
+ A boolean value that defines whether the field is required for form submission.
Default value: true
|
default |
- The value that is pre-filled in the text field.
+ The value that is pre-filled in the text field.
Example: "Flying Dolphin"
|
@@ -190,7 +192,7 @@ Required attributes:
key |
- The meta-data key that stores the field's input (using the buildkite-agent meta-data command)
+ The meta-data key that stores the field's input (using the buildkite-agent meta-data command)
The key may only contain alphanumeric characters, slashes, dashes, or underscores.
Example: "release-stream"
|
@@ -198,8 +200,8 @@ Required attributes:
options |
- The list of select field options.
- For 6 or less options they'll be displayed as radio buttons, otherwise they'll be displayed in a dropdown box.
+ The list of select field options.
+ For 6 or less options they'll be displayed as radio buttons, otherwise they'll be displayed in a dropdown box.
If selecting multiple options is permitted the options will be displayed as checkboxes.
|
@@ -211,14 +213,14 @@ Each select option has the following _required_ attributes:
label |
- The text displayed for the option.
+ The text displayed for the option.
Example: "Stable"
|
value |
- The value to be stored as meta-data (to be later retrieved using the buildkite-agent meta-data command)
+ The value to be stored as meta-data (to be later retrieved using the buildkite-agent meta-data command)
Example: "stable"
|
@@ -244,31 +246,31 @@ Optional attributes:
hint |
- The text displayed directly under the select field's label.
+ The text displayed directly under the select field's label.
Example: "Which release stream does this belong in? \:fork\:"
|
required |
- A boolean value that defines whether the field is required for form submission.
- When this value is set to false and users can only select one option, the options display in a dropdown menu, regardless of how many options there are.
+ A boolean value that defines whether the field is required for form submission.
+ When this value is set to false and users can only select one option, the options display in a dropdown menu, regardless of how many options there are.
Default: true
|
multiple |
- A boolean value that defines whether multiple options may be selected.
- When multiple options are selected, they are delimited in the meta-data field by a line break (\n)
+ A boolean value that defines whether multiple options may be selected.
+ When multiple options are selected, they are delimited in the meta-data field by a line break (\n)
Default: false
|
default |
- The value of the option or options that will be pre-selected.
- When multiple is enabled, this can be an array of values to select by default.
+ The value of the option or options that will be pre-selected.
+ When multiple is enabled, this can be an array of values to select by default.
Example: "beta"
|
diff --git a/pages/pipelines/configure/step_types/trigger_step.md b/pages/pipelines/configure/step_types/trigger_step.md
index 4cd8859e37..f92d98a73d 100644
--- a/pages/pipelines/configure/step_types/trigger_step.md
+++ b/pages/pipelines/configure/step_types/trigger_step.md
@@ -39,7 +39,7 @@ Required attributes:
trigger |
- The slug of the pipeline to create a build. You can find it in the URL of your pipeline, and it corresponds to the name of the pipeline, converted to kebab-case.
+ The slug of the pipeline to create a build. You can find it in the URL of your pipeline, and it corresponds to the name of the pipeline, converted to kebab-case.
Example: "another-pipeline"
|
@@ -58,43 +58,52 @@ Optional attributes:
label |
- The label that will be displayed in the pipeline visualisation in Buildkite. Supports emoji.
- Example: "\:rocket\: Deploy"
+ The label that will be displayed in the pipeline visualisation in Buildkite. Supports emoji.
+ Example: "\:rocket\: Deploy"
|
async |
- If set to true the step will immediately continue, regardless of the success of the triggered build. If set to false the step will wait for the triggered build to complete and continue only if the triggered build passed.
- Note that when async is set to true, as long as the triggered build starts, the original pipeline will show that as successful. The original pipeline does not get updated after subsequent steps or after the triggered build completes.
+ If set to true the step will immediately continue, regardless of the success of the triggered build. If set to false the step will wait for the triggered build to complete and continue only if the triggered build passed.
+ Note that when async is set to true, as long as the triggered build starts, the original pipeline will show that as successful. The original pipeline does not get updated after subsequent steps or after the triggered build completes.
Default: false
|
branches |
- The branch pattern defining which branches will include this step in their builds.
+ The branch pattern defining which branches will include this step in their builds.
Example: "main stable/*"
|
if |
- A boolean expression that omits the step when false. See Using conditionals for supported expressions.
+ A boolean expression that omits the step when false. See Using conditionals for supported expressions.
Example: build.message != "skip me"
|
depends_on |
- A list of step keys that this step depends on. This step will only run after the named steps have completed. See managing step dependencies for more information.
+ A list of step keys that this step depends on. This step will only run after the named steps have completed. See managing step dependencies for more information.
Example: "test-suite"
|
+
+ key |
+
+ A unique string to identify the trigger step.
+ Keys can not have the same pattern as a UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
+ Example: "trigger-deploy"
+ Alias: identifier
+ |
+
allow_dependency_failure |
- Whether to continue to run this step if any of the steps named in the depends_on attribute fail.
+ Whether to continue to run this step if any of the steps named in the depends_on attribute fail.
Default: false
|
@@ -102,17 +111,17 @@ Optional attributes:
skip |
Whether to skip this step or not. Passing a string provides a reason for skipping this command. Passing an empty string is equivalent to false.
- Note: Skipped steps will be hidden in the pipeline view by default, but can be made visible by toggling the 'Skipped jobs' icon.
- Example: true
- Example: false
+ Note: Skipped steps will be hidden in the pipeline view by default, but can be made visible by toggling the 'Skipped jobs' icon.
+ Example: true
+ Example: false
Example: "My reason"
|
|
soft_fail |
- When true, failure of the triggered build will not cause the triggering build to fail.
- Default: false
+ When true, failure of the triggered build will not cause the triggering build to fail.
+ Default: false
|
@@ -123,38 +132,38 @@ Optional `build` attributes:
message |
- The message for the build. Supports emoji.
- Default: the label of the trigger step.
- Example: "Triggered build"
+ The message for the build. Supports emoji.
+ Default: the label of the trigger step.
+ Example: "Triggered build"
|
commit |
- The commit hash for the build.
- Default: "HEAD"
- Example: "ca82a6d"
+ The commit hash for the build.
+ Default: "HEAD"
+ Example: "ca82a6d"
|
branch |
- The branch for the build.
- Default: The triggered pipeline's default branch.
- Example: "production"
+ The branch for the build.
+ Default: The triggered pipeline's default branch.
+ Example: "production"
|
meta_data |
- A map of meta-data for the build.
+ A map of meta-data for the build.
Example: release-version: "1.1"
|
env |
- A map of environment variables for the build.
+ A map of environment variables for the build.
Example: RAILS_ENV: "test"
|
diff --git a/pages/pipelines/configure/step_types/wait_step.md b/pages/pipelines/configure/step_types/wait_step.md
index 10420398a4..2768cf7b35 100644
--- a/pages/pipelines/configure/step_types/wait_step.md
+++ b/pages/pipelines/configure/step_types/wait_step.md
@@ -17,28 +17,37 @@ Optional attributes:
continue_on_failure |
- Run the next step, even if the previous step has failed.
+ Run the next step, even if the previous step has failed.
Example: true
|
if |
- A boolean expression that omits the step when false. See Using conditionals for supported expressions.
+ A boolean expression that omits the step when false. See Using conditionals for supported expressions.
Example: build.message != "skip me"
|
depends_on |
- A list of step keys that this step depends on. This step will only proceed after the named steps have completed. See managing step dependencies for more information.
+ A list of step keys that this step depends on. This step will only proceed after the named steps have completed. See managing step dependencies for more information.
Example: "test-suite"
|
+
+ key |
+
+ A unique string to identify the wait step.
+ Keys can not have the same pattern as a UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
+ Example: "confirmation"
+ Alias: identifier
+ |
+
allow_dependency_failure |
- Whether to continue to proceed past this step if any of the steps named in the depends_on attribute fail.
+ Whether to continue to proceed past this step if any of the steps named in the depends_on attribute fail.
Default: false
|