Skip to content

Note case-sensitivity of CODEOWERS in CODEOWNERS syntax docs #13708

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

Merged
merged 4 commits into from
Feb 1, 2022
Merged

Note case-sensitivity of CODEOWERS in CODEOWNERS syntax docs #13708

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5df1f7e
Note case-sensitivity in CODEOWNERS file
chrisgarber Jan 4, 2022
e31b824
Remove duplicate example sections
chrisgarber Jan 4, 2022
d8fff82
Use reusable for GitHub name
ethanpalm Feb 1, 2022
f327a07
Merge branch 'main' into main
ethanpalm Feb 1, 2022
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
21 changes: 6 additions & 15 deletions ...ositorys-settings-and-features/customizing-your-repository/about-code-owners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ To reduce the size of your CODEOWNERS file, consider using wildcard patterns to
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. Users must have `read` access to the repository and teams must have explicit `write` access, even if the team's members already have access. You can also refer to a user by an email address that has been added to their account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, for example `[email protected]`.

If any line in your CODEOWNERS file contains invalid syntax, the file will not be detected and will not be used to request reviews.

CODEOWNERS paths are case sensitive, because {% data variables.product.prodname_dotcom %} uses a case sensitive file system. Since CODEOWNERS are evaluated by {% data variables.product.prodname_dotcom %}, even systems that are case insensitive (for example, macOS) must use paths and files that are cased correctly in the CODEOWNERS file.
### Example of a CODEOWNERS file
```
# This is a comment.
Expand Down Expand Up @@ -97,6 +99,10 @@ apps/ @octocat
# subdirectories.
/docs/ @doctocat

# In this example, any change inside the `/scripts` directory
# will require approval from @doctocat or @octocat.
/scripts/ @doctocat @octocat

# In this example, @octocat owns any file in the `/apps`
# directory in the root of your repository except for the `/apps/github`
# subdirectory, as its owners are left empty.
Expand All @@ -112,21 +118,6 @@ There are some syntax rules for gitignore files that do not work in CODEOWNERS f
## CODEOWNERS and branch protection
Repository owners can add branch protection rules to ensure that changed code is reviewed by the owners of the changed files. For more information, see "[About protected branches](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)."

### Example of a CODEOWNERS file
```
# In this example, any change inside the `/apps` directory
# will require approval from @doctocat.
/apps/ @doctocat

# In this example, any change inside the `/apps` directory
# will require approval from @doctocat or @octocat.
/apps/ @doctocat @octocat

# In this example, any change inside the `/apps` directory
# will require approval from a member of the @example-org/content team.
/apps/ @example-org/content-team
```


## Further reading

Expand Down