From 82816c31939358cd39640c5fc222c9568387c724 Mon Sep 17 00:00:00 2001
From: Chitrang Patel <chitrang@google.com>
Date: Wed, 3 Apr 2024 15:01:26 -0400
Subject: [PATCH] Add description to StepActions

This PR adds a `description` field to StepActions.
It enables users to add description for readability and UI.
Fixes https://github.com/tektoncd/pipeline/issues/7822

Signed-off-by: Chitrang Patel <chitrang@google.com>
---
 docs/pipeline-api.md                          | 26 +++++++++++++++++++
 .../pipeline/v1alpha1/openapi_generated.go    |  7 +++++
 .../pipeline/v1alpha1/stepaction_types.go     |  4 +++
 pkg/apis/pipeline/v1alpha1/swagger.json       |  4 +++
 4 files changed, 41 insertions(+)

diff --git a/docs/pipeline-api.md b/docs/pipeline-api.md
index 4bee675fe6d..5a07522b52b 100644
--- 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
index 99ad0a618f6..93704735c87 100644
--- a/pkg/apis/pipeline/v1alpha1/openapi_generated.go
+++ b/pkg/apis/pipeline/v1alpha1/openapi_generated.go
@@ -754,6 +754,13 @@ func schema_pkg_apis_pipeline_v1alpha1_StepActionSpec(ref common.ReferenceCallba
 				Description: "StepActionSpec contains the actionable components of a step.",
 				Type:        []string{"object"},
 				Properties: map[string]spec.Schema{
+					"description": {
+						SchemaProps: spec.SchemaProps{
+							Description: "Description is a user-facing description of the stepaction that may be used to populate a UI.",
+							Type:        []string{"string"},
+							Format:      "",
+						},
+					},
 					"image": {
 						SchemaProps: spec.SchemaProps{
 							Description: "Image reference name to run for this StepAction. More info: https://kubernetes.io/docs/concepts/containers/images",
diff --git a/pkg/apis/pipeline/v1alpha1/stepaction_types.go b/pkg/apis/pipeline/v1alpha1/stepaction_types.go
index 2e90321b142..c0b25d8e306 100644
--- 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
index 8aeabcc9c43..4da8930fc32 100644
--- 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",