Add build description

[timja]

Fixes #922

@janfaracik / @lewisbirks any thoughts on the UI for this?

Not sure I like the alerts for this.

Testing done

stage('echo') {
    currentBuild.description = "<strong>This is a really cool description</strong>, this is less interesting. <p>A paragraph</p> <br /> dot dot dot..."
    echo "hi"
}

stage('good bye') {
    echo "see ya"
}

With html formatting:

Simple:

No description (click to expand)

Submitter checklist

• Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
• Ensure that the pull request title represents the desired changelog entry
• Please describe what you did
• Link to relevant issues in GitHub or Jira
• Link to relevant pull requests, esp. upstream and downstream changes
• Ensure you have provided tests that demonstrate the feature works or the issue is fixed

[timja]

Also looks like there's a 'bug' in alerts where p tags don't have their color overridden so may need to fix that if we use alerts.

[felipecrs]

I'm always concerned about use of vertical space, but I got to admit I can't think of a better place for this. It looks nice.

[janfaracik]

How is this? Also agreed on not liking the alert, feels like the wrong use for the component. Can't think of a better icon than (i) - maybe a pencil? Might indicate its editable though...

[lewisbirks]

I think the i is the right choice and yeah pencil to me would indicate editable

[lewisbirks]

Would we want it to be collapsible if it was longer than a line or two?

[janfaracik]

Would we want it to be collapsible if it was longer than a line or two?

Good shout - not sure how well that would work with like HTML descriptions though?

[timja]

Looks good although I think its aligned with the bottom of the icon, looks a little off to me?

---

I think the i is the right choice and yeah pencil to me would indicate editable

TBH they probably should be editable, see the main build page:

---

Would we want it to be collapsible if it was longer than a line or two?

Yeah good idea

[lewisbirks]

Would we want it to be collapsible if it was longer than a line or two?

Good shout - not sure how well that would work with like HTML descriptions though?

This is defo a work in progress and could be down to someone else to style and arrange properly but something like this maybe?

[KalleOlaviNiemitalo]

Is it necessary to have an icon at all?

[janfaracik]

Is it necessary to have an icon at all?

It keeps it consistent/aligned with the details above it - so I'd keep it personally.

[timja]

Happy to ship and iterate or want to make some more tweaks to it?

[janfaracik]

Happy to ship and iterate or want to make some more tweaks to it?

Ship it 🚀

[DreamPWJ]

The description has a UI bug. There is occlusion when there is a picture, the badge information is not displayed, and there is a lot of blank space on the right. I think this is not an elegant design. Please provide a switch or can hide it @timja

[DreamPWJ]

I suggest adding a new column of build descriptions and placing it in the icon position. This way the UI design saves space and is compatible with the previous style width.

[DreamPWJ]

The same UI design principle can be used to build the description of this page. Use the graphic space to place the description above in the blank space below.

[felipecrs]

Maybe it could be made an item in the details bar, which can be hovered to display like the changes details. When clicked, it could be redirected to the main build page, where the description can be better seen.