Skip to content

docs: better description for when.status filter #6517

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

Merged
6543 merged 6 commits into from
Apr 30, 2026
Merged

docs: better description for when.status filter #6517

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0d071df
docs: better description for when.status filter
6543 Apr 28, 2026
7c74f4e
new line
6543 Apr 28, 2026
e2483b9
new line via html tag
6543 Apr 28, 2026
b937c00
Merge branch 'main' into docs-when.status
6543 Apr 28, 2026
5aaedfc
ci.rerun()
6543 Apr 28, 2026
2e38dd8
Merge branch 'main' into docs-when.status
6543 Apr 29, 2026
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
9 changes: 8 additions & 1 deletion docs/docs/20-usage/20-workflow-syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,14 @@ when:

#### `status`

There are use cases for executing steps on failure, such as sending notifications for failed workflow/pipeline. Use the status constraint to execute steps even when the workflow fails:
By default, steps only run when the workflow has succeeded up to that point,<br>
which is equivalent to `status: [ success ]`.
Comment thread
qwerty287 marked this conversation as resolved.

The `status` filter lets you override this behavior.
The only accepted values are `success` and `failure`.

A common use case is executing a step on failure, such as sending notifications for a failed workflow/pipeline.
To run a step regardless of outcome, list both values:

```diff
steps:
Expand Down