Commit ae693bf7 authored by Vlad Stoianovici's avatar Vlad Stoianovici Committed by Ronan OConnor

Make codeowners docs more clear

parent 94852ee7
...@@ -77,6 +77,9 @@ Once set, Code Owners are displayed in merge requests widgets: ...@@ -77,6 +77,9 @@ Once set, Code Owners are displayed in merge requests widgets:
![MR widget - Code Owners](img/code_owners_mr_widget_v12_4.png) ![MR widget - Code Owners](img/code_owners_mr_widget_v12_4.png)
NOTE: **Note**:
While the`CODEOWNERS` file can be used in addition to Merge Request [Approval Rules](merge_requests/merge_request_approvals.md#approval-rules) it can also be used as the sole driver of a Merge Request approval (without using [Approval Rules](merge_requests/merge_request_approvals.md#approval-rules)) by simply creating the file in one of the three locations specified above, configuring the Code Owners to be required approvers for [protected branches](protected_branches.md#protected-branches-approval-by-code-owners-premium) and then using [the syntax of Code Owners files](code_owners.md#the-syntax-of-code-owners-files) to specify the actual owners and granular permissions.
## The syntax of Code Owners files ## The syntax of Code Owners files
Files can be specified using the same kind of patterns you would use Files can be specified using the same kind of patterns you would use
...@@ -96,14 +99,17 @@ escaped using `\#` to address files for which the name starts with a ...@@ -96,14 +99,17 @@ escaped using `\#` to address files for which the name starts with a
Example `CODEOWNERS` file: Example `CODEOWNERS` file:
```plaintext ```plaintext
# This is an example code owners file, lines starting with a `#` will # This is an example of a code owners file
# be ignored. # lines starting with a `#` will be ignored.
# app/ @commented-rule # app/ @commented-rule
# We can specify a default match using wildcards: # We can specify a default match using wildcards:
* @default-codeowner * @default-codeowner
# We can also specify "multiple tab or space" separated codeowners:
* @multiple @code @owners
# Rules defined later in the file take precedence over the rules # Rules defined later in the file take precedence over the rules
# defined before. # defined before.
# This will match all files for which the file name ends in `.rb` # This will match all files for which the file name ends in `.rb`
...@@ -113,6 +119,8 @@ Example `CODEOWNERS` file: ...@@ -113,6 +119,8 @@ Example `CODEOWNERS` file:
\#file_with_pound.rb @owner-file-with-pound \#file_with_pound.rb @owner-file-with-pound
# Multiple codeowners can be specified, separated by spaces or tabs # Multiple codeowners can be specified, separated by spaces or tabs
# In the following case the CODEOWNERS file from the root of the repo
# has 3 code owners (@multiple @code @owners)
CODEOWNERS @multiple @code @owners CODEOWNERS @multiple @code @owners
# Both usernames or email addresses can be used to match # Both usernames or email addresses can be used to match
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment