[JENKINS-37324] Step descriptions proof of concept #39
Conversation
svanoort
changed the title
| } | ||
|
|
||
| @JsonInclude(JsonInclude.Include.NON_NULL) | ||
| public String getParameterDescription() { |
There was a problem hiding this comment.
Would be slightly less confused if plural was used, e.g. getParametersDescription
jglick
changed the title
| import org.jenkinsci.plugins.workflow.actions.TimingAction; | ||
| import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition; | ||
| import org.jenkinsci.plugins.workflow.graph.FlowNode; | ||
| import org.jenkinsci.plugins.workflow.job.WorkflowJob; | ||
| import org.jenkinsci.plugins.workflow.job.WorkflowRun; | ||
| import org.jenkinsci.plugins.workflow.support.steps.StageStep; |
| @@ -5,6 +5,9 @@ | |||
| <div class="node-log-frame {{this.status}}" cbwf-controller="node-log" objectUrl="{{this._links.log.href}}"> | |||
| <div class="node-name"><span class="glyphicon glyphicon-collapse-down" title="Expand"></span><span class="glyphicon glyphicon-collapse-up" title="Collapse"></span> | |||
| {{this.name}} {{#if this.durationMillis}}(self time {{formatTime this.durationMillis}}){{/if}} | |||
| {{#if this.parameterDescription}} | |||
| - {{this.parameterDescription}} | |||
There was a problem hiding this comment.
You're right, good point. I switched to
"name -- argumentsString -- (self time 10 ms)"
I.e.
"Shell Step -- rm -rf / -- (self time 10 hours)"
There was a problem hiding this comment.
I actually was referring to an m-dash —, not a pair of ASCII hyphens --, but whatever. :-)
|
@reviewbybees |
|
@svanoort I know this a POC, but are there any tests? |
|
This pull request originates from a CloudBees employee. At CloudBees, we require that all pull requests be reviewed by other CloudBees employees before we seek to have the change accepted. If you want to learn more about our process please see this explanation. |
|
@bitwiseman Good question. Existing unit tests verify if this breaks anything for us - the net-new stuff is just getters/setters & a template operation -- not really any logic there to test. I did manual testing to verify this works correctly in cases where we both do and do not have ArgumentsActions attached for steps, so am satisfied it works in integration. |
Part of JENKINS-37324 and downstream of jenkinsci/workflow-cps-plugin#98 plus its upstream dependencies.
TODO:
Add sanitization of step description stringsAutomatically handled by Handlebars escaping of content.