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.

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

docs: conditional steps overview #748

Merged
merged 6 commits into from
Dec 10, 2022
Merged
Changes from 1 commit
Commits
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
8 changes: 4 additions & 4 deletions doc/configuring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -441,9 +441,9 @@ If any of them is missing or not set in current environment, the step will be ex
Conditional steps
---------------------

Conditional step is a :class:`Step` object, that has ``if_succeeded`` and/or ``if_failed`` parameters with other steps assigned.
If the conditional step succeed, then the step from the ``if_succeeded`` parameter will be executed.
If the conditional step fail, the step from the ``if_failed`` parameter will be executed instead.
Conditional step is a :class:`Step` object, that has ``if_succeeded`` or ``if_failed`` parameters with other steps assigned.
If the conditional step succeeds, then the step from the ``if_succeeded`` parameter will be executed.
If the conditional step fails, the step from the ``if_failed`` parameter will be executed instead.

Configuration example:

Expand Down Expand Up @@ -505,5 +505,5 @@ In general, conditional steps behave as any other regular steps, but here are so
* Only one branch step will be executed
* Both branches' artifacts will be checked for existence before the steps execution
* Artifacts collection or any other side-effects will not be triggered for non-executed branch step
* If chosen branch step is not set, nothing will happen (e.g. conditional step failed, but ``Step.if_failed`` was not set)
* If chosen branch step is not set, nothing will happen. E.g. conditional step failed, but ``Step.if_failed`` was not set
i-keliukh marked this conversation as resolved.
Show resolved Hide resolved
* Only one branch step will be counted for each conditional step at calculating steps numbering and total count