git-codeowners's Introduction

git-codeowners

a git extention for Github CODEOWNERS files

Github CODEOWNERS files document ownership over paths within git repositories allowing you to more effectively focus communication with the right people.

install

Homebrew

For osx users, you can use brew to install or update git-codeowners

$ brew install softprops/tools/git-codeowners

To upgrade, just use brew upgrade instead

GH releases

You can download releases for osx and linux directly from github releases

$ cd $HOME/bin
$ curl -L "https://github.com/softprops/git-codeowners/releases/download/v0.1.2/git-codeowners-$(uname -s)-$(uname -m).tar.gz" \
  | tar -xz

Cargo

If you are a rust user can can just use cargo

$ cargo install git-codeowners

usage

git-codeowners is intended for use as a git extention ( a program whose name starts with git- ) to extend your git workflow.

$ git codeowners src/main.rs
@softprops

$ git-codeowners --help
git-codeowners 0.1.2
Github CODEOWNERS answer sheet

USAGE:
    git-codeowners [FLAGS] [OPTIONS] <path>

FLAGS:
    -e, --emails     Only return emails
    -h, --help       Prints help information
    -t, --teams      Only return teams
    -u, --users      Only return users
    -V, --version    Prints version information

OPTIONS:
    -c, --codeowners <codeowners>    An explicit path for a CODEOWNERS file. program will exit 1 if file can not be resolved

ARGS:
    <path>    Path of file in git repo. if '-' is provided path will be read from stdin. program will exit 2 if no owners can be resolved