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

We would like a more meaningful description of a step

    XMLWordPrintable

    Details

    • Sprint:
      frank, tethys, christmas, pannonian, iapetus, 1.0, Blue Ocean 1.0-rc3, Blue Ocean 1.0-rc4, Blue Ocean - 1.1-beta-1, Blue Ocean - 1.1-beta2, Blue Ocean 1.1-beta4, Blue Ocean 1.1, Blue Ocean 1.1
    • Similar Issues:

      Description

      Note: This has been implemented, but what is missing is some UI work to follow the design/limit wrapping on narrow screens (backend and pipeline components are completed, including api usage). 

       

      Scope

      • Pipeline API exposes step descriptions
      • Descriptions for steps reflected from the pipeline API
      • Update the UI of Blue Ocean to display the steps

      Design

      • Has Description
        • Description on left, black @ 100% opacity
          **Type to the right, with em dash, black @ 50% opacity (or grey color)
      • Has no Description
        • Type on left, black @ 100% opacity
      • Use Zeplin for extact metrics https://zpl.io/1MtiWN

      Mockup

      Notes
      We want to provide the developer a more meaningful description of the steps in Blue Ocean.

      For example, if we have a shell script being executed we'd like to provide the command as the description of that step. If we don't have that information, we'd like to fall back to a description of the step otherwise fall back to the step name.

        Attachments

        1. #2 2017-06-05 10-50-45.png
          87 kB
          James Dumay
        2. changes.png
          52 kB
          Julien Pivotto
        3. mockup.png
          71 kB
          James Dumay

          Issue Links

            Activity

            Hide
            philmcardlecg Phil McArdle added a comment -

            Dana Goyette, I haven't tested this in a while, but I believe your issue there is using variables like the build id, assuming you used the actual number of the current build. In my experience, Jenkins goes to lengths to identify and mask data like that.

            Show
            philmcardlecg Phil McArdle added a comment - Dana Goyette , I haven't tested this in a while, but I believe your issue there is using variables like the build id, assuming you used the actual number of the current build. In my experience, Jenkins goes to lengths to identify and mask data like that.
            Hide
            danagoyette Dana Goyette added a comment -

            Thanks for the hint about the issue being variables. That seems to be it: if I use any variables (in the stock sh step's command or the labelledShell step's label), then the label is just silently ignored! Should I file a separate ticket for that brokenness?

            Show
            danagoyette Dana Goyette added a comment - Thanks for the hint about the issue being variables. That seems to be it: if I use any variables (in the stock sh step's command or the labelledShell step's label), then the label is just silently ignored! Should I file a separate ticket for that brokenness?
            Hide
            philmcardlecg Phil McArdle added a comment -

            If you wanted something like that changed, that'd be a separate issue, yep

            I think that's running at a much lower level than the step labelling.

            Show
            philmcardlecg Phil McArdle added a comment - If you wanted something like that changed, that'd be a separate issue, yep I think that's running at a much lower level than the step labelling.
            Hide
            jglick Jesse Glick added a comment -

            if I use any variables (in the stock sh step's command or the labelledShell step's label), then the label is just silently ignored

            See JENKINS-47101.

            Show
            jglick Jesse Glick added a comment - if I use any variables (in the stock sh step's command or the labelledShell step's label), then the label is just silently ignored See JENKINS-47101 .
            Hide
            borisa boris avney added a comment -

            Hi,

            Where can I find which BO version has this functionality?
            (couldn't find the PR in change log: https://wiki.jenkins.io/display/JENKINS/Blue+Ocean+Plugin)

             

            Show
            borisa boris avney added a comment - Hi, Where can I find which BO version has this functionality? (couldn't find the PR in change log:  https://wiki.jenkins.io/display/JENKINS/Blue+Ocean+Plugin)  

              People

              • Assignee:
                cliffmeyers Cliff Meyers
                Reporter:
                jamesdumay James Dumay
              • Votes:
                24 Vote for this issue
                Watchers:
                51 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: