Codeowners

This is a CLI tool to generate GitHub CODEOWNERS files from an existing project assuming certain conventions around file annotations and Ruby/Javascript packages. It's also the oxidation of an existing CLI tool written in Ruby.

Targeting a large project, codeowners can be signifcantly faster than codeownership:

$ hyperfine 'codeownership validate' 'codeowners validate'
Benchmark 1: codeownership validate
  Time (mean ± σ):     44.389 s ±  0.219 s    [User: 4.034 s, System: 22.216 s]
  Range (min … max):   44.014 s … 44.738 s    10 runs

Benchmark 2: codeowners validate
  Time (mean ± σ):      7.521 s ±  0.080 s    [User: 8.809 s, System: 44.343 s]
  Range (min … max):    7.361 s …  7.603 s    10 runs

Summary
  codeowners validate ran
    5.90 ± 0.07 times faster than codeownership validate

Command	Mean [s]	Min [s]	Max [s]	Relative
codeownership validate	44.389 ± 0.219	44.014	44.738	5.90 ± 0.07
codeowners validate	7.521 ± 0.080	7.361	7.603	1.00

Documentation

A CLI to validate and generate Github's CODEOWNERS file

Usage: codeowners [OPTIONS] <COMMAND>

Commands:
  for-file               Finds the owner of a given file. [aliases: f]
  for-team               Finds code ownership information for a given team  [aliases: t]
  generate               Generate the CODEOWNERS file and save it to '--codeowners-file-path'. [aliases: g]
  validate               Validate the validity of the CODEOWNERS file. A validation failure will exit with a failure code and a detailed output of the validation errors. [aliases: v]
  generate-and-validate  Chains both `generate` and `validate` commands. [aliases: gv]
  help                   Print this message or the help of the given subcommand(s)

Options:
      --codeowners-file-path <CODEOWNERS_FILE_PATH>
          Path for the CODEOWNERS file [default: ./.github/CODEOWNERS]
      --config-path <CONFIG_PATH>
          Path for the configuration file [default: ./config/code_ownership.yml]
      --project-root <PROJECT_ROOT>
          Path for the root of the project [default: .]
  -h, --help
          Print help
  -V, --version
          Print version

Getting Started

See the CONFIGURATION.md file for more information on how to codeowners.

for-file

Finds the owner of a given file.

$ codeowners for-file javascript/packages/PayrollFlow/index.tsx

Team: Payroll
Team YML: config/teams/payroll.yml
Description: 
- Owner annotation at the top of the file.
- Owner defined in `javascript/packages/PayrollFlow/package.json` with implicity owned glob: `javascript/packages/PayrollFlow/**/**`

for-team

Finds code ownership information for a given team.

$ codeowners for-team Payroll

# Code Ownership Report for `Payroll` Team

## Annotations at the top of file
/javascript/packages/PayrollFlow/index.tsx
/ruby/app/models/payroll.rb

## Team-specific owned globs
This team owns nothing in this category.

## Owner in .codeowner
/ruby/app/payroll/**/**

## Owner metadata key in package.yml
/ruby/packages/payroll_flow/**/**

## Owner metadata key in package.json
/javascript/packages/PayrollFlow/**/**

## Team YML ownership
/config/teams/payroll.yml

## Team owned gems
/gems/payroll_calculator/**/**

Adoption

This is an experimental port, use at your own risk and be prepared to fallback to the Ruby implementation if it stops working, if you still wish to adopt it, here are the instructions:

# sets up a Rust toolchain
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Compile and install locally
gh repo clone rubyatscale/codeowners-rs
cd codeowners-rs
cargo install --path .

# Set an environment variable that switches ZP's commit hook to use the globally installed binary
echo USE_CODEOWNERS_RS=true >> ~/.zshrc

Development

The CLI is written in Rust. Rust provides strong type gurantees and an great ecosystem of CLI libraries. To be able to compile the code locally, you'll need to setup a rust compiler (See https://rustup.rs/):

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh