Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify CODEOWNERS syntax exceptions #1551

Merged
merged 6 commits into from
Dec 10, 2020
Merged

Clarify CODEOWNERS syntax exceptions #1551

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d5f5502
Fix #1407
ajs256 Nov 22, 2020
33f9910
More updates
ajs256 Dec 9, 2020
9ed4b31
Fix link syntax
ajs256 Dec 9, 2020
d2ba4f1
Update content/github/creating-cloning-and-archiving-repositories/abo…
ajs256 Dec 10, 2020
026b458
Merge branch 'main' into patch-2
ajs256 Dec 10, 2020
91c2b93
Merge branch 'main' into patch-2
hubwriter Dec 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions content/github/creating-cloning-and-archiving-repositories/about-code-owners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ For code owners to receive review requests, the CODEOWNERS file must be on the b

### CODEOWNERS syntax

A CODEOWNERS file uses a pattern that follows the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files. The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. You can also refer to a user by an email address that has been added to their {% data variables.product.product_name %} account, for example `user@example.com`.
A CODEOWNERS file uses a pattern that follows most of the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files, with [some exceptions](#syntax-exceptions). The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. You can also refer to a user by an email address that has been added to their {% data variables.product.product_name %} account, for example `user@example.com`.

If any line in your CODEOWNERS file contains invalid syntax, the file will not be detected and will not be used to request reviews. Invalid syntax includes inline comments and user or team names that do not exist on {% data variables.product.product_name %}.
If any line in your CODEOWNERS file contains invalid syntax, the file will not be detected and will not be used to request reviews.
#### Example of a CODEOWNERS file
```
# This is a comment.
Expand Down Expand Up @@ -83,6 +83,13 @@ apps/ @octocat
# subdirectories.
/docs/ @doctocat
```
#### Syntax exceptions
There are some syntax rules for gitignore files that do not work in CODEOWNERS files:
- Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment
- Using `!` to negate a pattern
- Using `[ ]` to define a character range



### Further reading

Expand Down