Hi,

      Is it possible to add custom title for steps in Jenkinsfile. Theses titles would improve readability in build steps logs and blue ocean plugins.

      I was thinkings of something like this :

      node {
          stage('aStage'){
              checkout scm
      
              @Step(title='List files')
              sh 'ls -l'
      
              @Step(title='Do something')
              aStep 'do something'
          }
      }
      

      See images for visualisations

      Add titles to steps make it easy to understand what is done in each step in a team.

       

          [JENKINS-42624] Custom title for build steps

          Yanis LISIMA created issue -

          James Dumay added a comment -

          zeenlym we are going to automatically generate more meaningful descriptions for the steps in the Blue Ocean UI as part of JENKINS-37324. I think this might solve the problem you are having. If not, please reopen this ticket.

          James Dumay added a comment - zeenlym we are going to automatically generate more meaningful descriptions for the steps in the Blue Ocean UI as part of JENKINS-37324 . I think this might solve the problem you are having. If not, please reopen this ticket.
          James Dumay made changes -
          Link New: This issue duplicates JENKINS-37324 [ JENKINS-37324 ]
          James Dumay made changes -
          Resolution New: Duplicate [ 3 ]
          Status Original: Open [ 1 ] New: Resolved [ 5 ]

          Yanis LISIMA added a comment - - edited

          The solution for JENKINS-37324-- is to show description based on parameter.

          But i would like to let developer give a human readable description of what they're doing in steps if needed

          Also i was thinking about using annotation in order to give this behaviour to all steps without necessary development.

          If it is complicated issue --JENKINS-37324 is enough for now.

          Yanis LISIMA added a comment - - edited The solution for JENKINS-37324 -- is to show description based on parameter. But i would like to let developer give a human readable description of what they're doing in steps if needed Also i was thinking about using annotation in order to give this behaviour to all steps without necessary development. If it is complicated issue -- JENKINS-37324 is enough for now.
          Yanis LISIMA made changes -
          Resolution Original: Duplicate [ 3 ]
          Status Original: Resolved [ 5 ] New: Reopened [ 4 ]

          James Dumay added a comment -

          zeenlym I'd prefer to see if JENKINS-37324 resolves most peoples problems before we allow this level of customisability for individual steps. I can see how this could be useful but I think the demands on the syntax make it somewhat of a advanced feature.

          I will re-evaluate this when we've had JENKINS-37324 out in a release for a few months.

          James Dumay added a comment - zeenlym I'd prefer to see if JENKINS-37324 resolves most peoples problems before we allow this level of customisability for individual steps. I can see how this could be useful but I think the demands on the syntax make it somewhat of a advanced feature. I will re-evaluate this when we've had JENKINS-37324 out in a release for a few months.
          James Dumay made changes -
          Resolution New: Postponed [ 6 ]
          Status Original: Reopened [ 4 ] New: Resolved [ 5 ]

          Yanis LISIMA added a comment -

          I am ok with that.

          See you

          Yanis LISIMA added a comment - I am ok with that. See you

          Sorin Sbarnea added a comment -

          Time to reopen it? Having it as closed prevents people from voting it.

          I find that really useful but I suggest a different implementation that does not add so much verbosity to pipeline scripts. Just add a "title" or "name" parameter to the the "step" class and that's all.

          Sorin Sbarnea added a comment - Time to reopen it? Having it as closed prevents people from voting it. I find that really useful but I suggest a different implementation that does not add so much verbosity to pipeline scripts. Just add a "title" or "name" parameter to the the "step" class and that's all.

            Unassigned Unassigned
            zeenlym Yanis LISIMA
            Votes:
            1 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated: