Skip to content

Commit 82816c3

Browse files
chitrangpateltekton-robot
authored andcommitted
Add description to StepActions
This PR adds a `description` field to StepActions. It enables users to add description for readability and UI. Fixes #7822 Signed-off-by: Chitrang Patel <[email protected]>
1 parent a98770e commit 82816c3

File tree

4 files changed

+41
-0
lines changed

4 files changed

+41
-0
lines changed

docs/pipeline-api.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6783,6 +6783,19 @@ StepActionSpec
67836783
<table>
67846784
<tr>
67856785
<td>
6786+
<code>description</code><br/>
6787+
<em>
6788+
string
6789+
</em>
6790+
</td>
6791+
<td>
6792+
<em>(Optional)</em>
6793+
<p>Description is a user-facing description of the stepaction that may be
6794+
used to populate a UI.</p>
6795+
</td>
6796+
</tr>
6797+
<tr>
6798+
<td>
67866799
<code>image</code><br/>
67876800
<em>
67886801
string
@@ -7619,6 +7632,19 @@ Refer Go&rsquo;s ParseDuration documentation for expected format: <a href="https
76197632
<tbody>
76207633
<tr>
76217634
<td>
7635+
<code>description</code><br/>
7636+
<em>
7637+
string
7638+
</em>
7639+
</td>
7640+
<td>
7641+
<em>(Optional)</em>
7642+
<p>Description is a user-facing description of the stepaction that may be
7643+
used to populate a UI.</p>
7644+
</td>
7645+
</tr>
7646+
<tr>
7647+
<td>
76227648
<code>image</code><br/>
76237649
<em>
76247650
string

pkg/apis/pipeline/v1alpha1/openapi_generated.go

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/apis/pipeline/v1alpha1/stepaction_types.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,10 @@ type StepActionList struct {
7474

7575
// StepActionSpec contains the actionable components of a step.
7676
type StepActionSpec struct {
77+
// Description is a user-facing description of the stepaction that may be
78+
// used to populate a UI.
79+
// +optional
80+
Description string `json:"description,omitempty"`
7781
// Image reference name to run for this StepAction.
7882
// More info: https://kubernetes.io/docs/concepts/containers/images
7983
// +optional

pkg/apis/pipeline/v1alpha1/swagger.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -406,6 +406,10 @@
406406
},
407407
"x-kubernetes-list-type": "atomic"
408408
},
409+
"description": {
410+
"description": "Description is a user-facing description of the stepaction that may be used to populate a UI.",
411+
"type": "string"
412+
},
409413
"env": {
410414
"description": "List of environment variables to set in the container. Cannot be updated.",
411415
"type": "array",

0 commit comments

Comments
 (0)