Skip to content

Commit 82cd368

Browse files
authored
Merge pull request buildkite#1809 from buildkite/doc-515-upd-group-step-attributes
Adds if and skip attributes
2 parents 9c7f29b + 302be18 commit 82cd368

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

pages/pipelines/group_step.md.erb

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,13 @@ _Optional attributes:_
7373
<em>Example:</em> <code>"test-suite"</code>
7474
</td>
7575
</tr>
76+
<tr>
77+
<td><code>if</code></td>
78+
<td>
79+
A boolean expression that omits the step when false. See <a href="/docs/pipelines/conditionals">Using conditionals</a> for supported expressions.<br>
80+
<em>Example:</em> <code>build.message != "skip me"</code>
81+
</td>
82+
</tr>
7683
<tr>
7784
<td><code>key</code></td>
7885
<td>
@@ -94,6 +101,16 @@ _Optional attributes:_
94101
<em>Example:</em> <code>"github_commit_status:"</code><br>
95102
</td>
96103
</tr>
104+
<tr>
105+
<td><code>skip</code></td>
106+
<td>
107+
Whether to skip this step or not. Passing a string provides a reason for skipping this command. Passing an empty string is equivalent to <code>false</code>.
108+
Note: Skipped steps will be hidden in the pipeline view by default, but can be made visible by toggling the 'Skipped jobs' icon.<br>
109+
<em>Example:</em> <code>true</code><br>
110+
<em>Example:</em> <code>false</code><br>
111+
<em>Example:</em> <code>"My reason"</code>
112+
</td>
113+
</tr>
97114
</table>
98115

99116
## Parallel groups

0 commit comments

Comments
 (0)