You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/docs/guide/repositorycrd.md
+22-11Lines changed: 22 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -126,7 +126,27 @@ right to merge commits to the default branch can change the PipelineRun and have
126
126
access to the infrastructure.
127
127
{{< /hint >}}
128
128
129
-
## Disabling all comments for PipelineRuns on GitLab MR
129
+
## Controlling Pull/Merge Request comment volume
130
+
131
+
For GitHub (Webhook) and GitLab integrations, you can control the types
132
+
of Pull/Merge request comments which Pipelines as Code emits using
133
+
the `spec.<provider>.comment_strategy` setting. This can
134
+
help reduce notification volume for Repositories which use long-lasting
135
+
Pull/Merge requests with many PipelineRuns.
136
+
137
+
Acceptable values for `spec.<provider>.comment_strategy` are `""`
138
+
(default) and `"disable_all"`.
139
+
140
+
When you set the value of `comment_strategy` to `disable_all` Pipelines
141
+
as Code will not add any comment on the Pull/Merge Request related to
142
+
PipelineRun status.
143
+
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
+
149
+
### GitLab
130
150
131
151
By default, Pipelines-as-Code attempts to update the commit status through the
132
152
GitLab API. It first tries the source project (fork), then falls back to the
@@ -149,8 +169,6 @@ Comments are only posted when:
149
169
- The event type and repository settings allow commenting
150
170
- The `comment_strategy` is not set to `disable_all`
151
171
152
-
To explicitly disable all comments on GitLab Merge Requests for a Repository,
153
-
use the `comment_strategy` setting:
154
172
155
173
```yaml
156
174
spec:
@@ -159,9 +177,7 @@ spec:
159
177
comment_strategy: "disable_all"
160
178
```
161
179
162
-
## Disabling all comments for PipelineRuns in GitHub Pull Requests on GitHub Webhook Setup
163
-
164
-
`comment_strategy`allows you to disable the comments on GitHub PR for a Repository
180
+
### GitHub Webhook
165
181
166
182
```yaml
167
183
spec:
@@ -170,11 +186,6 @@ spec:
170
186
comment_strategy: "disable_all"
171
187
```
172
188
173
-
When `comment_strategy` is set to `disable_all` Pipelines as Code will not create any comment on the pull request for PipelineRun Status
174
-
175
-
Note: The disable_all strategy applies only to comments about a PipelineRun's status (e.g., "started," "succeeded").
176
-
If your PipelineRun YAML definition fails validation, a comment detailing the error will always be posted to the pull request. [see docs](../running/#errors-when-parsing-pipelinerun-yaml)
177
-
178
189
## Concurrency
179
190
180
191
`concurrency_limit`allows you to define the maximum number of PipelineRuns running at any time for a Repository.
0 commit comments