Pipelines Resources

A resource can be specified as an input for a step by adding it to the inputResources section of a step.

YAML Schema

    steps:
      - name: <step_name>
        type: <step_type>
        configuration:          
                  inputResources:
            - name:         <resource name>
              trigger:      <true/false>    # default true
              newVersionOnly: <true/false>  # default false
              branch:       <string>        # see description of defaults below

Example - Input Resource Definition

    steps:
      - name: step_1
        type: Bash
        configuration:
          inputResources:
            - name: my_app_repo
              trigger: false   # optional; default true
              newVersionOnly: true  # optional; default false
                          branch: master   # optional 

This section provides information about the various ways in which input resources can be used to manipulate pipeline runs.

Skip Automatic Trigger for All Commits

By default, changes to an input resource triggers the execution of the dependent steps. For example, when a step specifies a GitRepoGitRepo resource, any new code committed to that Git repository automatically causes that step to execute. However, this behavior can be changed by declaring triggeras false (see below). Now, even when the resource is updated, the dependent step is not triggered. This is especially useful for a production pipeline, when you do not want to deploy every new build.GitRepo

Example - Automatic Trigger Off

pipelines:
  - name: java_pipeline
    steps:
      - name: step_1
        type: Bash
        configuration:
          inputResources:
            - name: my_app_repo
                          trigger: false
                        - name: cron_trigger
                  trigger: false
        execution:
           onExecute:
             - pushd $res_my_app_repo_resourcePath
             - ./execute.sh
             - popd

When trigger is set as false, the line linking the input resource and the step appears as a dashed line.

trigger: false		trigger: true

Trigger Automatically on New Version Only

Whenever a resource undergoes a change, its version is updated and the dependent step is triggered. This is the default behaviour for all input resources. To skip steps in a run when input resources are not updated, add the newVersionOnly tag and set it as true. During a run, the step is triggered only when the resource is updated. If the resource is not updated, the step is skipped and all the downstream steps are skipped as well.

Example 1 - newVersionOnly

pipelines:
  - name: java_pipeline
    steps:
      - name: step_1
        type: Bash
        configuration:
          inputResources:
            - name: my_app_repo
                        - newVersionOnly: true
        execution:
           onExecute:
             - pushd $res_my_app_repo_resourcePath
             - ./execute.sh
             - popd

Example 2 - newVersionOnly

resources:
  - name: S_WF_012_resource
    type: PropertyBag
    configuration:
      runNumber: 0

pipelines:
  - name: pipeline_S_WF_012_001
    steps:
      - name: S_WF_012_input1
        type: Bash
        configuration:
          outputResources:
            - name: S_WF_012_resource
        execution:
          onExecute:
            #- write_output S_WF_012_resource runNumber=${run_number}
            - echo "test"

      - name: step1      
        type: Bash
        configuration:
          inputResources:
            - name: S_WF_012_resource
              newVersionOnly: true
        execution:
          onExecute:
            - echo "test"

      - name: step2
        type: Bash
        configuration:
          inputResources:
            - name: S_WF_012_resource
        execution:
          onExecute:
            - echo "test"

Trigger Manually using Specific Versions

A run can be customized by selecting a specific version for an input resource. For more information, see Triggering a Run with Custom Parameters.

By default, Pipelines uses the most recent or latest version of an input resource when running a job. However, there could be cases where you want to use a specific version of an input resource for a run. This is called pinning and input versions can be pinned using the YAML configuration. When a resource version is unpinned, it switches to using the latest version for all subsequent runs.

Resource version Ids have a global sequence, which can be found on the Resource tab. For more information, see Viewing Resources.

You can use the pin tag to pin a specific input version as shown below below:

Example

resources:
  - name:                       <string>
    type:                       DistributionRule
    configuration:
      pin:
        versionId:  <number>

The following resources support version pinning:

A resource can be specified as an output for a step by adding it in the outputResources section of a step.

YAML Schema

    steps:
      - name: <step_name>
        type: <step_type>
        configuration:          
                  outputResources:
            - name:         <resource name>
              branch:       <string>        # see description of defaults below

Example - Output Resource Definition

    steps:
      - name: step_2
        type: Bash
        configuration:
          outputResources:
            - name: my_repo
                          branch: master