Add doc for step display name support

Author: valAndre07

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
@@ -6970,6 +6983,19 @@ StepActionSpec
 <table>
 <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>description</code><br/>
 <em>
 string
@@ -7819,6 +7845,19 @@ Refer Go&rsquo;s ParseDuration documentation for expected format: <a href="https
 <tbody>
 <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>description</code><br/>
 <em>
 string
@@ -9179,6 +9218,19 @@ StepActionSpec
 <table>
 <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>description</code><br/>
 <em>
 string
@@ -13516,6 +13568,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
@@ -14032,6 +14097,19 @@ WhenExpressions
 <tbody>
 <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>description</code><br/>
 <em>
 string
@@ -14373,6 +14451,19 @@ Cannot be updated.</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)
+  - [`displayName`](#declaring-displayName)
 
 [kubernetes-overview]:
   https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields
@@ -384,6 +385,22 @@ spec:
   script: ...
 ```
 
+### Declaring 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
+apiVersion: tekton.dev/v1
+kind: StepAction
+metadata:
+  name: myStep
+spec:
+  displayName: 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/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