39 lines
1 KiB
Markdown
39 lines
1 KiB
Markdown
[](https://circleci.com/gh/hairyhenderson/go-codeowners/tree/master)
|
|
|
|
# go-codeowners
|
|
|
|
A package that finds and parses [`CODEOWNERS`](https://help.github.com/articles/about-codeowners/) files.
|
|
|
|
Features:
|
|
- operates on local repos
|
|
- doesn't require a cloned repo (i.e. doesn't need a `.git` directory to be
|
|
present at the repo's root)
|
|
- can be called from within a repo (doesn't have to be at the root)
|
|
- will find `CODEOWNERS` files in all documented locations: the repo's root,
|
|
`docs/`, and `.github/` (or `.gitlab/` for GitLab repos)
|
|
|
|
## Usage
|
|
|
|
```console
|
|
go get -u github.com/hairyhenderson/go-codeowners
|
|
```
|
|
|
|
To find the owner of the README.md file:
|
|
|
|
```go
|
|
import "github.com/hairyhenderson/go-codeowners"
|
|
|
|
func main() {
|
|
c, _ := NewCodeowners(cwd())
|
|
owners := c.Owners("README.md")
|
|
for i, o := range owners {
|
|
fmt.Printf("Owner #%d is %s\n", i, o)
|
|
}
|
|
}
|
|
```
|
|
|
|
## License
|
|
|
|
[The MIT License](http://opensource.org/licenses/MIT)
|
|
|
|
Copyright (c) 2018 Dave Henderson
|