The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Pipeline: Build Step

build: Build a job

Triggers a new build for a given job.
  • job
    Name of a downstream job to build. May be another Pipeline job, but more commonly a freestyle or other project. Use a simple name if the job is in the same folder as this upstream Pipeline job; otherwise can use relative paths like ../sister-folder/downstream or absolute paths like /top-level-folder/nested-folder/downstream.
    • Type: String
  • parameters (optional)
      Array/List
      Nested Choice of Objects
    • booleanParam
      • name
        • Type: String
      • value
        • Type: boolean
    • $class: 'ClearCaseUcmBaselineParameterValue'
      • name
        • Type: String
      • baseline
        • Type: String
      • forceRmview
        • Type: boolean
    • credentials
      • name
        • Type: String
      • value
        • Type: String
      • description
        • Type: String
    • $class: 'CvsTagsParamValue'
      • name
        • Type: String
      • tagName
        • Type: String
    • $class: 'DateParameterValue'
      • name
        • Type: String
      • value
        • Type: String
      • description
        • Type: String
    • $class: 'DeployMetaDataParameterValue'
      • name
        • Type: String
      • environmentKey
        • Type: String
      • buildVersion
        • Type: String
      • applicationName
        • Type: String
    • file
      • name
        • Type: String
      • file
          Nested Choice of Objects
    • $class: 'FileSystemListParameterValue'
      • name
        • Type: String
      • value
        • Type: String
    • $class: 'GeneratorKeyValueParameterValue'
      • name
        • Type: String
      • value
        • Type: String
    • gitParameter
      • name
        • Type: String
      • value
        • Type: String
    • $class: 'InheritableStringParameterValue'
      • name
        • Type: String
      • value
        • Type: String
    • $class: 'JavaParameterValue'
      • name
        • Type: String
      • description
        • Type: String
      • selectedJDK
        • Type: String
    • $class: 'JiraIssueParameterValue'
      • name
        • Type: String
      • value
        • Type: String
    • $class: 'JiraVersionParameterValue'
      • name
        • Type: String
      • version
        • Type: String
    • $class: 'LabelParameterValue'
      • name
        • Type: String
      • label
        • Type: String
      • allNodesMatchingLabel
        • Type: boolean
      • nodeEligibility
          Nested Choice of Objects
        • $class: 'AllNodeEligibility'
          • $class: 'IgnoreOfflineNodeEligibility'
            • $class: 'IgnoreTempOfflineNodeEligibility'
          • $class: 'ListSubversionTagsParameterValue'
            • name
              • Type: String
            • tagsDir
              • Type: String
            • tag
              • Type: String
          • $class: 'MatrixCombinationsParameterValue'
            • name
              • Type: String
            • description
              • Type: String
            • combinations
                Array/List
              • Type: String
          • $class: 'MavenMetadataParameterValue'
            • name
              • Type: String
            • description
              • Type: String
            • groupId
              • Type: String
            • artifactId
              • Type: String
            • version
              • Type: String
            • packaging
              • Type: String
            • classifier
              • Type: String
            • artifactUrl
              • Type: String
          • $class: 'NodeParameterValue'
            • name
              • Type: String
            • labels
                Array/List
              • Type: String
            • nodeEligibility
                Nested Choice of Objects
              • $class: 'AllNodeEligibility'
                • $class: 'IgnoreOfflineNodeEligibility'
                  • $class: 'IgnoreTempOfflineNodeEligibility'
                • $class: 'PackageChoiceParameterValue'
                  • name
                    • Type: String
                  • value
                    • Type: String
                • $class: 'ParameterSeparatorValue'
                  • name
                    • Type: String
                  • separatorStyle
                    • Type: String
                  • sectionHeader
                    • Type: String
                  • sectionHeaderStyle
                    • Type: String
                • $class: 'PatchParameterValue'
                  • name
                    • Type: String
                  • file
                      Nested Choice of Objects
                • $class: 'PromotedBuildParameterValue'
                  • name
                    • Type: String
                  • runId
                    • Type: String
                  • description
                    • Type: String
                • $class: 'RandomStringParameterValue'
                  • name
                    • Type: String
                  • value
                    • Type: String
                • $class: 'ReviewboardParameterValue'
                  • name
                    • Type: String
                  • value
                    • Type: String
                • run
                  • name
                    • Type: String
                  • runId
                    • Type: String
                  • description
                    • Type: String
                • $class: 'SauceParameterValue'
                  • name
                    • Type: String
                  • selectedBrowsers
                      net.sf.json.JSONArray
                • string
                  • name
                    • Type: String
                  • value
                    • Type: String
                • text
                  • name
                    • Type: String
                  • value
                    • Type: String
                • $class: 'VBoxParameterValue'
                  • name
                    • Type: String
                  • nodes
                      Array/List
                    • Type: String
                  • nodeDelimiter
                    • Type: String
                • validatingString
                  • name
                    • Type: String
                  • value
                    • Type: String
                • $class: 'VersionParameterValue'
                  • groupid
                    • Type: String
                  • artifactid
                    • Type: String
                  • propertyName
                    • Type: String
                  • version
                    • Type: String
                • $class: 'WHideParameterValue'
                  • name
                    • Type: String
                  • value
                    • Type: String
                • $class: 'WReadonlyStringParameterValue'
                  • name
                    • Type: String
                  • value
                    • Type: String
                • $class: 'WReadonlyTextParameterValue'
                  • name
                    • Type: String
                  • value
                    • Type: String
                • $class: 'com.cwctravel.hudson.plugins.extended_choice_parameter.ExtendedChoiceParameterValue'
                  • name
                    • Type: String
                  • value
                    • Type: String
                • $class: 'com.michelin.cio.hudson.plugins.passwordparam.PasswordParameterValue'
                  • name
                    • Type: String
                  • value
                    • Type: String
                  • description
                    • Type: String
                • $class: 'com.moded.extendedchoiceparameter.ExtendedChoiceParameterValue'
                  • name
                    • Type: String
                  • value
                    • Type: String
                • password
                  • name
                    • Type: String
                  • value
                    • Type: String
                  • description
                    • Type: String
              • propagate (optional)

                If set, then if the downstream build is anything but successful (blue ball), this step fails. If disabled, then this step succeeds even if the downstream build is unstable, failed, etc.; use the result property of the return value as needed.

                • Type: boolean
              • quietPeriod (optional)
                Optional alternate quiet period (in seconds) before building. If unset, defaults to the quiet period defined by the downstream project (or finally to the system-wide default quiet period).
                • Type: int
              • wait (optional)
                • Type: boolean

              Was this page helpful?

              Please submit your feedback about this page through this quick form.

              Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

                  


              See existing feedback here.