sigs.k8s.io/prow@v0.0.0-20240503223140-c5e374dc7eb1/pkg/plugins/plugin-config-documented.yaml (about)

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