Skip to content

Commit 490183d

Browse files
committed
docs(repository): document update comment strategy
Add documentation for update comment strategy option. This strategy creates a single comment per PipelineRun that gets updated with new status and commit SHA on re-execution. Signed-off-by: Akshay Pant <akshay.akshaypant@gmail.com>
1 parent ceb02b6 commit 490183d

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

docs/content/docs/guide/repositorycrd.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -135,16 +135,20 @@ help reduce notification volume for repositories that use long-lasting
135135
Pull/Merge requests with many PipelineRuns.
136136

137137
Acceptable values for `spec.<provider>.comment_strategy` are `""`
138-
(default) and `"disable_all"`.
138+
(default), `"update"` and `"disable_all"`.
139+
140+
Setting `comment_strategy` to `update` adds a single comment for
141+
each PipelineRun. When the status is updated or the PipelineRun is re-executed,
142+
this comment is updated with the new status and the associated commit SHA.
139143

140144
When you set the value of `comment_strategy` to `disable_all`, Pipelines
141145
as Code will not add any comment on the Pull/Merge Request related to
142146
PipelineRun status.
143147

144-
Note: The `disable_all` strategy applies only to comments about a
145-
PipelineRun's status (e.g., "started," "succeeded"). Comments may still
146-
appear if there are errors validating PipelineRuns in the `.tekton`
147-
directory. (See [Running the PipelineRun docs](../running/#errors-when-parsing-pipelinerun-yaml) for details)
148+
Note: The `update` and `disable_all` strategy applies only to
149+
comments about a PipelineRun's status (e.g., "started," "succeeded").
150+
Comments may still appear if there are errors validating PipelineRuns in
151+
the `.tekton` directory. (See [Running the PipelineRun docs](../running/#errors-when-parsing-pipelinerun-yaml) for details)
148152

149153
### GitLab
150154

0 commit comments

Comments
 (0)