Add FAQ how to setup code owner overrides Signed-off-by: Edwin Kempin <ekempin@google.com> Change-Id: I482c3a43fcefc452a6838ca86b4ec007cfedb4b4
diff --git a/resources/Documentation/config-faqs.md b/resources/Documentation/config-faqs.md index 73b3cc3..4a86c2e 100644 --- a/resources/Documentation/config-faqs.md +++ b/resources/Documentation/config-faqs.md
@@ -4,6 +4,7 @@ * [How to check if the code owners functionality is enabled for a project or branch](#checkIfEnabled) * [How to avoid issues with code owner config files](#avoidIssuesWithCodeOwnerConfigs) * [How to investigate issues with code owner config files](#investigateIssuesWithCodeOwnerConfigs) +* [How to setup code owner overrides](#setupOverrides) ## <a id="updateCodeOwnersConfig">How to update the code-owners.config file for a project @@ -96,6 +97,41 @@ Also see [above](#avoidIssuesWithCodeOwnerConfigs) how to avoid issues with code owner config files in the first place. +## <a id="setupOverrides">How to setup code owner overrides + +To setup code owner overrides do: + +### 1. Define a label that should count as code owner override: + +Create a [review label](../../../Documentation/config-labels.html) +via the [Create Label REST +endpoint](../../../Documentation/rest-api-projects.html#create-label): + +``` + curl -X PUT -d '{"commit_message": "Create Owners-Override Label", "values": {" 0": "No Override", "+1": "Override"}}' --header "Content-Type: application/json" https://<gerrit-host>/a/projects/<project-name>/labels/Owners-Override +``` + +### 2. Configure this label as override approval: + +Configure the override label via the [Update Code Owner Project Config REST +endpoint](rest-api.html#update-code-owner-project-config): + +``` + curl -X PUT -d '{"override_approvals": ["Owners-Override+1"]}' --header "Content-Type: application/json" https://<gerrit-host>/a/projects/<project-name>/code_owners.project_config +``` +\ +Also see the description of the +[override_approval](config.html#codeOwnersOverrideApproval) configuration +parameter. + +### 3. Assign permissions to vote on the override approval: + +Go to the access screen of your project in the Gerrit web UI and assign +permissions to vote on the override label. + +Alternatively the permissions can also be assigned via the [Set Access REST +endpoint](../../../Documentation/rest-api-projects.html#set-access). + --- Back to [@PLUGIN@ documentation index](index.html)