https://github.com/fmenezes/codeowners

CodeOwners decoder provides funcionality to evaluate CODEOWNERS file in Go.
https://github.com/fmenezes/codeowners

codeowners go golang

Last synced: 25 days ago
JSON representation

CodeOwners decoder provides funcionality to evaluate CODEOWNERS file in Go.

• Host: GitHub
• URL: https://github.com/fmenezes/codeowners
• Owner: fmenezes
• License: mit
• Created: 2020-07-17T17:00:39.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-02T11:08:30.000Z (over 4 years ago)
• Last Synced: 2024-10-22T09:48:02.203Z (2 months ago)
• Topics: codeowners, go, golang
• Language: Go
• Homepage:
• Size: 85 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: codeowners.go

Awesome Lists containing this project

README

        
[![Go](https://github.com/fmenezes/codeowners/workflows/Go/badge.svg)](https://github.com/fmenezes/codeowners/actions?query=branch%3Amaster)

[![Go Report Card](https://goreportcard.com/badge/github.com/fmenezes/codeowners)](https://goreportcard.com/report/github.com/fmenezes/codeowners)

[![Coverage](https://coveralls.io/repos/github/fmenezes/codeowners/badge.svg?branch=master)](https://coveralls.io/github/fmenezes/codeowners?branch=master)

[![Godoc](https://godoc.org/github.com/fmenezes/codeowners?status.svg)](https://godoc.org/github.com/fmenezes/codeowners)

# 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.