CODEOWNERS

CodeOwners package provides funcionality to evaluate CODEOWNERS file in Go. Also provides a CLI to lint.

Documentation

Package

To find package documentation follow https://godoc.org/github.com/fmenezes/codeowners

CLI

Installation

Simply run go get -u github.com/fmenezes/codeowners/cmd/codeownerslint

Usage

Simply calling codeownerslint will kick off the cli on the current directory.

Options

Option	Default Value	Description
d	.	Directory: specifies the directory you want to use to lint the CODEOWNERS file
f		Format: specifies the format you want to return lint results
t		Token: specifies the Github's token you want to use
tt	bearer	Token Type: specifies the Github's token type you want to use

Exit Codes

Exit Code	Description
0	Success: no errors returned
1	Warnings: linter returned a few warnings but no errors
2	Errors: linter returned a few errors
3	Unexpected errors: errors that prevented the linter from running

Compatibility

:warning: This module is on a v0 mode and it is not ready to be used, once it reaches the v1 we will lock the API.