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 : String
    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.
  • parameters (optional)
      Array / List of Nested Choice of Objects
    • activeGitBranches
      • name : String
      • value : String
    • adminBoolean
      • name : String
      • value : boolean
    • adminString
      • name : String
      • value : String
    • agentParameter
      • name : String
      • value : String
    • base64File
      • name : String
      • base64 : String (optional)
      • file (optional)
          Nested Choice of Objects
    • booleanParam
      • name : String
      • value : boolean
    • buildMasterRelease
      • name : String
      • applicationId : String
      • releaseNumber : String
      • showApplicationId : boolean
      • description : String
    • checkboxParameter
      • name : String
      • value : String
    • $class: 'ClearCaseUcmBaselineParameterValue'
      • name : String
      • baseline : String
      • forceRmview : boolean
    • credentials
      • name : String
      • value : String
      • description : String
    • $class: 'CvsTagsParamValue'
      • name : String
      • tagName : String
    • $class: 'DateParameterValue'
      • name : String
      • value : String
      • description : String
    • $class: 'DeployMetaDataParameterValue'
      • name : String
      • environmentKey : String
      • buildVersion : String
      • applicationName : String
    • file
      • name : String
      • file
          Nested Choice of Objects
    • fileSystemList
      • name : String
      • value : String
    • $class: 'GeneratorKeyValueParameterValue'
      • name : String
      • value : String
    • gitParameter
      • name : String
      • value : String
    • imageTag
      • name : String
      • imageName : String
      • imageTag : String
    • $class: 'InheritableStringParameterValue'
      • name : String
      • value : String
    • $class: 'JavaParameterValue'
      • name : String
      • description : String
      • selectedJDK : String
    • jiraIssue
      • name : String
      • value : String
    • jiraReleaseVersion
      • name : String
      • version : String
    • jsonEditor
      • name : String
      • value : String
    • $class: 'LabelParameterValue'
      • name : String
      • label : String
      • allNodesMatchingLabel : boolean
      • nodeEligibility
          Nested Choice of Objects
        • $class: 'AllNodeEligibility'
          • $class: 'IgnoreOfflineNodeEligibility'
            • $class: 'IgnoreTempOfflineNodeEligibility'
          • listGitBranches
            • name : String
            • value : String
          • $class: 'ListSubversionTagsParameterValue'
            • name : String
            • tagsDir : String
            • tag : String
          • $class: 'MatrixCombinationsParameterValue'
            • name : String
            • description : String
            • combinations : Array / List of String
            • mavenMetadataVersions
              • name : String
              • description : String
              • groupId : String
              • artifactId : String
              • version : String
              • packaging : String
              • classifier : String
              • artifactUrl : String
            • multiselect
              • name : String
              • selectedValues (optional)
                • Type: java.util.Map<java.lang.String, java.lang.String>
            • $class: 'NodeParameterValue'
              • name : String
              • labels : Array / List of String
                • nodeEligibility
                    Nested Choice of Objects
                  • $class: 'AllNodeEligibility'
                    • $class: 'IgnoreOfflineNodeEligibility'
                      • $class: 'IgnoreTempOfflineNodeEligibility'
                    • orasPlatformParameter
                      • name : String
                      • registry : String
                      • repository : String
                      • tag : String
                      • digest : String
                      • annotations
                        • Type: java.util.Map<java.lang.String, java.lang.String>
                      • platform
                        • Type: class io.jenkins.plugins.oras.parameter.OrasPlatformParameterDefinition$PlatformWrapper
                    • orasRepositoryParameter
                      • name : String
                      • registry : String
                      • repository : String
                    • orasTagParameter
                      • name : String
                      • registry : String
                      • repository : String
                      • tag : String
                      • digest : String
                      • annotations
                        • Type: java.util.Map<java.lang.String, java.lang.String>
                    • $class: 'PackageChoiceParameterValue'
                      • name : String
                      • value : String
                    • separator
                      • name : String
                      • separatorStyle : String
                      • sectionHeader : String
                      • sectionHeaderStyle : String
                    • $class: 'PatchParameterValue'
                      • name : String
                      • file
                          Nested Choice of Objects
                    • $class: 'PromotedBuildParameterValue'
                      • name : String
                      • runId : String
                      • description : String
                    • quayImageParameter
                      • name : String
                      • organization : String
                      • repository : String
                      • tag : String
                    • $class: 'RandomStringParameterValue'
                      • name : String
                      • value : String
                    • RESTList
                      • name : String
                      • value : String
                    • RESTMultiList
                      • name : String
                      • value : Array / List of String
                      • $class: 'ReviewboardParameterValue'
                        • name : String
                        • value : String
                      • run
                        • name : String
                        • runId : String
                        • description : String
                      • $class: 'SauceParameterValue'
                        • name : String
                        • selectedBrowsers : String
                      • stashedFile
                        • name : String
                        • file
                            Nested Choice of Objects
                      • string
                        • name : String
                        • value : String
                      • tabsParam
                        • name : String
                        • tabsValues
                            Array / List of Nested Object
                          • uid
                            • Type: class java.util.UUID
                          • name : String
                          • parameters
                              Array / List of Nested Choice of Objects
                            • activeGitBranches
                              • name : String
                              • value : String
                            • adminBoolean
                              • name : String
                              • value : boolean
                            • adminString
                              • name : String
                              • value : String
                            • agentParameter
                              • name : String
                              • value : String
                            • base64File
                              • name : String
                              • base64 : String (optional)
                              • file (optional)
                                  Nested Choice of Objects
                            • booleanParam
                              • name : String
                              • value : boolean
                            • buildMasterRelease
                              • name : String
                              • applicationId : String
                              • releaseNumber : String
                              • showApplicationId : boolean
                              • description : String
                            • checkboxParameter
                              • name : String
                              • value : String
                            • $class: 'ClearCaseUcmBaselineParameterValue'
                              • name : String
                              • baseline : String
                              • forceRmview : boolean
                            • credentials
                              • name : String
                              • value : String
                              • description : String
                            • $class: 'CvsTagsParamValue'
                              • name : String
                              • tagName : String
                            • $class: 'DateParameterValue'
                              • name : String
                              • value : String
                              • description : String
                            • $class: 'DeployMetaDataParameterValue'
                              • name : String
                              • environmentKey : String
                              • buildVersion : String
                              • applicationName : String
                            • file
                              • name : String
                              • file
                                  Nested Choice of Objects
                            • fileSystemList
                              • name : String
                              • value : String
                            • $class: 'GeneratorKeyValueParameterValue'
                              • name : String
                              • value : String
                            • gitParameter
                              • name : String
                              • value : String
                            • imageTag
                              • name : String
                              • imageName : String
                              • imageTag : String
                            • $class: 'InheritableStringParameterValue'
                              • name : String
                              • value : String
                            • $class: 'JavaParameterValue'
                              • name : String
                              • description : String
                              • selectedJDK : String
                            • jiraIssue
                              • name : String
                              • value : String
                            • jiraReleaseVersion
                              • name : String
                              • version : String
                            • jsonEditor
                              • name : String
                              • value : String
                            • $class: 'LabelParameterValue'
                              • name : String
                              • label : String
                              • allNodesMatchingLabel : boolean
                              • nodeEligibility
                                  Nested Choice of Objects
                                • $class: 'AllNodeEligibility'
                                  • $class: 'IgnoreOfflineNodeEligibility'
                                    • $class: 'IgnoreTempOfflineNodeEligibility'
                                  • listGitBranches
                                    • name : String
                                    • value : String
                                  • $class: 'ListSubversionTagsParameterValue'
                                    • name : String
                                    • tagsDir : String
                                    • tag : String
                                  • $class: 'MatrixCombinationsParameterValue'
                                    • name : String
                                    • description : String
                                    • combinations : Array / List of String
                                    • mavenMetadataVersions
                                      • name : String
                                      • description : String
                                      • groupId : String
                                      • artifactId : String
                                      • version : String
                                      • packaging : String
                                      • classifier : String
                                      • artifactUrl : String
                                    • multiselect
                                      • name : String
                                      • selectedValues (optional)
                                        • Type: java.util.Map<java.lang.String, java.lang.String>
                                    • $class: 'NodeParameterValue'
                                      • name : String
                                      • labels : Array / List of String
                                        • nodeEligibility
                                            Nested Choice of Objects
                                          • $class: 'AllNodeEligibility'
                                            • $class: 'IgnoreOfflineNodeEligibility'
                                              • $class: 'IgnoreTempOfflineNodeEligibility'
                                            • orasPlatformParameter
                                              • name : String
                                              • registry : String
                                              • repository : String
                                              • tag : String
                                              • digest : String
                                              • annotations
                                                • Type: java.util.Map<java.lang.String, java.lang.String>
                                              • platform
                                                • Type: class io.jenkins.plugins.oras.parameter.OrasPlatformParameterDefinition$PlatformWrapper
                                            • orasRepositoryParameter
                                              • name : String
                                              • registry : String
                                              • repository : String
                                            • orasTagParameter
                                              • name : String
                                              • registry : String
                                              • repository : String
                                              • tag : String
                                              • digest : String
                                              • annotations
                                                • Type: java.util.Map<java.lang.String, java.lang.String>
                                            • $class: 'PackageChoiceParameterValue'
                                              • name : String
                                              • value : String
                                            • separator
                                              • name : String
                                              • separatorStyle : String
                                              • sectionHeader : String
                                              • sectionHeaderStyle : String
                                            • $class: 'PatchParameterValue'
                                              • name : String
                                              • file
                                                  Nested Choice of Objects
                                            • $class: 'PromotedBuildParameterValue'
                                              • name : String
                                              • runId : String
                                              • description : String
                                            • quayImageParameter
                                              • name : String
                                              • organization : String
                                              • repository : String
                                              • tag : String
                                            • $class: 'RandomStringParameterValue'
                                              • name : String
                                              • value : String
                                            • RESTList
                                              • name : String
                                              • value : String
                                            • RESTMultiList
                                              • name : String
                                              • value : Array / List of String
                                              • $class: 'ReviewboardParameterValue'
                                                • name : String
                                                • value : String
                                              • run
                                                • name : String
                                                • runId : String
                                                • description : String
                                              • $class: 'SauceParameterValue'
                                                • name : String
                                                • selectedBrowsers : String
                                              • stashedFile
                                                • name : String
                                                • file
                                                    Nested Choice of Objects
                                              • string
                                                • name : String
                                                • value : String
                                              • tabsParam
                                              • text
                                                • name : String
                                                • value : String
                                              • $class: 'VBoxParameterValue'
                                                • name : String
                                                • nodes : Array / List of String
                                                  • nodeDelimiter : String
                                                • email
                                                  • name : String
                                                  • value : String
                                                • validatingString
                                                  • name : String
                                                  • value : String
                                                • validatingYamlParameter
                                                  • name : String
                                                  • value : String
                                                  • failedValidationMessage : String (optional)
                                                • hidden
                                                  • name : String
                                                  • value : String
                                                • $class: 'WReadonlyStringParameterValue'
                                                  • name : String
                                                  • value : String
                                                • $class: 'WReadonlyTextParameterValue'
                                                  • name : String
                                                  • value : String
                                                • extendedChoice
                                                  • name : String
                                                  • value : String
                                                • nonStoredPassword
                                                  • name : String
                                                  • value : String
                                                  • description : String
                                                • $class: 'com.moded.extendedchoiceparameter.ExtendedChoiceParameterValue'
                                                  • name : String
                                                  • value : String
                                                • password
                                                  • name : String
                                                  • value
                                                    • Type: class hudson.util.Secret
                                                  • description : String
                                            • selectedTabUid
                                              • Type: class java.util.UUID
                                          • text
                                            • name : String
                                            • value : String
                                          • $class: 'VBoxParameterValue'
                                            • name : String
                                            • nodes : Array / List of String
                                              • nodeDelimiter : String
                                            • email
                                              • name : String
                                              • value : String
                                            • validatingString
                                              • name : String
                                              • value : String
                                            • validatingYamlParameter
                                              • name : String
                                              • value : String
                                              • failedValidationMessage : String (optional)
                                            • hidden
                                              • name : String
                                              • value : String
                                            • $class: 'WReadonlyStringParameterValue'
                                              • name : String
                                              • value : String
                                            • $class: 'WReadonlyTextParameterValue'
                                              • name : String
                                              • value : String
                                            • extendedChoice
                                              • name : String
                                              • value : String
                                            • nonStoredPassword
                                              • name : String
                                              • value : String
                                              • description : String
                                            • $class: 'com.moded.extendedchoiceparameter.ExtendedChoiceParameterValue'
                                              • name : String
                                              • value : String
                                            • password
                                              • name : String
                                              • value
                                                • Type: class hudson.util.Secret
                                              • description : 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.