Clarify in docs that approvals >= the configured approvals also count
If Code-Review+1 is required as code owner approval, also Code-Review+2
counts as code owner approval. The same is true for overrides. If
Owners-Override+1 is required as code owner override, also
Owners-Override+2 counts as code owner override. Make this clear in the
documentation.
Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I1ec99d8b477c18cba2b963c4ac7db2a10bf45a77
diff --git a/resources/Documentation/config.md b/resources/Documentation/config.md
index c7258e0..c9e7218 100644
--- a/resources/Documentation/config.md
+++ b/resources/Documentation/config.md
@@ -136,6 +136,8 @@
<a id="pluginCodeOwnersRequiredApproval">plugin.@PLUGIN@.requiredApproval</a>
: Approval that is required from code owners to approve the files in a
change.\
+ Any approval on the configured label that has a value >= the configured
+ value is considered as code owner approval.\
The required approval must be specified in the format
"\<label-name\>+\<label-value\>".\
The configured label must exist for all projects for which this setting
@@ -152,6 +154,8 @@
<a id="pluginCodeOwnersOverrideApproval">plugin.@PLUGIN@.overrideApproval</a>
: Approval that counts as override for the code owners submit check.\
+ Any approval on the configured label that has a value >= the configured
+ value is considered as code owner override.\
The override approval must be specified in the format
"\<label-name\>+\<label-value\>".\
Can be specifed multiple times to configure multiple override approvals.
@@ -365,6 +369,8 @@
<a id="codeOwnersRequiredApproval">codeOwners.requiredApproval</a>
: Approval that is required from code owners to approve the files in a
change.\
+ Any approval on the configured label that has a value >= the configured
+ value is considered as code owner approval.\
The required approval must be specified in the format
"\<label-name\>+\<label-value\>".\
The configured label must exist for all projects for which this setting
@@ -383,6 +389,8 @@
<a id="codeOwnersOverrideApproval">codeOwners.overrideApproval</a>
: Approval that counts as override for the code owners submit check.\
+ Any approval on the configured label that has a value >= the configured
+ value is considered as code owner override.\
The override approval must be specified in the format
"\<label-name\>+\<label-value\>".\
Can be specifed multiple times to configure multiple override approvals.
diff --git a/resources/Documentation/rest-api.md b/resources/Documentation/rest-api.md
index b79b178..6ec924e 100644
--- a/resources/Documentation/rest-api.md
+++ b/resources/Documentation/rest-api.md
@@ -615,8 +615,8 @@
| `general` | optional | The general code owners configuration as [GeneralInfo](#general-info) entity. Not set if `disabled` is `true`.
| `disabled` | optional | Whether the code owners functionality is disabled for the branch. If `true` the code owners API is disabled and submitting changes doesn't require code owner approvals. Not set if `false`.
| `backend_id`| optional | ID of the code owner backend that is configured for the branch. Not set if `disabled` is `true`.
-| `required_approval` | optional | The approval that is required from code owners to approve the files in a change as [RequiredApprovalInfo](#required-approval-info) entity. The required approval defines which approval counts as code owner approval. Not set if `disabled` is `true`.
-| `override_approval` | optional | Approvals that count as override for the code owners submit check as a list of [RequiredApprovalInfo](#required-approval-info) entities. If multiple approvals are returned, any of them is sufficient to override the code owners submit check. All returned override approvals are guarenteed to have distinct label names. If unset, overriding the code owners submit check is disabled. Not set if `disabled` is `true`.
+| `required_approval` | optional | The approval that is required from code owners to approve the files in a change as [RequiredApprovalInfo](#required-approval-info) entity. The required approval defines which approval counts as code owner approval. Any approval on this label with a value >= the given value is considered as code owner approval. Not set if `disabled` is `true`.
+| `override_approval` | optional | Approvals that count as override for the code owners submit check as a list of [RequiredApprovalInfo](#required-approval-info) entities. If multiple approvals are returned, any of them is sufficient to override the code owners submit check. All returned override approvals are guarenteed to have distinct label names. Any approval on these labels with a value >= the given values is considered as code owner override. If unset, overriding the code owners submit check is disabled. Not set if `disabled` is `true`.
| `no_code_owners_defined` | optional | Whether the branch doesn't contain any code owner config file yet. If a branch doesn't contain any code owner config file yet, the projects owners are considered as code owners. Once a first code owner config file is added to the branch, the project owners are no longer code owners (unless code ownership is granted to them via the code owner config file). Not set if `false` or if `disabled` is `true`.
---
