Skip to content

Tool for identifying the owners of files under Github's CODEOWNERS feature.

License

Notifications You must be signed in to change notification settings

nmusolino/codeowners

Repository files navigation

codeowners

Documentation Status

Utility for identifying the owners of files under Github's CODEOWNERS feature.

Github repository users can designate `code owners`_ for files within their repos. Code owners are automatically added as reviewers of pull requests, and, optionally, their approval is required to merge pull requests for designated branches.

As detailed in Github's documentation, CODEOWNERS files are very similar to .gitignore files.

The codeowners utility is intended to help developers working with this feature:

$ codeowners src/mylib.h src/main.c
src/mylib.h:  @psmith @rgonzalez
src/main.c:  @psmith @njohnson

Features

List owners of each file in a repository:

$ codeowners notes.txt src/ tests/
notes.txt:  @agreen
src/mylib.h:  @psmith @rgonzalez

Identify the specific pattern in the CODEOWNERS file that designates owners:

$ codeowners --verbose src/mylib.h
.github/CODEOWNERS:37: src/**.h: src/mylib.h: @psmith @rgonzalez

Identify all the owners of files modified by git commits:

$ codeowners --commits c0f5855954ce47f93cce353d4d9b9a9e2a92b9a5
[...]
$ codeowners --commits my_feature_branch
[...]

License

This is free software. It is made available under the GNU General Public License v3.

Credits

This package was created with Cookiecutter and the elgertam/cookiecutter-pipenv project template, based on audreyr/cookiecutter-pypackage.

About

Tool for identifying the owners of files under Github's CODEOWNERS feature.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published