How to use Workflow Run Rules

​

General overview of Workflow Run Rules

1

First, you need to create a Rule for your team. Please be aware that all rules will apply to all runs on all branches.

Only create rules that the team as a whole needs

Navigate to Runs > Rules.

Click the Create rule button.

You will then be able to define which workflows should run before which. Please notice that you can also define this by the groups or tags that the workflows belong to. In the above rule, I have chosen to run all workflows that have the Auth tag, before Dependent Test and Failing Test

Please be aware of creating loops within rules. The UI will prevent you from doing this, but it is good to be thinking of this ahead of time. Heres an example: I have two rules (Rule A) and (Rule B). Rule A runs a workflow Start before all CI tags, Rule B runs a workflow Delete after all CI tags. It is important that you do not add the CI tag to the Start or Delete workflows, as that would create a loop in the rules. If you do accidentally create a loop, the UI will notify you

There is also a checkbox that says Fail workflows if any priors fail this checkbox determines what should happen to dependent workflows when a prerequisite fails. If this checkbox is not checked, the dependent workflows will still run.

Note that only active workflows can appear in Triggered Suites, so if you are trying to run a selected workflow and it’s in Draft it won’t actually run before the tests in the suite.

2

After defining your rules, you will sometimes need to access information from one of the workflows that needs to run first. This can be done by using the setOutput function available in all runners.You can use the setOutput function like so:

JSON

Copy

Ask AI

// General signature
setOutput(key, value);

// The value can be anything serializable, including objects and arrays.
setOutput("teamId", teamId);
setOutput("auth", { token, userId });

// To set additional output properties, call setOutput multiple times.

Note that the key used in the setOutput function must be unique. If you use the same key again it will overwrite the previous key value pair

3

You can then access the output in runs that depend on the above workflow by accessing the workflowInputs object:

Copy

Ask AI

const { auth, teamId } = workflowInputs;

4

When a workflow that has dependencies fails and the Fail workflows if any priors fail checkbox is selected for the rule, all workflows that require that workflow will immediately fail.

There will also be a failure reason surfaced in the run result

​

Common edge cases

• Imagine you have a workflow you need to run before all CI flows, and a workflow you need to run after all CI flows. More or less a beforeAll and afterAll, if you are familiar with jest. You just created some rules that look like the ones below: