Add description to StepActions

This PR adds a `description` field to StepActions. It enables users to add description for readability and UI. Fixes tektoncd#7822 Signed-off-by: Chitrang Patel <[email protected]>
chitrangpatel · Apr 3, 2024 · 339f38a · 339f38a
1 parent a98770e
commit 339f38a
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 0 deletions.
diff --git a/docs/pipeline-api.md b/docs/pipeline-api.md
@@ -6783,6 +6783,19 @@ StepActionSpec
 <table>
 <tr>
 <td>
+<code>description</code><br/>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Description is a user-facing description of the stepaction that may be
+used to populate a UI.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>image</code><br/>
 <em>
 string
@@ -7619,6 +7632,19 @@ Refer Go&rsquo;s ParseDuration documentation for expected format: <a href="https
 <tbody>
 <tr>
 <td>
+<code>description</code><br/>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Description is a user-facing description of the stepaction that may be
+used to populate a UI.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>image</code><br/>
 <em>
 string

diff --git a/pkg/apis/pipeline/v1alpha1/openapi_generated.go b/pkg/apis/pipeline/v1alpha1/openapi_generated.go
diff --git a/pkg/apis/pipeline/v1alpha1/stepaction_types.go b/pkg/apis/pipeline/v1alpha1/stepaction_types.go
@@ -74,6 +74,10 @@ type StepActionList struct {
 
 // StepActionSpec contains the actionable components of a step.
 type StepActionSpec struct {
+	// Description is a user-facing description of the stepaction that may be
+	// used to populate a UI.
+	// +optional
+	Description string `json:"description,omitempty"`
 	// Image reference name to run for this StepAction.
 	// More info: https://kubernetes.io/docs/concepts/containers/images
 	// +optional

diff --git a/pkg/apis/pipeline/v1alpha1/swagger.json b/pkg/apis/pipeline/v1alpha1/swagger.json
@@ -406,6 +406,10 @@
           },
           "x-kubernetes-list-type": "atomic"
         },
+        "description": {
+          "description": "Description is a user-facing description of the stepaction that may be used to populate a UI.",
+          "type": "string"
+        },
         "env": {
           "description": "List of environment variables to set in the container. Cannot be updated.",
           "type": "array",