Cloud customer?
Start for Free >
Upgrade in MyJFrog >
What's New in Cloud >

Search





Overview

Conditional workflow in Pipelines enables you to choose if a step executes or skips based on certain conditions set for the previous upstream step. This means, when the workflow reaches a conditional step, it can choose different workflow paths based on the step’s status. This provides more flexibility in the execution logic of a pipeline.

Page Contents


Step Status Conditional Workflow

With the status conditional workflow, you can configure a step to execute only if an input step’s status, during its current run, is satisfied. You can configure any number of statuses for a step.

YAML Schema
    steps:
      - name: <step_name>
        type: <step_type>
        configuration:
          inputSteps:
            - name: <step_name>
              status:
                - <terminal_status>
                - <terminal_status>
                - <terminal_status>

It is important to note that only the status of an input step in the current run is considered for conditional workflows. If a step is not part of the current run, it is always assumed that the condition for that input step is met.


Adding Conditional Workflow for Steps

To add a conditional workflow for a step:

  1. In the inputSteps section of a step, add the status property.
  2. Add any of these values:
    • success
    • failure
    • error
    • cancelled
    • skipped
    • unstable
    • timeout

Ensure that the values are in lowercase and use the same spelling as shown above. Any deviation from this will cause the pipeline source sync to fail.


Example: In this example:

  • step_B has only one status: success
  • step_c has multiple statuses: failure, skipped, cancelled
      - name: step_A
        type: Bash
        configuration:
          inputSteps:
            - name: step_B
              status:
                - success
            - name: step_C
              status:
                - failure
                - skipped
                - cancelled

Viewing Run Logs

When you run a pipeline, in addition to the other logs, the logs for steps with conditional workflow provide information about the skipped steps.

To view these logs, go to the Pipeline Run Logs view, click the skipped step to display the logs for the current run. 


Examples

Example 1

In this example:

  • Step B is triggered only if step A succeeds (default behavior), and step C is triggered only if step A is in failed, error, or timeout status.
  • Step B does not need any special configuration as the default behavior is to trigger a dependent step if the previous step succeeds. 
  • Step A also does not need any special configuration since the step itself does not decide the downstream workflow path.

YAML
  - name: demo_conditional
    steps:
      - name: step_A
        type: Bash
        configuration:
          inputResources:
            - name: script_conditional
        execution:
          onExecute:
            - echo "Executing step_A"
            - printenv
     
      - name: step_B
        type: Bash
        configuration:
          inputSteps:
            - name: step_A
        execution:
          onExecute:
            - echo "Executing step_B"
            - printenv

      - name: step_C
        type: Bash
        configuration:
          inputSteps:
            - name: step_A
              status:
                - failure
                - error
                - timeout
        execution:
          onExecute:
            - echo "Executing step_C"
            - printenv


Example 2

In this example, Step S is triggered if Step Q succeeds and Step R fails. However, if both Step Q and Step R succeed or fail during the run, Step S is not triggered and it is skipped.

YAML
      - name: step_S
        type: Bash
        configuration:
          inputSteps:
            - name: step_Q
              status:
                - success
            - name: step_R
              status:
                - failure
        execution:
          onExecute:
            - echo "Executing step_S"
            - printenv

Example 3

In this example, Step O is triggered if Step M succeeds and Step N fails. However, since Step N is not part of the current run, Step O is triggered when Step M succeeds and Step N's status is ignored. 

YAML
      - name: step_O
        type: Bash
        configuration:
          inputSteps:
            - name: step_M
              status:
                - success
            - name: step_N
              status:
                - failure
        execution:
          onExecute:
            - echo "Executing step_O"
            - printenv

Example 4 - Using Environment Variable

The step_<inputStepName>_statusName, which is an environment variable that is automatically made available at runtime, can be used in conjunction with conditional workflows. This step_<inputStepName>_statusName environment variable is useful for fetching the status of any input step, especially when working with Jenkins.

YAML
resources:
  - name: script_gh
    type: GitRepo
    configuration:
      path: jfrog/sample-script
      gitProvider: myGithub
      branches:
        include: ^{{gitBranch}}$

pipelines:     
  - name: simple_jenkins_demo
    steps:
      - name: jenkins
        type: Jenkins
        configuration:
          inputResources:
            - name: script_gh
          jenkinsJobName: testPipeline
          integrations:
            - name: myJenkins
      
      - name: step_A
        type: Bash
        configuration:
          inputSteps:
            - name: jenkins
              status:
                - failure
                - error
                - timeout
        execution:
          onExecute:
            - echo "Executing step_A"
            - if [ $step_jenkins_statusName == "failure" ]; then  echo "Do something"; fi
            - if [ $step_jenkins_statusName == "error" ]; then  echo "Do something else"; fi
     
      - name: simple_conditional_B
        type: Bash
        configuration:
          inputSteps:
            - name: jenkins
              status:
                - failure
                - error
        execution:
          onExecute:
            - echo "Executing simple_conditional_B"
            - printenv
  • No labels
Copyright © 2021 JFrog Ltd.