forked from kubernetes/test-infra
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathplugin-config-documented.yaml
603 lines (502 loc) · 26 KB
/
plugin-config-documented.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
# Built-in plugins specific configuration.
approve:
- # CommandHelpLink is the link to the help page which shows the available commands for each repo.
# The default value is "https://go.k8s.io/bot-commands". The command help page is served by Deck
# and available under https://<deck-url>/command-help, e.g. "https://prow.k8s.io/command-help"
commandHelpLink: ' '
# IgnoreReviewState causes the approve plugin to ignore the GitHub review state. Otherwise:
# * an APPROVE github review is equivalent to leaving an "/approve" message.
# * A REQUEST_CHANGES github review is equivalent to leaving an /approve cancel" message.
ignore_review_state: false
# PrProcessLink is the link to the help page which explains the code review process.
# The default value is "https://git.k8s.io/community/contributors/guide/owners.md#the-code-review-process".
pr_process_link: ' '
# Repos is either of the form org/repos or just org.
repos:
- ""
# RequireSelfApproval requires PR authors to explicitly approve their PRs.
# Otherwise the plugin assumes the author of the PR approves the changes in the PR.
require_self_approval: false
blockades:
- # BlockRegexps are regular expressions matching the file paths to block.
blockregexps:
- ""
# BranchRegexp is the regular expression for branches that the the blockade applies to.
# If BranchRegexp is not specified, the blockade applies to all branches by default.
# Compiles into BranchRe during config load.
branchregexp: ""
# ExceptionRegexps are regular expressions matching the file paths that are exceptions to the BlockRegexps.
exceptionregexps:
- ""
# Explanation is a string that will be included in the comment left when blocking a PR. This should
# be an explanation of why the paths specified are blockaded.
explanation: ' '
# Repos are either of the form org/repos or just org.
repos:
- ""
blunderbuss:
# ReviewerCount is the minimum number of reviewers to request
# reviews from. Defaults to requesting reviews from 2 reviewers
request_count: 0
bugzilla:
# Default settings mapped by branch in any repo in any org.
# The `*` wildcard will apply to all branches.
default:
"":
# AddExternalLink determines whether the pull request will be added to the Bugzilla
# bug using the ExternalBug tracker API after being validated
add_external_link: false
# AllowedGroups is a list of bugzilla bug group names that the bugzilla plugin can
# link to in PRs. If a bug is part of a group that is not in this list, the bugzilla
# plugin will not link the bug to the PR.
allowed_groups:
- ""
# DependentBugStates determine states in which a bug's dependents bugs may be
# to deem the child bug valid. If set, all blockers must have a valid state.
dependent_bug_states: null
# DependentBugStatuses determine which statuses a bug's dependent bugs may have
# to deem the child bug valid. These are merged into DependentBugStates when
# resolving branch options.
dependent_bug_statuses: null
# DeprecatedDependentBugTargetRelease determines which release a
# bug's dependent bugs need to target to be valid. If set, all
# blockers must have a valid target releasee.
# Deprecated: Use DependentBugTargetReleases instead. If set,
# DependentBugTargetRelease will be appended to
# DeprecatedDependentBugTargetReleases.
dependent_bug_target_release: ""
# DependentBugTargetReleases determines the set of valid target
# releases for dependent bugs. If set, all blockers must have a
# valid target release.
dependent_bug_target_releases: null
# ExcludeDefaults excludes defaults from more generic Bugzilla configurations.
exclude_defaults: false
# IsOpen determines whether a bug needs to be open to be valid
is_open: false
# StateAfterClose is the state to which the bug will be moved if all pull requests
# in the external bug tracker have been closed.
state_after_close:
resolution: ' '
status: ' '
# StateAfterMerge is the state to which the bug will be moved after all pull requests
# in the external bug tracker have been merged.
state_after_merge:
resolution: ' '
status: ' '
# StateAfterValidation is the state to which the bug will be moved after being
# deemed valid and linked to a PR. Will implicitly be considered a part of `ValidStates`
# if others are set.
state_after_validation:
resolution: ' '
status: ' '
# StatusAfterMerge is the status which the bug will be moved to after all pull requests
# in the external bug tracker have been merged.
status_after_merge: ""
# StatusAfterValidation is the status which the bug will be moved to after being
# deemed valid and linked to a PR. Will implicitly be considered a part of `statuses`
# if others are set.
status_after_validation: ""
# Statuses determine which statuses a bug may have to be valid
statuses: null
# TargetRelease determines which release a bug needs to target to be valid
target_release: ""
# ValidStates determine states in which the bug may be to be valid
valid_states: null
# ValidateByDefault determines whether a validation check is run for all pull
# requests by default
validate_by_default: false
# Options for specific orgs. The `*` wildcard will apply to all orgs.
orgs:
"":
# Default settings mapped by branch in any repo in this org.
# The `*` wildcard will apply to all branches.
default:
"":
# AddExternalLink determines whether the pull request will be added to the Bugzilla
# bug using the ExternalBug tracker API after being validated
add_external_link: false
# AllowedGroups is a list of bugzilla bug group names that the bugzilla plugin can
# link to in PRs. If a bug is part of a group that is not in this list, the bugzilla
# plugin will not link the bug to the PR.
allowed_groups:
- ""
# DependentBugStates determine states in which a bug's dependents bugs may be
# to deem the child bug valid. If set, all blockers must have a valid state.
dependent_bug_states: null
# DependentBugStatuses determine which statuses a bug's dependent bugs may have
# to deem the child bug valid. These are merged into DependentBugStates when
# resolving branch options.
dependent_bug_statuses: null
# DeprecatedDependentBugTargetRelease determines which release a
# bug's dependent bugs need to target to be valid. If set, all
# blockers must have a valid target releasee.
# Deprecated: Use DependentBugTargetReleases instead. If set,
# DependentBugTargetRelease will be appended to
# DeprecatedDependentBugTargetReleases.
dependent_bug_target_release: ""
# DependentBugTargetReleases determines the set of valid target
# releases for dependent bugs. If set, all blockers must have a
# valid target release.
dependent_bug_target_releases: null
# ExcludeDefaults excludes defaults from more generic Bugzilla configurations.
exclude_defaults: false
# IsOpen determines whether a bug needs to be open to be valid
is_open: false
# StateAfterClose is the state to which the bug will be moved if all pull requests
# in the external bug tracker have been closed.
state_after_close:
resolution: ' '
status: ' '
# StateAfterMerge is the state to which the bug will be moved after all pull requests
# in the external bug tracker have been merged.
state_after_merge:
resolution: ' '
status: ' '
# StateAfterValidation is the state to which the bug will be moved after being
# deemed valid and linked to a PR. Will implicitly be considered a part of `ValidStates`
# if others are set.
state_after_validation:
resolution: ' '
status: ' '
# StatusAfterMerge is the status which the bug will be moved to after all pull requests
# in the external bug tracker have been merged.
status_after_merge: ""
# StatusAfterValidation is the status which the bug will be moved to after being
# deemed valid and linked to a PR. Will implicitly be considered a part of `statuses`
# if others are set.
status_after_validation: ""
# Statuses determine which statuses a bug may have to be valid
statuses: null
# TargetRelease determines which release a bug needs to target to be valid
target_release: ""
# ValidStates determine states in which the bug may be to be valid
valid_states: null
# ValidateByDefault determines whether a validation check is run for all pull
# requests by default
validate_by_default: false
# Options for specific repos. The `*` wildcard will apply to all repos.
repos:
"":
# Options for specific branches in this repo.
# The `*` wildcard will apply to all branches.
branches:
"":
# AddExternalLink determines whether the pull request will be added to the Bugzilla
# bug using the ExternalBug tracker API after being validated
add_external_link: false
# AllowedGroups is a list of bugzilla bug group names that the bugzilla plugin can
# link to in PRs. If a bug is part of a group that is not in this list, the bugzilla
# plugin will not link the bug to the PR.
allowed_groups:
- ""
# DependentBugStates determine states in which a bug's dependents bugs may be
# to deem the child bug valid. If set, all blockers must have a valid state.
dependent_bug_states: null
# DependentBugStatuses determine which statuses a bug's dependent bugs may have
# to deem the child bug valid. These are merged into DependentBugStates when
# resolving branch options.
dependent_bug_statuses: null
# DeprecatedDependentBugTargetRelease determines which release a
# bug's dependent bugs need to target to be valid. If set, all
# blockers must have a valid target releasee.
# Deprecated: Use DependentBugTargetReleases instead. If set,
# DependentBugTargetRelease will be appended to
# DeprecatedDependentBugTargetReleases.
dependent_bug_target_release: ""
# DependentBugTargetReleases determines the set of valid target
# releases for dependent bugs. If set, all blockers must have a
# valid target release.
dependent_bug_target_releases: null
# ExcludeDefaults excludes defaults from more generic Bugzilla configurations.
exclude_defaults: false
# IsOpen determines whether a bug needs to be open to be valid
is_open: false
# StateAfterClose is the state to which the bug will be moved if all pull requests
# in the external bug tracker have been closed.
state_after_close:
resolution: ' '
status: ' '
# StateAfterMerge is the state to which the bug will be moved after all pull requests
# in the external bug tracker have been merged.
state_after_merge:
resolution: ' '
status: ' '
# StateAfterValidation is the state to which the bug will be moved after being
# deemed valid and linked to a PR. Will implicitly be considered a part of `ValidStates`
# if others are set.
state_after_validation:
resolution: ' '
status: ' '
# StatusAfterMerge is the status which the bug will be moved to after all pull requests
# in the external bug tracker have been merged.
status_after_merge: ""
# StatusAfterValidation is the status which the bug will be moved to after being
# deemed valid and linked to a PR. Will implicitly be considered a part of `statuses`
# if others are set.
status_after_validation: ""
# Statuses determine which statuses a bug may have to be valid
statuses: null
# TargetRelease determines which release a bug needs to target to be valid
target_release: ""
# ValidStates determine states in which the bug may be to be valid
valid_states: null
# ValidateByDefault determines whether a validation check is run for all pull
# requests by default
validate_by_default: false
cat:
# Path to file containing an api key for thecatapi.com
key_path: ' '
cherry_pick_unapproved:
# BranchRegexp is the regular expression for branch names such that
# the plugin treats only PRs against these branch names as cherrypick PRs.
# Compiles into BranchRe during config load.
branchregexp: ' '
# Comment is the comment added by the plugin while adding the
# `do-not-merge/cherry-pick-not-approved` label.
comment: ' '
config_updater:
# ClusterGroups is a map of ClusterGroups that can be used as a target
# in the map config.
cluster_groups:
"":
clusters:
- ""
namespaces:
- ""
# If GZIP is true then files will be gzipped before insertion into
# their corresponding configmap
gzip: false
# A map of filename => ConfigMapSpec.
# Whenever a commit changes filename, prow will update the corresponding configmap.
# map[string]ConfigMapSpec{ "/my/path.yaml": {Name: "foo", Namespace: "otherNamespace" }}
# will result in replacing the foo configmap whenever path.yaml changes
maps:
"":
# ClusterGroup is a list of named cluster_groups to target. Mutually exclusive with clusters.
cluster_groups:
- ""
# Clusters is a map from cluster to namespaces
# which specifies the targets the configMap needs to be deployed, i.e., each namespace in map[cluster]
clusters:
"": null
# GZIP toggles whether the key's data should be GZIP'd before being stored
# If set to false and the global GZIP option is enabled, this file will
# will not be GZIP'd.
gzip: false
# Key is the key in the ConfigMap to update with the file contents.
# If no explicit key is given, the basename of the file will be used unless
# use_full_path_as_key: true is set, in which case the full filepath relative
# to the repository root will be used, replacing slashes with dashes.
key: ' '
# Name of ConfigMap
name: ' '
dco:
"":
# TrustedOrg is the org whose members' commits will not be checked for DCO signoff
# if the skip DCO option is enabled. The default is the PR's org.
trusted_org: ' '
# ExternalPlugins is a map of repositories (eg "k/k") to lists of
# external plugins.
external_plugins:
"": null
golint:
# MinimumConfidence is the smallest permissible confidence
# in (0,1] over which problems will be printed. Defaults to
# 0.8, as does the `go lint` tool.
minimum_confidence: 0
goose:
# Path to file containing an api key for unsplash.com
key_path: ' '
heart:
# Adorees is a list of GitHub logins for members
# for whom we will add emojis to comments
adorees:
- ""
# CommentRegexp is the regular expression for comments
# made by adorees that the plugin adds emojis to.
# If not specified, the plugin will not add emojis to
# any comments.
# Compiles into CommentRe during config load.
commentregexp: ' '
help:
# HelpGuidelinesURL is the URL of the help page, which provides guidance on how and when to use the help wanted and good first issue labels.
# The default value is "https://git.k8s.io/community/contributors/guide/help-wanted.md".
help_guidelines_url: ' '
jira:
# DisabledJiraProjects are projects for which we will never try to create a link,
# for example including `enterprise` here would disable linking for all issues
# that start with `enterprise-` like `enterprise-4.` Matching is case-insenitive.
disabled_jira_projects:
- ""
label:
# AdditionalLabels is a set of additional labels enabled for use
# on top of the existing "kind/*", "priority/*", and "area/*" labels.
additional_labels:
- ""
lgtm:
- # Repos is either of the form org/repos or just org.
repos:
- ""
# WARNING: This disables the security mechanism that prevents a malicious member (or
# compromised GitHub account) from merging arbitrary code. Use with caution.
# StickyLgtmTeam specifies the GitHub team whose members are trusted with sticky LGTM,
# which eliminates the need to re-lgtm minor fixes/updates.
trusted_team_for_sticky_lgtm: ' '
milestone_applier:
"": null
override:
# AllowedGitHubTeams is a map of orgs and/or repositories (eg "org" or "org/repo") to list of GitHub team slugs,
# members of which are allowed to override contexts
allowed_github_teams:
"": null
# Owners contains configuration related to handling OWNERS files.
owners:
# Filenames allows configuring repos to use a separate set of filenames for
# any plugin that interacts with these files. Keys are in "org/repo" format.
filenames:
"":
owners: ' '
owners_aliases: ' '
# LabelsBlackList will be removed after October 2021, use
# labels_denylist instead
labels_blacklist:
- ""
# LabelsDenyList holds a list of labels that should not be present in any
# OWNERS file, preventing their automatic addition by the owners-label plugin.
# This check is performed by the verify-owners plugin.
labels_denylist:
- ""
# MDYAMLRepos is a list of org and org/repo strings specifying the repos that support YAML
# OWNERS config headers at the top of markdown (*.md) files. These headers function just like
# the config in an OWNERS file, but only apply to the file itself instead of the entire
# directory and all sub-directories.
# The yaml header must be at the start of the file and be bracketed with "
mdyamlrepos:
- ""
# SkipCollaborators disables collaborator cross-checks and forces both
# the approve and lgtm plugins to use solely OWNERS files for access
# control in the provided repos.
skip_collaborators:
- ""
# Plugins is a map of repositories (eg "k/k") to lists of
# plugin names.
# You can find a comprehensive list of the default available plugins here
# https://github.com/kubernetes/test-infra/tree/master/prow/plugins
# note that you're also able to add external plugins.
plugins:
"":
excluded_repos:
- ""
plugins:
- ""
project_config:
# Org level configs for github projects; key is org name
project_org_configs:
"":
# A map of project name to default column; an issue/PR will be added
# to the default column if column name is not provided in the command
org_default_column_map:
"": ""
# Repo level configs for github projects; key is repo name
project_repo_configs:
"":
# A map of project name to default column; an issue/PR will be added
# to the default column if column name is not provided in the command
repo_default_column_map:
"": ""
project_manager:
orgsRepos:
"":
projects:
"":
columns:
- # Either of ID or Name should be specified
id: 0
# all the labels here should match to the incoming event to be bale to add the card to the project
labels:
- ""
name: ' '
# Configuration is effective is the issue events repo/Owner/Login matched the org
org: ' '
# State must be open, closed or all
state: ' '
repo_milestone:
"":
maintainers_friendly_name: ' '
maintainers_team: ' '
require_matching_label:
- # Branch is the branch ref of PRs that this config applies to.
# This field is only valid if `prs: true` and may be omitted to apply this
# config across all branches in the repo or org.
branch: ' '
# GracePeriod is the amount of time to wait before processing newly opened
# or reopened issues and PRs. This delay allows other automation to apply
# labels before we look for matching labels.
# Defaults to '5s'.
grace_period: ' '
# MissingComment is the comment to post when we add the MissingLabel to an
# issue. This is typically used to explain why MissingLabel was added and
# how to move forward.
# This field is optional. If unspecified, no comment is created when labeling.
missing_comment: ' '
# MissingLabel is the label to apply if an issue does not have any label
# matching the Regexp.
missing_label: ' '
# Org is the GitHub organization that this config applies to.
org: ' '
# Regexp is the string specifying the regular expression used to look for
# matching labels.
regexp: ' '
# Repo is the GitHub repository within Org that this config applies to.
# This fields may be omitted to apply this config across all repos in Org.
repo: ' '
sigmention:
# Regexp parses comments and should return matches to team mentions.
# These mentions enable labeling issues or PRs with sig/team labels.
# Furthermore, teams with the following suffixes will be mapped to
# kind/* labels:
# * @org/team-bugs --maps to--> kind/bug
# * @org/team-feature-requests --maps to--> kind/feature
# * @org/team-api-reviews --maps to--> kind/api-change
# * @org/team-proposals --maps to--> kind/design
# Note that you need to make sure your regexp covers the above
# mentions if you want to use the extra labeling. Defaults to:
# (?m)@kubernetes/sig-([\w-]*)-(misc|test-failures|bugs|feature-requests|proposals|pr-reviews|api-reviews)
# Compiles into Re during config load.
regexp: ' '
slack:
mentionchannels:
- ""
mergewarnings:
- # List of channels on which a event is published.
channels:
- ""
# A slack event is published if the user is not on the exempt branches.
exempt_branches:
"": null
# A slack event is published if the user is not part of the ExemptUsers.
exempt_users:
- ""
# Repos is either of the form org/repos or just org.
repos:
- ""
triggers:
- # JoinOrgURL is a link that redirects users to a location where they
# should be able to read more about joining the organization in order
# to become trusted members. Defaults to the GitHub link of TrustedOrg.
join_org_url: ' '
# Repos is either of the form org/repos or just org.
repos:
- ""
# TrustedOrg is the org whose members' PRs will be automatically built for
# PRs to the above repos. The default is the PR's org.
# Deprecated: TrustedOrg functionality is deprecated and will be removed in
# January 2020.
trusted_org: ' '
welcome:
- # MessageTemplate is the welcome message template to post on new-contributor PRs
# For the info struct see prow/plugins/welcome/welcome.go's PRInfo
message_template: ' '
# Repos is either of the form org/repos or just org.
repos:
- ""