From 40a11d401cbdcf253dfe519985cb649910ec82b2 Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:31:42 -0800 Subject: [PATCH 01/13] Improve/Standardize `alias` in `command_step` --- pages/pipelines/command_step.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/pages/pipelines/command_step.md b/pages/pipelines/command_step.md index 2ed2be2b66..844dc48af7 100644 --- a/pages/pipelines/command_step.md +++ b/pages/pipelines/command_step.md @@ -22,9 +22,10 @@ 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.
+ 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" + Example:
- "npm install"
- "tests.sh"
+ Alias:em> commands @@ -120,7 +121,7 @@ Optional attributes: 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" + Example: "linter"
Alias: identifier From 28d101cf602b1889342e6934a586cf426180c4e5 Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:35:11 -0800 Subject: [PATCH 02/13] Update block_step.md --- pages/pipelines/block_step.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pages/pipelines/block_step.md b/pages/pipelines/block_step.md index 3ce7c602d9..886d043942 100644 --- a/pages/pipelines/block_step.md +++ b/pages/pipelines/block_step.md @@ -102,8 +102,9 @@ Optional attributes: key -

A unique string to identify the block step.

+

A unique string to identify the block step.

Example: "test-suite"

+

Alias: identifier

From d2247a87ce4287518d3cb66f3d1a831fcd8b1deb Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:36:44 -0800 Subject: [PATCH 03/13] Update group_step.md --- pages/pipelines/group_step.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pages/pipelines/group_step.md b/pages/pipelines/group_step.md index 3e9a4bd876..3dcaa5476c 100644 --- a/pages/pipelines/group_step.md +++ b/pages/pipelines/group_step.md @@ -81,8 +81,9 @@ Optional attributes: 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.
+ Example: "test-suite"
+ Alias: identifier From 7480186c6efee0395880dcbca0ed37c31d2ea78d Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:37:49 -0800 Subject: [PATCH 04/13] Update input_step.md --- pages/pipelines/input_step.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pages/pipelines/input_step.md b/pages/pipelines/input_step.md index 51e10aaa13..01663206fc 100644 --- a/pages/pipelines/input_step.md +++ b/pages/pipelines/input_step.md @@ -91,8 +91,9 @@ Optional attributes: key -

A unique string to identify the input step.

-

Example: "test-suite"

+ A unique string to identify the input step.
+ Example: "test-suite"
+ Alias: identifier From d0fb4ea17742cf178e5e01c2c4d67d18b5037f48 Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:41:13 -0800 Subject: [PATCH 05/13] Update trigger_step.md --- pages/pipelines/trigger_step.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/pages/pipelines/trigger_step.md b/pages/pipelines/trigger_step.md index 5ec13feaee..d7597fd05c 100644 --- a/pages/pipelines/trigger_step.md +++ b/pages/pipelines/trigger_step.md @@ -91,6 +91,14 @@ Optional attributes: Example: "test-suite" + + key + + A unique string to identify the trigger step.
+ Example: "trigger-deploy"
+ Alias: identifier + + allow_dependency_failure From f8065684da023a36b047c991fa853f341ada5fc5 Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:41:51 -0800 Subject: [PATCH 06/13] Update wait_step.md --- pages/pipelines/wait_step.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/pages/pipelines/wait_step.md b/pages/pipelines/wait_step.md index a898eb98d6..0c98ee2e20 100644 --- a/pages/pipelines/wait_step.md +++ b/pages/pipelines/wait_step.md @@ -35,6 +35,14 @@ Optional attributes: Example: "test-suite" + + key + + A unique string to identify the wait step.
+ Example: "confirmation"
+ Alias: identifier + + allow_dependency_failure From aed806ecf2b9a3c49620f3ee42c96736aab2dd64 Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:42:39 -0800 Subject: [PATCH 07/13] Update command_step.md --- pages/pipelines/command_step.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/pipelines/command_step.md b/pages/pipelines/command_step.md index 844dc48af7..8dcd66a9ce 100644 --- a/pages/pipelines/command_step.md +++ b/pages/pipelines/command_step.md @@ -119,7 +119,7 @@ Optional attributes: key - A unique string to identify the step. The value is available in the BUILDKITE_STEP_KEY environment variable.
+ 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 From e41ab1d4580d9d8ecb745014ca8036572a7ea9cb Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:44:13 -0800 Subject: [PATCH 08/13] Update block_step.md --- pages/pipelines/block_step.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/pipelines/block_step.md b/pages/pipelines/block_step.md index 886d043942..7d13670ed7 100644 --- a/pages/pipelines/block_step.md +++ b/pages/pipelines/block_step.md @@ -102,7 +102,7 @@ Optional attributes: key -

A unique string to identify the block step.

+

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

From 2b192273c06ef0cdf0f4c71e6280a97441711cde Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:44:35 -0800 Subject: [PATCH 09/13] Update group_step.md --- pages/pipelines/group_step.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/pipelines/group_step.md b/pages/pipelines/group_step.md index 3dcaa5476c..5cb915bc49 100644 --- a/pages/pipelines/group_step.md +++ b/pages/pipelines/group_step.md @@ -81,7 +81,7 @@ Optional attributes: key - A unique string to identify the step, block, or group.
+ 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 From 28ad2dd57328ac7c7451649faab6b36edcf300e2 Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:44:50 -0800 Subject: [PATCH 10/13] Update input_step.md --- pages/pipelines/input_step.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/pipelines/input_step.md b/pages/pipelines/input_step.md index 01663206fc..503620a9e0 100644 --- a/pages/pipelines/input_step.md +++ b/pages/pipelines/input_step.md @@ -91,7 +91,7 @@ Optional attributes: key - A unique string to identify the input step.
+ 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 From 1949a3f8c0828cfcef7212264f3a51ea0706d890 Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:45:15 -0800 Subject: [PATCH 11/13] Update trigger_step.md --- pages/pipelines/trigger_step.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/pipelines/trigger_step.md b/pages/pipelines/trigger_step.md index d7597fd05c..25d9372f78 100644 --- a/pages/pipelines/trigger_step.md +++ b/pages/pipelines/trigger_step.md @@ -94,7 +94,7 @@ Optional attributes: key - A unique string to identify the trigger step.
+ 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 From 047ff0d28f6d8716de0024077b589c05f81e34cd Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Sun, 24 Nov 2024 04:45:28 -0800 Subject: [PATCH 12/13] Update wait_step.md --- pages/pipelines/wait_step.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/pipelines/wait_step.md b/pages/pipelines/wait_step.md index 0c98ee2e20..d9ba6232e3 100644 --- a/pages/pipelines/wait_step.md +++ b/pages/pipelines/wait_step.md @@ -38,7 +38,7 @@ Optional attributes: key - A unique string to identify the wait step.
+ 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 From 5861808385291f5e7a237911ff6844a0902a584a Mon Sep 17 00:00:00 2001 From: Josh Cannon <3956745+thejcannon@users.noreply.github.com> Date: Mon, 25 Nov 2024 06:00:49 -0800 Subject: [PATCH 13/13] Update pages/pipelines/command_step.md --- pages/pipelines/command_step.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/pipelines/command_step.md b/pages/pipelines/command_step.md index 8dcd66a9ce..3f96d18e49 100644 --- a/pages/pipelines/command_step.md +++ b/pages/pipelines/command_step.md @@ -25,7 +25,7 @@ Required attributes: 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:em> commands + Alias: commands