Running Pipelines

3 minute read

This section shows how to run a pipeline or restart a failed pipeline run. It also has examples showing different pipeline run scenarios.

You can also use Perl API commands through ec-perl and ectool, REST API commands, and DSL scripts to model and run pipelines. For more information, see API Guide.

Starting from the Pipelines list:

  1. Click the Run button on the pipeline you wish to start. Optionally you can choose a previously run pipeline.

  2. If the pipeline has required parameters to run the pipeline, enter the parameter values. If you are rerunning a pipeline, it will use its parameter values from the previous run or use new values you provide.

  3. View the real-time progress of the pipeline run.

    • Progress is shown in percentage complete.

    • Tasks requiring a response are denoted by the following:

      • —Manual attention needed, and the current user is on the approver’s list.

      • —Manual attention needed, and the current user is not on the approver’s list.

        The following example shows that exit gate of the QA stage and/or the entry gate of the PROD stage has gate approvals that need to be approved before the pipeline can enter the PROD stage.

        1

        Click Response Required to see the gate approvals and the required reviewers.

        2

        Click to see the list required reviewers, in this case, for the DEV stage entry gate.

        For the entry gate of the QA stage, the required approvers are the user named john and then the group named DefectTrackingAdmins.

  4. Click in a stage to see the details of the pipeline stage summary.

    For examples of pipeline stage summaries, see Pipeline Stage Summary .

  5. Click View previous Pipeline Runs to see the previous runs of this pipeline.

Pre-running a Task

For tasks configured to run out of order, a task can be pre run. Only the specified task is run; execution does not continue to following tasks and stages. When pipeline run execution reaches a task which has already run, the pre-run task is skipped. If the pre-run task is still running then the pipeline execution waits for it to complete and then continues on to the following tasks. A task can be pre-run if:

  • It is configured to run out of order. See Configuring Pre-Run Tasks .

  • All pre-conditions, on both the task itself and a stage/gate containing the task, must evaluate to true.

  • No pending runtime wait dependencies on the task itself or stage/gate containing the task.

  • If configured with wait for start date, the planned start date requirement for stage/gate and task is met.

Error handling on the specified task has no impact on its pre-run execution: the task runs and stops regardless of success or failure. However, when the regular execution reaches a pre-run task that has failed and has error handling defined as:

  • Stop on error —Pipeline execution stops.

  • Continue on error —Pipeline execution continues to the next task.

  • Retry —Task is retried.

To pre run a task, locate it in the pipeline run and select Pre-Run Task from the task’s Actions menu.

A completed pre-run task is denoted with a dot and its containing stage is denoted with a multi-colored header:

Restarting a Failed Pipeline Run

A restart capability for failed pipeline runs lets you configure a pipeline run to restart from the last failed task after you update the task definition and fix the issues that caused the failure. The user restarting the pipeline must have execute privileges on all tasks, rules, and stages after the task that is being restarted, including the failed task itself.

A pipeline run is restartable

  • If the last executed task in the run has a failure outcome, provided its error handling is not configured as Continue on Error. Any prior failed tasks—in the same or previous stages or gates—with Continue on Error error handling enabled are ignored.

  • If the last stage has no tasks in it and it is in error because of a run condition/precondition evaluation error.

To restart a failed pipeline, select Restart from failure from the pipeline run’s Actions menu. Restarting a pipeline prompts you enter a comment about the restart.

Viewing the Details of a Pipeline Run

Click View previous Pipeline Runs to see the previous runs of this pipeline.

The previous pipeline runs appear.

To see specific pipeline run details, click the Open Dialog arrow on the right of it’s row.