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

Developer can see a description for a pipeline run

    Details

    • Sprint:
      Blue Ocean 1.1-beta4
    • Similar Issues:

      Description

      Example 1

      node {
         sh 'ping -c 5 localhost'
         currentBuild.description = "go to http://www.apple.com/";
      }
      

        Attachments

          Issue Links

            Activity

            nok Martin Noack created issue -
            nok Martin Noack made changes -
            Field Original Value New Value
            Description In the old ui we are using the "currentBuild.description" to set version and add a html link to the binary deployment.

            It is possible to display the description on each build also in the blue ocean ui?
            In the old ui we are using the "currentBuild.description" to set version string and add a html link to the binary deployment.

            It is possible to display the description on each build also in the blue ocean ui?
            jamesdumay James Dumay made changes -
            Description In the old ui we are using the "currentBuild.description" to set version string and add a html link to the binary deployment.

            It is possible to display the description on each build also in the blue ocean ui?

            *Original request*
            In the old ui we are using the "currentBuild.description" to set version string and add a html link to the binary deployment.
            It is possible to display the description on each build also in the blue ocean ui?

            *Example Pipeline*
            {code}
            node {
               sh 'ping -c 5 localhost'
               currentBuild.description = "go to http://www.apple.com/";
            }
            {code}
            jamesdumay James Dumay made changes -
            Attachment #660 2017-02-07 07-52-49.png [ 35780 ]
            jamesdumay James Dumay made changes -
            Attachment  #660 2017-02-07 07-52-49.png [ 35780 ]
            jamesdumay James Dumay made changes -
            Attachment run.png [ 35781 ]
            Hide
            jamesdumay James Dumay added a comment -

            Martin Noack would it be fine to only display it on the run screen? That would be the screen that looks like the one below

            Show
            jamesdumay James Dumay added a comment - Martin Noack would it be fine to only display it on the run screen? That would be the screen that looks like the one below
            jamesdumay James Dumay made changes -
            Summary Display "description" in build Developer can see a description for a run
            jamesdumay James Dumay made changes -
            Summary Developer can see a description for a run Developer can see a user definable description for a pipeline run
            jamesdumay James Dumay made changes -
            Epic Link JENKINS-35750 [ 171713 ]
            jamesdumay James Dumay made changes -
            Description
            *Original request*
            In the old ui we are using the "currentBuild.description" to set version string and add a html link to the binary deployment.
            It is possible to display the description on each build also in the blue ocean ui?

            *Example Pipeline*
            {code}
            node {
               sh 'ping -c 5 localhost'
               currentBuild.description = "go to http://www.apple.com/";
            }
            {code}
            *Original request*
            In the old ui we are using the "currentBuild.description" to set version string and add a html link to the binary deployment.
            It is possible to display the description on each build also in the blue ocean ui?

            *Example Pipeline*
            {code}
            node {
               sh 'ping -c 5 localhost'
               currentBuild.description = "go to http://www.apple.com/";
            }
            {code}
            Hide
            nok Martin Noack added a comment -

            James Dumay yes that will help!

            I thinking about to add a column in the activity tab on the job overview screen. But the problem should be that there is already a lot of informations and in addition there is not enough space to display more informations. I understand that is to much on one screen.
            But on the other hand the commit informations like id, author and message are displayed on the job overview screen and in the run screen under the register "changes". That is a duplication. Therefore maybe the column "message" on the job overview screen could be replaced with a description column and the commit message will be displayed as a tooltip when we hover with the mouse over the commit id. Is that an idea ?

            If this not acceptable, i am happy with the description in the run screen

            Show
            nok Martin Noack added a comment - James Dumay yes that will help! I thinking about to add a column in the activity tab on the job overview screen. But the problem should be that there is already a lot of informations and in addition there is not enough space to display more informations. I understand that is to much on one screen. But on the other hand the commit informations like id, author and message are displayed on the job overview screen and in the run screen under the register "changes". That is a duplication. Therefore maybe the column "message" on the job overview screen could be replaced with a description column and the commit message will be displayed as a tooltip when we hover with the mouse over the commit id. Is that an idea ? If this not acceptable, i am happy with the description in the run screen
            Hide
            jamesdumay James Dumay added a comment -

            Martin Noack yes, we could use the message column - we are planning to override it when there are no commits to display the trigger reason/build cause. I like that a lot

            Show
            jamesdumay James Dumay added a comment - Martin Noack yes, we could use the message column - we are planning to override it when there are no commits to display the trigger reason/build cause. I like that a lot
            Hide
            nok Martin Noack added a comment -

            James Dumay oka i see that on you live server (https://ci.blueocean.io/blue/organizations/jenkins/blueocean/activity) and i understand that. So in job run will be okay ...

            Show
            nok Martin Noack added a comment - James Dumay oka i see that on you live server ( https://ci.blueocean.io/blue/organizations/jenkins/blueocean/activity ) and i understand that. So in job run will be okay ...
            Hide
            nok Martin Noack added a comment -

            ah as i gorgot please support as html <a href='www/${variable}/fixedstuff'>[binaries]</a>" or in markdown syntax. Important is that we can set alternative display text and groovy variables are resolved and placed into the link

            Show
            nok Martin Noack added a comment - ah as i gorgot please support as html <a href='www/${variable}/fixedstuff'> [binaries] </a>" or in markdown syntax. Important is that we can set alternative display text and groovy variables are resolved and placed into the link
            jamesdumay James Dumay made changes -
            Description *Original request*
            In the old ui we are using the "currentBuild.description" to set version string and add a html link to the binary deployment.
            It is possible to display the description on each build also in the blue ocean ui?

            *Example Pipeline*
            {code}
            node {
               sh 'ping -c 5 localhost'
               currentBuild.description = "go to http://www.apple.com/";
            }
            {code}
            *Scope*
            * {{currentBuild.description}} replaces the trigger reason on the Run screen and Message column on the activity
            ** Overrides any other commit or trigger reason message
            * Escapes HTML but allows hrefs
            ** HREF only displayed on the Run screen
            ** All html including HREF excluded when shown elsewhere, such as the message column

            *Original request*
            In the old ui we are using the "currentBuild.description" to set version string and add a html link to the binary deployment.
            It is possible to display the description on each build also in the blue ocean ui?

            *Example Pipeline*
            {code}
            node {
               sh 'ping -c 5 localhost'
               currentBuild.description = "go to http://www.apple.com/";
            }
            {code}
            Hide
            jamesdumay James Dumay added a comment -

            OK I think we can do that.

            Show
            jamesdumay James Dumay added a comment - OK I think we can do that.
            jamesdumay James Dumay made changes -
            Link This issue is duplicated by JENKINS-43295 [ JENKINS-43295 ]
            jamesdumay James Dumay made changes -
            Labels newbie-friendly
            jamesdumay James Dumay made changes -
            Labels newbie-friendly newbie-friendly pipeline-improvement
            jamesdumay James Dumay made changes -
            Sprint Blue Ocean 1.2 [ 296 ]
            jamesdumay James Dumay made changes -
            Sprint Blue Ocean 1.2 [ 296 ] Blue Ocean 1.3 [ 311 ]
            jamesdumay James Dumay made changes -
            Link This issue relates to JENKINS-43762 [ JENKINS-43762 ]
            jamesdumay James Dumay made changes -
            Description *Scope*
            * {{currentBuild.description}} replaces the trigger reason on the Run screen and Message column on the activity
            ** Overrides any other commit or trigger reason message
            * Escapes HTML but allows hrefs
            ** HREF only displayed on the Run screen
            ** All html including HREF excluded when shown elsewhere, such as the message column

            *Original request*
            In the old ui we are using the "currentBuild.description" to set version string and add a html link to the binary deployment.
            It is possible to display the description on each build also in the blue ocean ui?

            *Example Pipeline*
            {code}
            node {
               sh 'ping -c 5 localhost'
               currentBuild.description = "go to http://www.apple.com/";
            }
            {code}
            *Notes*
            We need to do some design work to figure out how to surface this information.

            *Scope*
            TBD

            *Example 1*
            {code}
            node {
               sh 'ping -c 5 localhost'
               currentBuild.description = "go to http://www.apple.com/";
            }
            {code}

            *Example 2*
            {code}
            currentBuild.displayName = 'foo'
            {code}
            jamesdumay James Dumay made changes -
            Summary Developer can see a user definable description for a pipeline run Developer can see a user definable name and description for a pipeline run
            jamesdumay James Dumay made changes -
            Link This issue is duplicated by JENKINS-39850 [ JENKINS-39850 ]
            Hide
            jakauppila Jared Kauppila added a comment -

            James Dumay We are using using a single job to pipeline our infrastructure/code deploys across all of our applications, so we will be looking at the activity page much more often than the run screen. If that information is only accessible on the run screen, we would need to maintain another mapping somewhere else to tie a particular application/environment to a run #.

            Show
            jakauppila Jared Kauppila added a comment - James Dumay We are using using a single job to pipeline our infrastructure/code deploys across all of our applications, so we will be looking at the activity page much more often than the run screen. If that information is only accessible on the run screen, we would need to maintain another mapping somewhere else to tie a particular application/environment to a run #.
            Hide
            jamesdumay James Dumay added a comment -

            Jared Kauppila thats great context - thank you Would you be disadvantaged if you lost the commit information in the Message column and got your currentBuild.description instead?

            Show
            jamesdumay James Dumay added a comment - Jared Kauppila thats great context - thank you Would you be disadvantaged if you lost the commit information in the Message column and got your currentBuild.description instead?
            Hide
            jakauppila Jared Kauppila added a comment -

            James Dumay Nope, that would be perfectly fine. Once we're up and running at scale I don't expect many commits to be coming in, so if we have to click into the run screen to view that information under "changes" is acceptable.

            Will the user be able to define what appears in the Message column? In an above comment, you mention displaying the 'trigger reason/build cause' if there are no commits, but in our case, we would always want to display currentBuild.description regardless.

             

            Show
            jakauppila Jared Kauppila added a comment - James Dumay Nope, that would be perfectly fine. Once we're up and running at scale I don't expect many commits to be coming in, so if we have to click into the run screen to view that information under "changes" is acceptable. Will the user be able to define what appears in the Message column? In an above comment, you mention displaying the 'trigger reason/build cause' if there are no commits, but in our case, we would always want to display currentBuild.description regardless.  
            Hide
            jamesdumay James Dumay added a comment -

            Jared Kauppila I don't intend on creating any UI for the user to set the message at this time.

            Show
            jamesdumay James Dumay added a comment - Jared Kauppila I don't intend on creating any UI for the user to set the message at this time.
            jamesdumay James Dumay made changes -
            Description *Notes*
            We need to do some design work to figure out how to surface this information.

            *Scope*
            TBD

            *Example 1*
            {code}
            node {
               sh 'ping -c 5 localhost'
               currentBuild.description = "go to http://www.apple.com/";
            }
            {code}

            *Example 2*
            {code}
            currentBuild.displayName = 'foo'
            {code}
            *Notes*
            We need to do some design work to figure out how to surface this information.

            *Scope*
            TBD

            *Example 1*
            {code}
            node {
               sh 'ping -c 5 localhost'
               currentBuild.description = "go to http://www.apple.com/";
            }
            {code}
            jamesdumay James Dumay made changes -
            Status Open [ 1 ] In Progress [ 3 ]
            jamesdumay James Dumay made changes -
            Summary Developer can see a user definable name and description for a pipeline run Developer can see a description for a pipeline run
            jamesdumay James Dumay made changes -
            Status In Progress [ 3 ] In Review [ 10005 ]
            jamesdumay James Dumay made changes -
            Sprint Blue Ocean 1.3 [ 311 ] Blue Ocean 1.1-beta3 [ 316 ]
            Hide
            jamesdumay James Dumay added a comment -

            Heres a preview

            Show
            jamesdumay James Dumay added a comment - Heres a preview
            jamesdumay James Dumay made changes -
            Description *Notes*
            We need to do some design work to figure out how to surface this information.

            *Scope*
            TBD

            *Example 1*
            {code}
            node {
               sh 'ping -c 5 localhost'
               currentBuild.description = "go to http://www.apple.com/";
            }
            {code}

            *Example 1*
            {code}
            node {
               sh 'ping -c 5 localhost'
               currentBuild.description = "go to http://www.apple.com/";
            }
            {code}
            Hide
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: James Dumay
            Path:
            src/test/js/multibranch/commitMessages.js
            http://jenkins-ci.org/commit/blueocean-acceptance-test/391c3ddccd6f79a673472815bd2382f8ac404d03
            Log:
            JENKINS-41769 update xpath for branch commit message

            Show
            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: James Dumay Path: src/test/js/multibranch/commitMessages.js http://jenkins-ci.org/commit/blueocean-acceptance-test/391c3ddccd6f79a673472815bd2382f8ac404d03 Log: JENKINS-41769 update xpath for branch commit message
            Hide
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: James William Dumay
            Path:
            src/test/js/multibranch/commitMessages.js
            http://jenkins-ci.org/commit/blueocean-acceptance-test/c38dbbab50a4ede852a1f07278aeeada7196ceee
            Log:
            JENKINS-41769 update xpath for branch commit message (#140)

            Show
            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: James William Dumay Path: src/test/js/multibranch/commitMessages.js http://jenkins-ci.org/commit/blueocean-acceptance-test/c38dbbab50a4ede852a1f07278aeeada7196ceee Log: JENKINS-41769 update xpath for branch commit message (#140)
            Hide
            jamesdumay James Dumay added a comment -

            Will be released in Blue Ocean 1.1

            Show
            jamesdumay James Dumay added a comment - Will be released in Blue Ocean 1.1
            jamesdumay James Dumay made changes -
            Status In Review [ 10005 ] Resolved [ 5 ]
            Resolution Fixed [ 1 ]
            jamesdumay James Dumay made changes -
            Epic Link JENKINS-35750 [ 171713 ] JENKINS-43952 [ 181484 ]
            jamesdumay James Dumay made changes -
            Assignee James Dumay [ jamesdumay ]
            Hide
            jakauppila Jared Kauppila added a comment -

            James Dumay is there a nightly build available somewhere that I could test this out?

            Show
            jakauppila Jared Kauppila added a comment - James Dumay is there a nightly build available somewhere that I could test this out?
            Hide
            jamesdumay James Dumay added a comment -

            Jared Kauppila you can activate the experimental update center to install the beta releases of Blue Ocean. This change isn't in a released beta but I will follow up today and have someone release.

            Show
            jamesdumay James Dumay added a comment - Jared Kauppila you can activate the experimental update center to install the beta releases of Blue Ocean. This change isn't in a released beta but I will follow up today and have someone release.
            Hide
            jamesdumay James Dumay added a comment -

            Jared Kauppila Blue Ocean 1.1-beta4 has been released to the experimental update center and contains this change if you want to try it out.

            Show
            jamesdumay James Dumay added a comment - Jared Kauppila Blue Ocean 1.1-beta4 has been released to the experimental update center and contains this change if you want to try it out.
            jakauppila Jared Kauppila made changes -
            Attachment image-2017-05-11-14-44-44-822.png [ 37735 ]
            Hide
            jakauppila Jared Kauppila added a comment -

            James Dumay Looks good! The only thing I would say is that now that the "Run" content updates from currentBuild.displayName, it's a bit limited as it only displays ~7 characters.

            Show
            jakauppila Jared Kauppila added a comment - James Dumay Looks good! The only thing I would say is that now that the "Run" content updates from currentBuild.displayName, it's a bit limited as it only displays ~7 characters.
            jamesdumay James Dumay made changes -
            Issue Type New Feature [ 2 ] Story [ 10002 ]
            Hide
            kevcodez Kevin Grüneberg added a comment -

            How do I use a Linebreak in the description? I have the Safe HTML Formatter, but neither "\n" not "<br>" trigger a line break.

            Show
            kevcodez Kevin Grüneberg added a comment - How do I use a Linebreak in the description? I have the Safe HTML Formatter, but neither "\n" not "<br>" trigger a line break.
            kevcodez Kevin Grüneberg made changes -
            Link This issue is related to JENKINS-45181 [ JENKINS-45181 ]
            vgaidarji Veaceslav Gaidarji made changes -
            Attachment Screen Shot 2017-07-04 at 10.56.03 AM.png [ 38729 ]
            vgaidarji Veaceslav Gaidarji made changes -
            Attachment Screen Shot 2017-07-04 at 10.56.03 AM.png [ 38729 ]
            vgaidarji Veaceslav Gaidarji made changes -
            Attachment description_url_2.png [ 38730 ]
            Attachment description_url_1.png [ 38731 ]
            vgaidarji Veaceslav Gaidarji made changes -
            Attachment description_url_blue_ocean.png [ 38732 ]
            Hide
            vgaidarji Veaceslav Gaidarji added a comment -

            With Safe HTML Formatter I can add links to currentBuild.description and links will be rendered correctly everywhere except Blue Ocean plugin:

            vs

            Are there any plans to support HTML tags in Blue Ocean build description?

            Show
            vgaidarji Veaceslav Gaidarji added a comment - With Safe HTML Formatter I can add links to currentBuild.description and links will be rendered correctly everywhere except Blue Ocean plugin: vs Are there any plans to support HTML tags in Blue Ocean build description?
            Hide
            kevcodez Kevin Grüneberg added a comment -

            Veaceslav Gaidarji I opened JENKINS-45181 because I expected the description to support <br> (Safe HTML).

            Quoting James Dumay 

             

             the design we have only caters for a single line on both the messages column and the pipeline result details header. Allowing arbitrary amounts of formatting and information there would significantly impact the design. Ill be honest, we are unlikely to change that in the next year. However sometime next year we are planning a redesign of those screens so we could consider it then.

             

            I would like to see HTML being supported in the description aswell.

            Show
            kevcodez Kevin Grüneberg added a comment - Veaceslav Gaidarji I opened JENKINS-45181 because I expected the description to support <br> (Safe HTML). Quoting James Dumay      the design we have only caters for a single line on both the messages column and the pipeline result details header. Allowing arbitrary amounts of formatting and information there would significantly impact the design. Ill be honest, we are unlikely to change that in the next year. However sometime next year we are planning a redesign of those screens so we could consider it then.   I would like to see HTML being supported in the description aswell.
            Hide
            quas Jakub Pawlinski added a comment -

            Is there a way to turn this feature off?

             

            Show
            quas Jakub Pawlinski added a comment - Is there a way to turn this feature off?  
            Hide
            jamesdumay James Dumay added a comment -

            Yes by not setting the description for your pipeline

            Show
            jamesdumay James Dumay added a comment - Yes by not setting the description for your pipeline
            Hide
            quas Jakub Pawlinski added a comment -

            My pipelines were already using description property before this fix, generating a fancy html table with loads of useful links and such. It works well outside of blue ocean where now I'm getting half of page of html gibberish. 

            Show
            quas Jakub Pawlinski added a comment - My pipelines were already using description property before this fix, generating a fancy html table with loads of useful links and such. It works well outside of blue ocean where now I'm getting half of page of html gibberish. 
            Hide
            jamesdumay James Dumay added a comment -

            Jakub Pawlinski I understand. Could you open a new ticket with your use case and we can evaluate it from there?

            Show
            jamesdumay James Dumay added a comment - Jakub Pawlinski I understand. Could you open a new ticket with your use case and we can evaluate it from there?
            Show
            quas Jakub Pawlinski added a comment - Created  https://issues.jenkins-ci.org/browse/JENKINS-45719
            jamesdumay James Dumay made changes -
            Link This issue relates to JENKINS-45719 [ JENKINS-45719 ]

              People

              • Assignee:
                jamesdumay James Dumay
                Reporter:
                nok Martin Noack
              • Votes:
                3 Vote for this issue
                Watchers:
                11 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: