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

We would like a more meaningful description of a step

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

            Activity

            jamesdumay James Dumay created issue -
            abayer Andrew Bayer made changes -
            Field Original Value New Value
            Component/s pipeline-general [ 21692 ]
            abayer Andrew Bayer made changes -
            Component/s workflow-plugin [ 18820 ]
            jglick Jesse Glick made changes -
            Link This issue duplicates JENKINS-31582 [ JENKINS-31582 ]
            jglick Jesse Glick made changes -
            Status Open [ 1 ] Resolved [ 5 ]
            Resolution Duplicate [ 3 ]
            jamesdumay James Dumay made changes -
            Component/s blueocean-plugin [ 21481 ]
            Component/s pipeline [ 21692 ]
            jamesdumay James Dumay made changes -
            Resolution Duplicate [ 3 ]
            Status Resolved [ 5 ] Reopened [ 4 ]
            Assignee Jesse Glick [ jglick ]
            roidelapluie Julien Pivotto made changes -
            Attachment changes.png [ 34892 ]
            jamesdumay James Dumay made changes -
            Link This issue is duplicated by JENKINS-39709 [ JENKINS-39709 ]
            michaelneale Michael Neale made changes -
            Epic Link JENKINS-35750 [ 171713 ]
            jamesdumay James Dumay made changes -
            Summary We would like a more meaningful description of a step via flow nodes We would like a more meaningful description of a step
            michaelneale Michael Neale made changes -
            Labels blueocean x-team adoption blueocean x-team
            svanoort Sam Van Oort made changes -
            Assignee Sam Van Oort [ svanoort ]
            recampbell Ryan Campbell made changes -
            Remote Link This issue links to "workflow-durable-task-step-plugin#22 (Web Link)" [ 15094 ]
            svanoort Sam Van Oort made changes -
            Status Reopened [ 4 ] Open [ 1 ]
            svanoort Sam Van Oort made changes -
            Status Open [ 1 ] In Progress [ 3 ]
            jamesdumay James Dumay made changes -
            Sprint frank [ 156 ]
            jamesdumay James Dumay made changes -
            Rank Ranked lower
            jamesdumay James Dumay made changes -
            Link This issue is duplicated by JENKINS-40400 [ JENKINS-40400 ]
            jamesdumay James Dumay made changes -
            Link This issue is duplicated by JENKINS-28293 [ JENKINS-28293 ]
            jamesdumay James Dumay made changes -
            Priority Minor [ 4 ] Critical [ 2 ]
            jamesdumay James Dumay made changes -
            Sprint frank [ 156 ] frank, christmas [ 156, 176 ]
            jamesdumay James Dumay made changes -
            Sprint frank, christmas [ 156, 176 ] frank, tethys, christmas [ 156, 161, 176 ]
            jamesdumay James Dumay made changes -
            Sprint frank, tethys, christmas [ 156, 161, 176 ] frank, tethys, christmas, pannonian [ 156, 161, 176, 211 ]
            jamesdumay James Dumay made changes -
            Sprint frank, tethys, christmas, pannonian [ 156, 161, 176, 211 ] frank, tethys, christmas, pannonian, iapetus [ 156, 161, 176, 211, 216 ]
            jglick Jesse Glick made changes -
            Link This issue is duplicated by JENKINS-41156 [ JENKINS-41156 ]
            jamesdumay James Dumay made changes -
            Sprint frank, tethys, christmas, pannonian, iapetus [ 156, 161, 176, 211, 216 ] frank, tethys, christmas, pannonian, iapetus, 1.0 [ 156, 161, 176, 211, 216, 221 ]
            jamesdumay James Dumay made changes -
            Rank Ranked higher
            jamesdumay James Dumay made changes -
            Rank Ranked lower
            jamesdumay James Dumay made changes -
            Sprint frank, tethys, christmas, pannonian, iapetus, 1.0 [ 156, 161, 176, 211, 216, 221 ] frank, tethys, christmas, pannonian, iapetus [ 156, 161, 176, 211, 216 ]
            jamesdumay James Dumay made changes -
            Rank Ranked lower
            jamesdumay James Dumay made changes -
            Sprint frank, tethys, christmas, pannonian, iapetus [ 156, 161, 176, 211, 216 ] frank, tethys, christmas, pannonian, iapetus, 1.0 [ 156, 161, 176, 211, 216, 221 ]
            jamesdumay James Dumay made changes -
            Rank Ranked lower
            hektve Hector David made changes -
            Status In Progress [ 3 ] In Review [ 10005 ]
            jamesdumay James Dumay made changes -
            Status In Review [ 10005 ] In Progress [ 3 ]
            jamesdumay James Dumay made changes -
            Sprint frank, tethys, christmas, pannonian, iapetus, 1.0 [ 156, 161, 176, 211, 216, 221 ] frank, tethys, christmas, pannonian, iapetus [ 156, 161, 176, 211, 216 ]
            jamesdumay James Dumay made changes -
            Sprint frank, tethys, christmas, pannonian, iapetus [ 156, 161, 176, 211, 216 ] frank, tethys, christmas, pannonian, iapetus, Dropped [ 156, 161, 176, 211, 216, 256 ]
            jamesdumay James Dumay made changes -
            Rank Ranked higher
            recampbell Ryan Campbell made changes -
            Remote Link This issue links to "workflow-durable-task-step-plugin#22 (Web Link)" [ 15094 ]
            recampbell Ryan Campbell made changes -
            Remote Link This issue links to "workflow-api-plugin#26 (Web Link)" [ 15505 ]
            jamesdumay James Dumay made changes -
            Sprint frank, tethys, christmas, pannonian, iapetus, release candidates [ 156, 161, 176, 211, 216, 256 ] frank, tethys, christmas, pannonian, iapetus, 1.0 [ 156, 161, 176, 211, 216, 221 ]
            michaelneale Michael Neale made changes -
            Link This issue blocks JENKINS-35864 [ JENKINS-35864 ]
            jamesdumay James Dumay made changes -
            Link This issue is duplicated by JENKINS-42624 [ JENKINS-42624 ]
            jamesdumay James Dumay made changes -
            Sprint frank, tethys, christmas, pannonian, iapetus, 1.0 [ 156, 161, 176, 211, 216, 221 ] frank, tethys, christmas, pannonian, iapetus, 1.0, 1.0-rc1 [ 156, 161, 176, 211, 216, 221, 261 ]
            jamesdumay James Dumay made changes -
            Link This issue is duplicated by JENKINS-43030 [ JENKINS-43030 ]
            jamesdumay James Dumay made changes -
            Sprint frank, tethys, christmas, pannonian, iapetus, 1.0, Blue Ocean 1.0-rc3 [ 156, 161, 176, 211, 216, 221, 261 ] frank, tethys, christmas, pannonian, iapetus, 1.0, Blue Ocean 1.0-rc3, Blue Ocean 1.0-rc4 [ 156, 161, 176, 211, 216, 221, 261, 281 ]
            michaelneale Michael Neale made changes -
            Component/s workflow-api-plugin [ 21711 ]
            jamesdumay James Dumay made changes -
            Sprint frank, tethys, christmas, pannonian, iapetus, 1.0, Blue Ocean 1.0-rc3, Blue Ocean 1.0-rc4 [ 156, 161, 176, 211, 216, 221, 261, 281 ] frank, tethys, christmas, pannonian, iapetus, 1.0, Blue Ocean 1.0-rc3, Blue Ocean 1.0-rc4, Blue Ocean - techdebt sprint 1 [ 156, 161, 176, 211, 216, 221, 261, 281, 291 ]
            jamesdumay James Dumay made changes -
            Labels adoption blueocean x-team adoption blueocean pipeline-improvement x-team
            abayer Andrew Bayer made changes -
            Link This issue is duplicated by JENKINS-43545 [ JENKINS-43545 ]
            michaelneale Michael Neale made changes -
            Sprint frank, tethys, christmas, pannonian, iapetus, 1.0, Blue Ocean 1.0-rc3, Blue Ocean 1.0-rc4, Blue Ocean - 1.1-beta-1 [ 156, 161, 176, 211, 216, 221, 261, 281, 291 ] 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 [ 156, 161, 176, 211, 216, 221, 261, 281, 291, 306 ]
            jglick Jesse Glick made changes -
            Link This issue is blocking JENKINS-40536 [ JENKINS-40536 ]
            hrmpw Patrick Wolf made changes -
            Link This issue is duplicated by JENKINS-43793 [ JENKINS-43793 ]
            jamesdumay James Dumay made changes -
            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 [ 156, 161, 176, 211, 216, 221, 261, 281, 291, 306 ] 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-beta3 [ 156, 161, 176, 211, 216, 221, 261, 281, 291, 306, 316 ]
            jamesdumay James Dumay made changes -
            Epic Link JENKINS-35750 [ 171713 ] JENKINS-43952 [ 181484 ]
            michaelneale Michael Neale made changes -
            Status In Progress [ 3 ] In Review [ 10005 ]
            michaelneale Michael Neale made changes -
            Status In Review [ 10005 ] In Progress [ 3 ]
            jamesdumay James Dumay made changes -
            Description 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.

             !unnamed-2.png|thumbnail!
            *Scope*
            * Descriptions for steps reflected from the pipeline API
            * Update the UI of Blue Ocean to display the steps
            ** Mockups at https://github.com/jenkinsci/blueocean-plugin/pull/1005#issuecomment-297893184


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

             !unnamed-2.png|thumbnail!
            jamesdumay James Dumay made changes -
            Attachment unnamed-2.png [ 33581 ]
            jamesdumay James Dumay made changes -
            Description *Scope*
            * Descriptions for steps reflected from the pipeline API
            * Update the UI of Blue Ocean to display the steps
            ** Mockups at https://github.com/jenkinsci/blueocean-plugin/pull/1005#issuecomment-297893184


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

             !unnamed-2.png|thumbnail!
            *Scope*
            * 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
            * Zeplin https://zpl.io/1MtiWN




            *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.
            jamesdumay James Dumay made changes -
            Attachment mockup.png [ 37506 ]
            jamesdumay James Dumay made changes -
            Description *Scope*
            * 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
            * Zeplin https://zpl.io/1MtiWN




            *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.
            *Scope*
            * 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.png|thumbnail!

            *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.
            jamesdumay James Dumay made changes -
            Description *Scope*
            * 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.png|thumbnail!

            *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.
            *Scope*
            * 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*
             !mockup.png|thumbnail!

            *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.
            jamesdumay James Dumay made changes -
            Description *Scope*
            * 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*
             !mockup.png|thumbnail!

            *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.
            *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*
             !mockup.png|thumbnail!

            *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.
            jglick Jesse Glick made changes -
            Link This issue is blocked by JENKINS-43934 [ JENKINS-43934 ]
            jglick Jesse Glick made changes -
            Link This issue is duplicated by JENKINS-36933 [ JENKINS-36933 ]
            jamesdumay James Dumay made changes -
            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 [ 156, 161, 176, 211, 216, 221, 261, 281, 291, 306, 316 ] 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-beta5 [ 156, 161, 176, 211, 216, 221, 261, 281, 291, 306, 316, 321 ]
            michaelneale Michael Neale made changes -
            Status In Progress [ 3 ] Open [ 1 ]
            michaelneale Michael Neale made changes -
            Assignee Sam Van Oort [ svanoort ]
            jamesdumay James Dumay made changes -
            Status Open [ 1 ] In Progress [ 3 ]
            svanoort Sam Van Oort made changes -
            Assignee Sam Van Oort [ svanoort ]
            svanoort Sam Van Oort made changes -
            Assignee Sam Van Oort [ svanoort ]
            svanoort Sam Van Oort made changes -
            Remote Link This issue links to "Wiki Page (Jenkins Wiki)" [ 16925 ]
            michaelneale Michael Neale made changes -
            Assignee Vivek Pandey [ vivek ]
            vivek Vivek Pandey made changes -
            Status In Progress [ 3 ] In Review [ 10005 ]
            jamesdumay James Dumay made changes -
            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 [ 156, 161, 176, 211, 216, 221, 261, 281, 291, 306, 316, 321 ] 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 [ 156, 161, 176, 211, 216, 221, 261, 281, 291, 306, 316, 321, 331 ]
            jamesdumay James Dumay made changes -
            Assignee Vivek Pandey [ vivek ] Cliff Meyers [ cliffmeyers ]
            jamesdumay James Dumay made changes -
            Rank Ranked higher
            jamesdumay James Dumay made changes -
            Status In Review [ 10005 ] In Progress [ 3 ]
            jamesdumay James Dumay made changes -
            Status In Progress [ 3 ] Open [ 1 ]
            jamesdumay James Dumay made changes -
            Attachment #2 2017-06-05 10-50-45.png [ 38227 ]
            jamesdumay James Dumay made changes -
            Priority Critical [ 2 ] Blocker [ 1 ]
            michaelneale Michael Neale made changes -
            Description *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*
             !mockup.png|thumbnail!

            *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.
            *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*
             !mockup.png|thumbnail!

            *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.
            cliffmeyers Cliff Meyers made changes -
            Status Open [ 1 ] In Progress [ 3 ]
            cliffmeyers Cliff Meyers made changes -
            Status In Progress [ 3 ] In Review [ 10005 ]
            cliffmeyers Cliff Meyers made changes -
            Link This issue is related to JENKINS-44718 [ JENKINS-44718 ]
            cliffmeyers Cliff Meyers made changes -
            Remote Link This issue links to "PR#1126 (Web Link)" [ 16962 ]
            cliffmeyers Cliff Meyers made changes -
            Status In Review [ 10005 ] Resolved [ 5 ]
            Resolution Fixed [ 1 ]
            jglick Jesse Glick made changes -
            Link This issue relates to JENKINS-45101 [ JENKINS-45101 ]
            svanoort Sam Van Oort made changes -
            Remote Link This issue links to "Wiki Page (Jenkins Wiki)" [ 16925 ]
            jamesdumay James Dumay made changes -
            Remote Link This issue links to "CloudBees Internal UX-643 (Web Link)" [ 18189 ]
            pustelni Konrad Pustenik made changes -
            Status Resolved [ 5 ] Fixed but Unreleased [ 10203 ]
            svanoort Sam Van Oort made changes -
            Status Fixed but Unreleased [ 10203 ] Closed [ 6 ]
            jglick Jesse Glick made changes -
            Link This issue relates to JENKINS-44094 [ JENKINS-44094 ]
            jglick Jesse Glick made changes -
            Link This issue relates to JENKINS-52902 [ JENKINS-52902 ]
            jglick Jesse Glick made changes -
            Link This issue relates to JENKINS-47101 [ JENKINS-47101 ]
            jglick Jesse Glick made changes -
            Link This issue relates to JENKINS-55410 [ JENKINS-55410 ]

              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: