Managing Your Pipelines

Use these tutorials to create, modify, upgrade, and run your pipelines.

Creating Pipelines

Before you begin:

A pipeline requires at least two jobs. To create jobs, see Creating Jobs.

  1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
    Your project library opens, listing the existing projects.

  2. Click a project in the list.
    The project opens on its job library.

    Navigate to your project

  3. Click The "Pipelines" page icon is represented by several connected jobs. Pipelines from the secondary navigation menu to open the project’s pipeline library.

  4. Click New pipeline to create a new pipeline.
    A page to create your pipeline opens.

  5. Enter a name and a description for your pipeline.

  6. Construct your pipeline by adding at least two jobs.

    1. Select Add job and chose a job from the list.
      A card containing basic information, such as name, technology, and job category, appears in the graph.

    2. Select Add job again and chose another job from the list.
      Another job card appears in the graph.

    3. Link the two jobs.

      pipeline create

    You can repeat these steps and add conditions between jobs to build more relevant pipelines as in the following example:

    pipeline example

    To add conditions, click Add condition when editing your pipeline and link it to jobs as in the image above.

    A condition must have at least one parent and one child.
  7. Configure the settings. You can add a scheduled run, email alerts, environment variables, and a release note.

  8. Click either:

    • Save pipeline to save your changes.

    • The kebab menu The kebab menu icon is three vertical dots.  Save & run to save your changes and automatically run your pipeline.

    • The cross close to exit the creation mode without saving your pipeline. A pop-in window appears with a progress bar: you can click the cross to exit faster or click Continue edition to cancel your cancellation.

To delete a pipeline, you can either:

  • Click delete Delete at the end of the corresponding pipeline row from the The "Pipelines" page icon is represented by several connected jobs. Pipelines page.

  • Click the kebab menu The kebab menu icon is three vertical dots.  delete Delete from the The "Overview" page icon is a square divided into several other squares. Overview page of the corresponding pipeline.

A confirmation message appears; Click Delete again to confirm the deletion. Be careful, there is no progress bar to cancel the deletion once it is confirmed.

Running and Stopping Pipelines

You can run or stop your pipelines manually, even when pipelines are in scheduled to run.

  1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
    Your project library opens, listing the existing projects.

  2. Click a project in the list.
    The project opens on its job library.

    Navigate to your project

  3. Click The "Pipelines" page icon is represented by several connected jobs. Pipelines from the secondary navigation menu to open the project’s pipeline library.

  4. You can either:

    • Click Run Run or Stop Stop in front of the desired pipeline from the library.

    • Open the pipeline details and start or stop the run from there.

      1. Click the desired pipeline to open its details.
        By default, the The "Overview" page icon is a square divided into several other squares. Overview page opens.

      2. Click either Run Run or Stop Stop depending of the current status of your pipeline.

        You can also access this command at the bottom of the secondary navigation menu from the The "Instances" page icon is three overlapping squares. Instances and The "Versions" page icon is a folder with an arrow pointing up. Versions page.

    The pipeline status changes depending on the outcome.

Modifying Pipeline Settings

After its creation, you can always modify your pipeline settings. You can access the settings from the pipeline The "Overview" page icon is a square divided into several other squares. Overview page or from its edit mode.

  1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
    Your project library opens, listing the existing projects.

  2. Click a project in the list.
    The project opens on its job library.

    Navigate to your project

  3. Click The "Pipelines" page icon is represented by several connected jobs. Pipeline from the secondary navigation menu to open the project’s pipeline library.

  4. From the list, click a pipeline to access its details.
    The pipeline The "Overview" page icon is a square divided into several other squares. Overview page opens.

  5. From the The "Overview" page icon is a square divided into several other squares. Overview page (a) or in edit Edit mode (b), click the desired setting to edit it:

    Pipeline settings from the "Overview" page.
    Figure 1. Pipeline Settings from the Overview Page
    Pipeline settings from the editing mode.
    Figure 2. Pipeline Settings in the Edit Mode
    • 1 - Name

    • 2 - Description

    • 3 - Scheduled Run

    • 4 - Email Alerts

    • 5 - Variables

    Names are mandatory, with a maximum of 255 characters, and unique within a project.

    Descriptions are optional and have no restrictions, but it is a good practice to keep them short and informative.

    Click the switch in the side panel of the setting to enable or disable it.

    There are two runtime types:

    • The manual run, which requires you to click Run to start the pipeline.

    • The scheduled run, which launches the pipeline according to the schedule you choose.

      Scheduled pipelines can also be started manually.

      The Scheduled run type has three schedule modes: Simple, Shortcut, and Expert.

      • In Simple mode, you can easily specify variables through the user interface. There are many possibilities.

        Screenshot of the settings for the scheduled run type in simple mode

      • In Shortcut mode, you can choose the recurrence of your run on an hourly, daily, weekly, monthly, or annual basis. All other settings are automatic.

        Screenshot of the settings for the scheduled run type in shortcut mode

      • In Expert mode, you can specify variables using the Cron format. The Cron time string consists of five values separated by spaces: [minute] [hour] [day of the month] [month] [day of the week]. They are based on the following information:

        Table 1. Cron format
        Descriptor Acceptable values

        Minute

        0 to 59, or *

        Hour

        0 to 23, or *

        Day of the month

        1 to 31, or *

        Month

        1 to 12, or *

        Day of the week

        0 to 7 (0 and 7 both represent Sunday), or *

        The Cron time string must contain entries for each character attribute. If you want to set a value using only minutes, you must have asterisk characters for the other four attributes that you are not configuring.

        Screenshot of the settings for the scheduled run type in expert mode

        Once you have finished scheduling your run, you will see the summary of your choice written below and the time of the next run.

    Click the switch in the side panel of the setting to enable or disable it.

    Alerts are optional and can be set to receive an email when the status of your pipeline changes. They can be sent to multiple email addresses to notify you of the following status changes:

    • queued requested Requested: the pipeline’s run has been requested and is being executed.

    • queued requested Queued: the pipeline is waiting for the necessary resources to be executed.

    • spinner Running: the pipeline is up and running.

    • fail Failed: the pipeline has crashed.

    • stop Stopping: the pipeline is stopping.

    • stop Stopped: the pipeline has stopped running.

    • success Succeeded: the pipeline has been successfully executed.

    • unknown Unknown: the pipeline no longer runs because an error has occurred.

    Click the switch in the side panel of the setting to enable or disable it.

    This setting can be used to:

    • Manage Environment Variables on the Fly

      You can create, modify, and delete pipeline environment variables on the fly from the Variables side panel. Changes made from this panel will update the pipeline settings env vars a Environment variables page accordingly.

      You do not have to enable the setting for this to work.
    • Transfer Variables Between Jobs During Pipeline Execution

      • When enabled settings env vars a, it allows you to transfer modified and created variables between jobs during pipeline execution. In addition, you can view a summary table of used, modified, and unchanged variables for each job in the pipeline The "Overview" page icon is a square divided into several other squares. Overview and The "Instances" page icon is three overlapping squares. Instances pages.

        This feature is based on advanced mechanisms that require more resources that would be wasted if not used efficiently. Therefore, we recommend to disable this option if it has no real use during the execution of the pipeline to have correct optimization.
      • When disabled settings env vars, modification and transfer of variables between jobs during pipeline execution is not allowed. You can still read global, project, and pipeline environment variables, but not modify them.

        • The second part of the The "Overview" page icon is a square divided into several other squares. Overview page indicates whether the setting is enabled or not.

        • Each pipeline instance indicates whether it was executed with the setting enabled or not.

  6. Saving is automatic. You can just press Enter to confirm the pipeline name change, click anywhere nearby to confirm the description change, and close the side panel to confirm the scheduled run, email alert, and environment variable changes.

Upgrading Pipelines

You can upgrade your pipelines to always get the most out of them. It allows you to modify the name and description, the settings, add and delete jobs and conditions. By upgrading your pipeline, you create a new version of it.

  1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
    Your project library opens, listing the existing projects.

  2. Click a project in the list.
    The project opens on its job library.

    Navigate to your project

  3. Click The "Pipelines" page icon is represented by several connected jobs. Pipelines from the secondary navigation menu to open the project’s pipeline library.

  4. From the list, click a pipeline to access its details.
    The pipeline The "Overview" page icon is a square divided into several other squares. Overview page opens.

  5. From the The "Instances" page icon is three overlapping squares. Instances or The "Versions" page icon is a folder with an arrow pointing up. Versions page, click Upgrade pipeline Upgrade pipeline button.

    You can also click edit Edit from the The "Overview" page icon is a square divided into several other squares. Overview page.

    The page for editing your pipeline opens.

  6. You can:

    • Design your pipeline → Move jobs and conditions anywhere on the design grid.

    • Add or remove jobs and conditions →

      • Click Add job or Add condition and select an item from the list to add a job or a condition to the pipeline.

      • Click the job or condition card and select delete Remove to remove it from the pipeline.

    • Add or remove links →

      • Link the connectors of a job or condition to create connections between them.

      • Click the small grey cross close in the middle of a link to remove the link between jobs or conditions.

    • Modify settings → Change the pipeline name, description, scheduled run, email alerts, and environment variables.

      Changes made only to metadata such as name, description, scheduled run, email alerts, and environment variables do not trigger the creation of a new pipeline version.
    • Manage the release note → Add or modify the release note.

Your pipeline has been upgrade and you should see that a new version of it has been created, along with a new instance.

Managing Pipeline Environment Variables on the Fly

You can create, modify, and delete pipeline environment variables on the fly using the settings env vars Variables side panel.

The setting does not need to be activated for this to work.
  1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
    Your project library opens, listing the existing projects.

  2. Click a project in the list.
    The project opens on its job library.

    Navigate to your project

  3. Click The "Pipelines" page icon is represented by several connected jobs. Pipelines from the secondary navigation menu to open the project’s pipeline library.

  4. From the list, click a pipeline to access its details.
    The pipeline The "Overview" page icon is a square divided into several other squares. Overview page opens.

  5. Click settings env vars Variables.
    A panel opens with the existing variables in a code block.

    You can also access this setting from the edit mode by clicking edit Edit from the pipeline The "Overview" page icon is a square divided into several other squares. Overview page.
  6. In the code block, add, modify, or delete variables.

    How to set pipeline environment variables?
    • A pipeline environment variable includes a key (name), an equal sign, and a value.

    • The name is mandatory. It must begin with a letter and can be up to 128 characters, including alphanumeric characters (a-z) (A-Z) (0-9) and underscores (_).

    • Values can be up to 2,048 characters.

    • A line is equal to an environment variable.

    • A line that begins with a hash sign (#) is a comment line. This content will be ignored.

    • If the same key is defined several times, only the value of the last occurrence of this key will be saved.

    • Environment variables defined as passwords are not listed here, nor can they be defined as such.

    Read the embedded help for more information.

These changes will update the pipeline settings env vars a Environment variables page accordingly.