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

Allow stage to operate as a labelled block

    XMLWordPrintable

Details

    Description

      Useful to give a label to one or more steps that are otherwise opaque in the log.

      stage('Deploying') {
    sh './deploy.sh --some-long-arguments'
}

      FlowGraphTable should hide the body of the label step by default.

      Alternatives considered:

      sh script: './deploy.sh', label: 'Deploying'

      which does not scale well as a design (labeling should be orthogonal to step definitions); or implicit label creation when Groovy label expressions are encountered:

      LABEL: sh '/bin/perl abc def'

      which may break down:

      FOO:
def x = 1;
for (...) {
    ...
}

      Attachments

        Issue Links

          blocks

          Task - A task that needs to be done. JENKINS-37323 Ensure that Pipeline Graph can handle stage blocks

          • Blocker - Blocks development and/or testing work, production could not run.
          • Closed
          depends on

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-26156 Erroneous handling of BodyInvoker.withDisplayName

          • Major - Major loss of function.
          • Resolved
          is blocking

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-28183 Hard killed job's stage blocks stage in following jobs

          • Major - Major loss of function.
          • Resolved

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. JENKINS-33185 Visualize parallel steps within a Pipeline Stage

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

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-30088 Clean up step display

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-28293 Display more information about Pipeline steps

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

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-36933 Name or alias Shell Script Step (sh)

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-26602 titles for build steps

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

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-27210 Ability to add a descriptive text to a shell script execution that gets displayed in the Running Steps perspective

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

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-34980 Add a description attribute for each step to be show in stage log overview

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

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-27395 distinguish test reports filed from different parts of workflow

          • Major - Major loss of function.
          • Resolved

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-29892 Block of stages functioning as a concurrency unit

          • Major - Major loss of function.
          • Resolved

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-26987 Hiding certain steps from the "Running Steps" tree

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

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-26522 Annotated block/stage status

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-28119 Link to log of failed step

          • Major - Major loss of function.
          • In Progress

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-26132 Executor should show the current stage the flow run is in

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-27394 Render stages in logs as collapsible sections

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

          Web Link pipeline-stage-step PR 4

          Web Link PR 1

          Web Link PR 140

          Web Link workflow-cps PR 11

          Activity

            Ascending order - Click to sort in descending order
            View 22 older comments
            svanoort Sam Van Oort added a comment -

            mac110 

            stage('named') {
  sh 'my special shell step'
}
            svanoort Sam Van Oort added a comment - mac110   stage( 'named' ) { sh 'my special shell step' }
            greg_k Greg Knapp added a comment -

            So we should use a `stage` block for each command we want to label? Seems like that would lead to a verbose Jenkinsfile

            greg_k Greg Knapp added a comment - So we should use a `stage` block for each command we want to label? Seems like that would lead to a verbose Jenkinsfile
            batmat Baptiste Mathus added a comment -

            Yes, possibly. But you generally wouldn't "label a command", probably more a couple of them to produce not just a serie of staged named after the called commands, but that stage is actually doing ("checking code coverage" or whatever).

            batmat Baptiste Mathus added a comment - Yes, possibly. But you generally wouldn't "label a command", probably more a couple of them to produce not just a serie of staged named after the called commands, but that stage is actually doing ("checking code coverage" or whatever).
            greg_k Greg Knapp added a comment -

            What about being able to label a script block, so you can group several commands and display it as a single operation?

            greg_k Greg Knapp added a comment - What about being able to label a script block, so you can group several commands and display it as a single operation?
            marcellodesales Marcello de Sales added a comment -

            batmat I actually used other CI solutions where it naming an "sh" operation was very useful. 

            marcellodesales Marcello de Sales added a comment - batmat I actually used other CI solutions where it naming an "sh" operation was very useful. 

            People

              jglick Jesse Glick
              jglick Jesse Glick
              Votes:
              44 Vote for this issue
              Watchers:
              80 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: