Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve/Standardize alias #3011

Merged
merged 13 commits into from
Nov 26, 2024
Merged

Improve/Standardize alias #3011

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
40a11d4
Improve/Standardize `alias` in `command_step`
thejcannon Nov 24, 2024
28d101c
Update block_step.md
thejcannon Nov 24, 2024
d2247a8
Update group_step.md
thejcannon Nov 24, 2024
7480186
Update input_step.md
thejcannon Nov 24, 2024
d0fb4ea
Update trigger_step.md
thejcannon Nov 24, 2024
f806568
Update wait_step.md
thejcannon Nov 24, 2024
aed806e
Update command_step.md
thejcannon Nov 24, 2024
e41ab1d
Update block_step.md
thejcannon Nov 24, 2024
2b19227
Update group_step.md
thejcannon Nov 24, 2024
28ad2dd
Update input_step.md
thejcannon Nov 24, 2024
1949a3f
Update trigger_step.md
thejcannon Nov 24, 2024
047ff0d
Update wait_step.md
thejcannon Nov 24, 2024
5861808
Update pages/pipelines/command_step.md
thejcannon Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion pages/pipelines/block_step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,9 @@ Optional attributes:
<tr>
<td><code>key</code></td>
<td>
<p>A unique string to identify the block step.</p>
<p>A unique string to identify the block step.<br>Keys can not have the same pattern as a UUID (<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>).</p>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why bloack_step.md uses <p> for all the table cells, but none of the others do 🤔

Copy link
Contributor

@gilesgas gilesgas Nov 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question @thejcannon , and thanks for pointing this out. I'm not sure why this is the case either.

I'll remove these <p></p> elements from this table then; this also appears to affect about 1/2 the HTML tables on this page.

<p><em>Example:</em> <code>"test-suite"</code></p>
<p><em>Alias:</em> <code>identifier</code></p>
</td>
</tr>
<tr>
Expand Down
9 changes: 5 additions & 4 deletions pages/pipelines/command_step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@ Required attributes:
<tr>
<td><code>command</code></td>
<td>
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 <code>commands</code>.<br>
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.<br>
<em>Example:</em> <code>"build.sh"</code><br>
<em>Example:</em><br><code>- "npm install"</code><br><code>- "tests.sh"</code>
<em>Example:</em><br><code>- "npm install"</code><br><code>- "tests.sh"</code><br>
<em>Alias:</em>em> <code>commands</code>
thejcannon marked this conversation as resolved.
Show resolved Hide resolved
</td>
</tr>
</table>
Expand Down Expand Up @@ -118,9 +119,9 @@ Optional attributes:
<tr>
<td><code>key</code></td>
<td>
A unique string to identify the step. The value is available in the <code>BUILDKITE_STEP_KEY</code> <a href="/docs/pipelines/environment-variables">environment variable</a>.<br>
A unique string to identify the command step. The value is available in the <code>BUILDKITE_STEP_KEY</code> <a href="/docs/pipelines/environment-variables">environment variable</a>.<br>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Keys can not have the same pattern as a UUID (<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>).<br>
<em>Example:</em> <code>"linter"</code>
<em>Example:</em> <code>"linter"</code><br>
<em>Alias:</em> <code>identifier</code>
</td>
</tr>
Expand Down
5 changes: 3 additions & 2 deletions pages/pipelines/group_step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,9 @@ Optional attributes:
<tr>
<td><code>key</code></td>
<td>
A unique string to identify the step, block, or group. Alias: `identifier` or `id`.<br>
<em>Example:</em> <code>"test-suite"</code>
A unique string to identify the step, block, or group.<br>Keys can not have the same pattern as a UUID (<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>).<br>
<em>Example:</em> <code>"test-suite"</code><br>
<em>Alias:</em> <code>identifier</code>
</td>
</tr>
<tr>
Expand Down
5 changes: 3 additions & 2 deletions pages/pipelines/input_step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,9 @@ Optional attributes:
<tr>
<td><code>key</code></td>
<td>
<p>A unique string to identify the input step.</p>
<p><em>Example:</em> <code>"test-suite"</code></p>
A unique string to identify the input step.<br>Keys can not have the same pattern as a UUID (<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>).<br>
<em>Example:</em> <code>"test-suite"</code><br>
<em>Alias:</em> <code>identifier</code>
</td>
</tr>
<tr>
Expand Down
8 changes: 8 additions & 0 deletions pages/pipelines/trigger_step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,14 @@ Optional attributes:
<em>Example:</em> <code>"test-suite"</code>
</td>
</tr>
<tr>
<td><code>key</code></td>
<td>
A unique string to identify the trigger step.<br>Keys can not have the same pattern as a UUID (<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>).<br>
<em>Example:</em> <code>"trigger-deploy"</code><br>
<em>Alias:</em> <code>identifier</code>
</td>
</tr>
<tr>
<td><code>allow_dependency_failure</code></td>
<td>
Expand Down
8 changes: 8 additions & 0 deletions pages/pipelines/wait_step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ Optional attributes:
<em>Example:</em> <code>"test-suite"</code>
</td>
</tr>
<tr>
<td><code>key</code></td>
<td>
A unique string to identify the wait step.<br>Keys can not have the same pattern as a UUID (<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>).<br>
<em>Example:</em> <code>"confirmation"</code><br>
<em>Alias:</em> <code>identifier</code>
</td>
</tr>
<tr>
<td><code>allow_dependency_failure</code></td>
<td>
Expand Down
Loading