Skip to content

Commit 591b539

Browse files
ajsirotahubwriter
andauthored
Clarify CODEOWNERS syntax exceptions (#1551)
* Fix #1407 Say that a CODEOWNERS file follows most, but not all, gitignore syntax rules * More updates See #1407 (comment) * Fix link syntax oops! * Update content/github/creating-cloning-and-archiving-repositories/about-code-owners.md Co-authored-by: hubwriter <[email protected]> Co-authored-by: hubwriter <[email protected]>
1 parent 9cd2485 commit 591b539

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

content/github/creating-cloning-and-archiving-repositories/about-code-owners.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ For code owners to receive review requests, the CODEOWNERS file must be on the b
3939

4040
### CODEOWNERS syntax
4141

42-
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 `[email protected]`.
42+
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 `[email protected]`.
4343

44-
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 %}.
44+
If any line in your CODEOWNERS file contains invalid syntax, the file will not be detected and will not be used to request reviews.
4545
#### Example of a CODEOWNERS file
4646
```
4747
# This is a comment.
@@ -83,6 +83,13 @@ apps/ @octocat
8383
# subdirectories.
8484
/docs/ @doctocat
8585
```
86+
#### Syntax exceptions
87+
There are some syntax rules for gitignore files that do not work in CODEOWNERS files:
88+
- Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment
89+
- Using `!` to negate a pattern
90+
- Using `[ ]` to define a character range
91+
92+
8693

8794
### Further reading
8895

0 commit comments

Comments
 (0)