Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-48379

Input/parameters for Stages

    XMLWordPrintable

Details

    • Pipeline - December

    Description

      Problem
      If an input is used within a stage that uses an agent, it will block the agent from being used until the input proceeds. 

      stage('rollback') {
  agent {
    label 'deployer-agent'
  }
  steps {
    input 'should I rollback?' // blocks agent 'deployer-agent'
  }
}

      Solution
      Introduce a input directive inside stage that blocks the stage from executing and acquiring the agent.

      stage('rollback') {
  input {
    message 'should I rollback?'
  }
  agent {
    label 'deployer-agent'
  }
  steps {
    echo 'deploying'
  }
}

      This would be the same in scripted pipeline:

      stage('rollback') {
  input 'should I rollback?'
  node ('deployer-agent') {
    echo 'deploying'
  }
}

      Full Syntax

      input {
  // Parameters are all the same as the input step. Only message is required.
  message "Should we continue?"
  id "some-id" // optional, defaults to stage name.
  ok "For the OK button"
  submitter "alice,bob"
  submitterParameter "approver"
  parameters {
    // Same syntax as top-level parameters block
    booleanParam(name: 'someParam', defaultValue: true, description: 'some description')
    ...
  }
}

      Attachments

        Issue Links

          is duplicated by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. JENKINS-38394 Ability to set output of a step to environment variable(s)

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-37515 RFE: input() blocks the executor in Declarative, add a stage attribute instead?

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-41076 Improvements for 'when' section

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed
          relates to

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-57871 Input directive is blocking executor in declarative pipeline

          • Major - Major loss of function.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-49946 input step cannot access environment blocks

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Reopened

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-49947 unclear usage of input step in declarative pipeline

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-48380 Block-scoped "wrapper" options for individual stages

          • Major - Major loss of function.
          • Closed
          links to

          Web Link CloudBees Internal CD-365

          Web Link PR #231

          Activity

            Ascending order - Click to sort in descending order
            View 12 older comments
            rmpestano Rafael Pestano added a comment -

            Just tested and is working great:

            pipeline {

 agent none

 stages {

    stage("deploy to production ") {
            options {
                timeout(time: 1, unit: 'DAYS')
            }
            input {
                message "Approve deploy?"
                ok "Yes"
            }
            agent  any //must be declared after input directive
            steps {
              deploy env: 'PRODUCTION' 
            }
        }

   }//end stages

   post {
        always {
             node('master') { //important because the pipeline agent is none and some plugins may need to access the workspace
                 lastChanges()
             }
        }
    }  

} //end pipeline
            rmpestano Rafael Pestano added a comment - Just tested and is working great: pipeline { agent none stages { stage( "deploy to production " ) { options { timeout(time: 1, unit: 'DAYS' ) } input { message "Approve deploy?" ok "Yes" } agent any //must be declared after input directive steps { deploy env: 'PRODUCTION' } } } //end stages post { always { node( 'master' ) { //important because the pipeline agent is none and some plugins may need to access the workspace lastChanges() } } } } //end pipeline
            michaelneale Michael Neale added a comment -

            nice - tkleiber should add this to docs!

            michaelneale Michael Neale added a comment - nice - tkleiber should add this to docs!
            tkleiber Torsten Kleiber added a comment -

            Don't understand - what do you mean by this?

            tkleiber Torsten Kleiber added a comment - Don't understand - what do you mean by this?
            michaelneale Michael Neale added a comment -

            tkleiber oh just mean that the docs website would ideally cover this feature (if it doesn't already) - nothing more than that. 

            michaelneale Michael Neale added a comment - tkleiber oh just mean that the docs website would ideally cover this feature (if it doesn't already) - nothing more than that. 
            bitwiseman Liam Newman added a comment -

            Bulk closing resolved issues.

            bitwiseman Liam Newman added a comment - Bulk closing resolved issues.

            People

              abayer Andrew Bayer
              jamesdumay James Dumay
              Votes:
              2 Vote for this issue
              Watchers:
              11 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: