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

We would like a more meaningful description of a step

    XMLWordPrintable

Details

    • 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

    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
          #2 2017-06-05 10-50-45.png
          87 kB
        2. changes.png
          changes.png
          52 kB
        3. mockup.png
          mockup.png
          71 kB

        Issue Links

          blocks

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-35864 Step section in log sticks to result header when scrolling

          • Major - Major loss of function.
          • Resolved
          duplicates

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-31582 Log / document the plugin usage in the flow nodes

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

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-43934 GString kept unevaluated as long as StepDescriptor.newInstance (was: Pipeline build fails with serialization error when using string interpolation)

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

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-40536 Show question answered on build approvals

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

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-42624 Custom title for build steps

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

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-43793 Ability to name pipeline steps

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

          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-39709 Use SCM extension [$class: 'ScmName'] in Pipeline step

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-41156 [Pipeline] Have shell and batch steps be renameable

          • 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

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-43030 Naming Step sections in Blue Ocean

          • 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-43545 Ability to name/label General Build Steps for display/reporting purpose

          • 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-40400 Meanful comments in logs

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

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-44718 Step description does not show ellipsis when truncated

          • 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-47101 Pipeline withCredentials step does not mask step descriptions for variables with the same name as existing system variables

          • Major - Major loss of function.
          • Resolved

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-44094 Hide specific steps in build view

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

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-55410 Add label attribute for persistable steps to improve usability

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

          Task - A task that needs to be done. JENKINS-52902 Would a PR be accepted with a new "labelledShell" step, or an optional "label" argument to the "sh" step?

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

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-45101 Display meaningful summaries for metasteps

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

          Web Link CloudBees Internal UX-643

          Web Link PR#1126

          Web Link workflow-api-plugin#26

          Activity

            Ascending order - Click to sort in descending order
            View 66 older comments
            philmcardlecg Phil McArdle added a comment -

            danagoyette, 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.

            philmcardlecg Phil McArdle added a comment - danagoyette , 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.
            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?

            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?
            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.

            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.
            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.

            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 .
            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)

             

            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

              cliffmeyers Cliff Meyers
              jamesdumay James Dumay
              Votes:
              24 Vote for this issue
              Watchers:
              52 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: