> User Documentation Home

User Handbook
Tutorials
Resources

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.

Release Plugin

View this plugin on the Plugins site

release: Trigger release for the job

  • job
    Full name of the job to be released. This job must be visible to the current user. It should contain the Release configuration defined by the plugin.
    • Type: String
  • parameters (optional)
      Array / List of Nested Choice of Objects
    • agentParameter
      • name
        • Type: String
      • value
        • Type: String
    • base64File
      • name
        • Type: String
      • base64 (optional)
        • Type: String
      • file (optional)
          Nested Choice of Objects
    • booleanParam
      • name
        • Type: String
      • value
        • Type: boolean
    • buildMasterRelease
      • name
        • Type: String
      • applicationId
        • Type: String
      • releaseNumber
        • Type: String
      • showApplicationId
        • Type: boolean
      • description
        • Type: String
    • checkboxParameter
      • name
        • Type: String
      • value
        • Type: String
    • $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
    • imageTag
      • name
        • Type: String
      • imageName
        • Type: String
      • imageTag
        • 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'
          • listGitBranches
            • name
              • Type: String
            • value
              • Type: String
          • $class: 'ListSubversionTagsParameterValue'
            • name
              • Type: String
            • tagsDir
              • Type: String
            • tag
              • Type: String
          • $class: 'MatrixCombinationsParameterValue'
            • name
              • Type: String
            • description
              • Type: String
            • combinations
              • Type: Array / List of String
          • mavenMetadataVersions
            • name
              • Type: String
            • description
              • Type: String
            • groupId
              • Type: String
            • artifactId
              • Type: String
            • version
              • Type: String
            • packaging
              • Type: String
            • classifier
              • Type: String
            • artifactUrl
              • Type: String
          • multiselect
            • name
              • Type: String
            • selectedValues
              • Type: java.util.Map<java.lang.String, java.lang.String>
          • $class: 'NodeParameterValue'
            • name
              • Type: String
            • labels
              • Type: Array / List of String
            • nodeEligibility
                Nested Choice of Objects
              • $class: 'AllNodeEligibility'
                • $class: 'IgnoreOfflineNodeEligibility'
                  • $class: 'IgnoreTempOfflineNodeEligibility'
                • $class: 'PackageChoiceParameterValue'
                  • name
                    • Type: String
                  • value
                    • Type: String
                • separator
                  • 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
                • RESTList
                  • 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
                    • Type: String
                • stashedFile
                  • name
                    • Type: String
                  • file
                      Nested Choice of Objects
                • string
                  • name
                    • Type: String
                  • value
                    • Type: String
                • text
                  • name
                    • Type: String
                  • value
                    • Type: String
                • $class: 'VBoxParameterValue'
                  • name
                    • Type: String
                  • nodes
                    • Type: Array / List of String
                  • nodeDelimiter
                    • Type: String
                • email
                  • name
                    • Type: String
                  • value
                    • Type: String
                • validatingString
                  • name
                    • Type: String
                  • value
                    • Type: String
                • validatingYamlParameter
                  • name
                    • Type: String
                  • value
                    • Type: String
                  • failedValidationMessage (optional)
                    • 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
                • extendedChoice
                  • 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: class hudson.util.Secret
                  • description
                    • Type: String

              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.