Skip to content

README.md

Latest commit

 

History

History
36 lines (27 loc) · 1.17 KB

README.md

File metadata and controls

36 lines (27 loc) · 1.17 KB

git-codeowners

Parses GitHub CODEOWNERS1 files.

Installation

cargo install --git https://github/triarius/git-codeowners.git

To invoke this as git codeowners instead of /path/to/git-codeowners, ensure that

  1. git is installed and in your PATH
  2. The location cargo installs executables to is in your PATH. This is typically ~/.local/share/cargo/bin.

Usage

Change directory to a git repo with a CODEOWNERS file.

Usage: git-codeowners [OPTIONS] <COMMAND>

Commands:
  of         Find owners for the specified paths. Reads paths from STDIN if not provided as positional arguments
  inventory  Print all files owned by the specified owner
  help       Print this message or the help of the given subcommand(s)

Options:
  -p, --path <PATH>  Path to the CODEOWNERS file [default: .github/CODEOWNERS]
  -h, --help         Print help
  -V, --version      Print version

Detecting CODEOWNERS of all files changed in a branch

git diff (git merge-base origin/main HEAD) --name-only | git codeowners of

Footnotes

  1. See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners ↩