Getting Started

The following video provides a quick overview on how to get started with Code Owners. You will find below on this page all the detailed instructions.

Want to try it out first? Access the interactive playground where you can check your Code Owner rules.

Configuration

Add configuration file

The first step is to create a file called CODEOWNERS at the root of your repository.

Here is an example for the file including some configuration:

# Put this in a file called CODEOWNERS in the root directory 
# of your repository.

# Every rule line is a file pattern that is followed by one or more Code Owners.

# Scala code is owned by Martin Odersky
**/*.scala @martin_odersky

# Define group
@@@Java_Experts @james_gosling @brian_goetz

# Java files are owned by group members of Java_Experts
**/*.java @@Java_Experts

# You can also use Bitbucket groups which 
# start with '@@' compared to single users.
# This will add all members of the Bitbucket group JS_Experts.
*.js  @@JS_Experts

# You can also specify code owners by email address if you prefer:
docs/*  docs@example.com

# Ordering is important! The last matching file pattern has the highest precedence.
# So if only files in the jvm sub-directories are in the pull request, Bill Joy
# will be the code owner.
jvm/**/*.java @bill_joy

For more details about how owner rules work, see https://mibexsoftware.atlassian.net/wiki/spaces/CODEOWNERS/pages/3026255924

To configure behavior settings of Code Owners, see https://mibexsoftware.atlassian.net/wiki/spaces/CODEOWNERS/pages/3226140679

Add merge checks

You can enforce approvals by a minimum number of reviewers assigned by Code Owners before merging.

To do so, just enable Code Owners minimum approvals as shown below:

Create Pull Requests

Create Pull Requests with automatically assigned reviewers

When you create a Pull Request, reviewers will automatically be assigned based on the content of theCODEOWNERS file present in the destination branch.

If you have enabled the Code Owners minimum approvals merge check, the pull request cannot be merged until the required code owners have approved the pull request:

Auto merge (NEW)

As from version Code Owners 6.0 of Code Owners, you can configure certain Pull Requests to be automatically merged once merge checks are satisfied.

When installing Code Owners 6.0 or higher, DevSensei Auto-Merge will be enabled by default.

It allows you to select, when creating a Pull Request, one of the following options:

Auto-merge: the pull request will be merged as soon as all merge checks are fulfilled (merge checks include requiring review approvals, successful pipeline run…)

Auto-merge with minimum reviewers: the pull request will be merged as soon as:
- all merge checks are fulfilled (except minimum number of reviewers from Code Owners as this feature overrules this check)
- a defined minimum number of reviewers has reviewed it

You can learn more about this auto merge feature by reading the DevSensei Auto Merge documentation.