[Issue 9032] Add support for step display name

A step in a task is currently represented in the UI using a field (name).
That is meant to be machine readable, not human readable.

A new field displayName is added to Step.

Author: valAndre07

config/300-crds/300-task.yaml

@@ -2985,6 +2985,11 @@ spec:
                         items:
                           type: string
                         x-kubernetes-list-type: atomic
+                      displayName:
+                        description: |-
+                          DisplayName is a user-facing name of the step that may be
+                          used to populate a UI.
+                        type: string
                       env:
                         description: |-
                           List of environment variables to set in the container.
@@ -6624,6 +6629,11 @@ spec:
                                 - type: integer
                                 - type: string
                               x-kubernetes-int-or-string: true
+                      displayName:
+                        description: |-
+                          DisplayName is a user-facing name of the step that may be
+                          used to populate a UI.
+                        type: string
                       env:
                         description: |-
                           List of environment variables to set in the Step.

config/300-crds/300-taskrun.yaml

@@ -6277,6 +6277,11 @@ spec:
                                     - type: integer
                                     - type: string
                                   x-kubernetes-int-or-string: true
+                          displayName:
+                            description: |-
+                              DisplayName is a user-facing name of the step that may be
+                              used to populate a UI.
+                            type: string
                           env:
                             description: |-
                               List of environment variables to set in the Step.

docs/pipeline-api.md

@@ -4389,6 +4389,19 @@ Each Step in a Task must have a unique name.</p>
 </tr>
 <tr>
 <td>
+<code>displayName</code><br/>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>DisplayName is a user-facing name of the step that may be
+used to populate a UI.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>image</code><br/>
 <em>
 string
@@ -13516,6 +13529,19 @@ Each Step in a Task must have a unique name.</p>
 </tr>
 <tr>
 <td>
+<code>displayName</code><br/>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>DisplayName is a user-facing name of the step that may be
+used to populate a UI.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>image</code><br/>
 <em>
 string

docs/stepactions.md

@@ -52,6 +52,7 @@ A `StepAction` definition supports the following fields:
   - [`workingDir`](#declaring-workingdir)
   - [`securityContext`](#declaring-securitycontext)
   - [`volumeMounts`](#declaring-volumemounts)
+  - [`description`](#declaring-description)
 
 [kubernetes-overview]:
   https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields
@@ -384,6 +385,22 @@ spec:
   script: ...
 ```
 
+### Declaring description
+
+The `description` field is an optional field that allows you to add a user-facing name to the step that may be used to populate a UI.
+
+```yaml
+apiVersion: tekton.dev/v1
+kind: StepAction
+metadata:
+  name: myStep
+spec:
+  description: my step
+  params: ...
+  volumeMounts: ...
+  image: ...
+  script: ...
+```
 
 ### Referencing a StepAction
 

docs/tasks.md

@@ -20,6 +20,7 @@ weight: 201
     - [Breakpoint on failure with `onError`](#breakpoint-on-failure-with-onerror)
     - [Redirecting step output streams with `stdoutConfig` and `stderrConfig`](#redirecting-step-output-streams-with-stdoutconfig-and-stderrconfig)
     - [Guarding `Step` execution using `when` expressions](#guarding-step-execution-using-when-expressions)
+    - [Specifying `DisplayName`](#specifying-displayname)
   - [Specifying `Parameters`](#specifying-parameters)
   - [Specifying `Workspaces`](#specifying-workspaces)
   - [Emitting `Results`](#emitting-results)
@@ -599,6 +600,22 @@ The StepState for a skipped step looks like something similar to the below:
 ```
 Where `terminated.exitCode` is `0` and `terminationReason` is `Skipped` to indicate the Step exited successfully and was skipped. 
 
+#### Specifying `DisplayName`
+
+The `displayName` field is an optional field that allows you to add a user-facing name to the step that may be used to populate a UI.
+
+```yaml
+steps:
+  - name: ignore-failure-and-produce-a-result
+    displayName: "Ignore failure and produce a result"
+    onError: continue
+    image: busybox
+    script: |
+      echo -n 123 | tee $(results.result1.path)
+      exit 1
+      echo -n 456 | tee $(results.result2.path)
+```
+
 ### Specifying `Parameters`
 
 You can specify parameters, such as compilation flags or artifact names, that you want to supply to the `Task` at execution time.

examples/v1/pipelineruns/beta/pipelinerun-with-matrix-and-taskrunspecs-param-substitution.yaml

@@ -27,6 +27,7 @@ spec:
             - name: node-type
           steps:
             - name: build-and-push
+              displayName: "Build and push"
               image: ubuntu
               script: |
                 echo "building on $(params.node-type)"

examples/v1/pipelineruns/beta/pipelinerun-with-matrix.yaml

@@ -11,6 +11,7 @@ spec:
     - name: browser
   steps:
     - name: echo
+      displayName: "echo platform and browser"
       image: mirror.gcr.io/alpine
       script: |
         echo "$(params.platform) and $(params.browser)"

examples/v1/pipelineruns/pipeline-with-displayname.yaml

@@ -18,6 +18,7 @@ spec:
       description: The sum of the two provided integers
   steps:
     - name: sum
+      displayName: Do the sum
       image: mirror.gcr.io/bash
       script: |
         #!/usr/bin/env bash

examples/v1/pipelineruns/pipelinerun-with-pipelinespec-and-taskspec.yaml

@@ -12,6 +12,7 @@ spec:
               app: "example"
           steps:
             - name: echo
+              displayName: "echo step"
               image: mirror.gcr.io/ubuntu
               script: |
                 #!/usr/bin/env bash

pkg/apis/pipeline/v1/container_types.go

@@ -25,6 +25,10 @@ type Step struct {
 	// Name of the Step specified as a DNS_LABEL.
 	// Each Step in a Task must have a unique name.
 	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
+	// DisplayName is a user-facing name of the step that may be
+	// used to populate a UI.
+	// +optional
+	DisplayName string `json:"displayName,omitempty"`
 	// Docker image name.
 	// More info: https://kubernetes.io/docs/concepts/containers/images
 	// +optional