Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heaths/gh-codeowners
GitHub CLI extension to lint CODEOWNERS
https://github.com/heaths/gh-codeowners
codeowners gh-extension
Last synced: 3 months ago
JSON representation
GitHub CLI extension to lint CODEOWNERS
- Host: GitHub
- URL: https://github.com/heaths/gh-codeowners
- Owner: heaths
- License: mit
- Created: 2023-04-12T01:19:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-29T04:24:37.000Z (3 months ago)
- Last Synced: 2024-10-06T15:23:09.061Z (3 months ago)
- Topics: codeowners, gh-extension
- Language: Go
- Homepage:
- Size: 235 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# CODEOWNERS GitHub CLI extension
[](https://github.com/heaths/gh-codeowners/releases/latest)
[](https://github.com/heaths/gh-codeowners/actions/workflows/ci.yml)
Lint your CODEOWNERS file.
## Install
Make sure you have version 2.0 or [newer] of the [GitHub CLI] installed.
```bash
gh extension install heaths/gh-codeowners
```
### Upgrade
The `gh extension list` command shows if updates are available for extensions. To upgrade, you can use the `gh extension upgrade` command:
```bash
gh extension upgrade heaths/gh-codeowners
# Or upgrade all extensions:
gh extension upgrade --all
```
When used in Continuous Integration, starting with `gh` version [2.25.0](https://github.com/cli/cli/releases/tag/v2.25.0), you can install or upgrade the extension with a single command:
```bash
gh extension install --force heaths/gh-codeowners
```
## Usage
### Lint
Render a list of errors based on the current branch's CODEOWNERS errors reported by GitHub:
```bash
gh codeowners lint
```
You can also get a sorted list of unknown owners or just return the raw JSON:
```bash
gh codeowners lint --json
gh codeowners lint --unknown-owners
```
### PR
To see the codeowners for each file in a pull request:
```bash
gh codeowners pr 123
```
The output is rendered as colorful, formatted JSON in terminals but will be compact JSON when piped to another program like `jq`:
```bash
# Check for added files.
gh codeowners pr 123 | jq '.[] | select(.changeType=="ADDED")'
```
### View
To render your CODEOWNERS file with errors reported by GitHub:
```bash
gh codeowners view
```
## Configuration
This extension will render colors whenever possible and, in some scenarios like when printing a list of errors,
maybe change the format to prefer colors over markers that may work better only for non-colored text.
You can override these colors on the command line (pass `--help` for details) or permanently with a configuration file
located under your home directory on all platforms: _~/.config/gh-codeowners/config.yml_
```yaml
color:
comment: "#6A9955"
error: "#F44747"
```
[GitHub CLI]: https://github.com/cli/cli
[newer]: https://github.com/cli/cli/releases/latest
## License
Licensed under the [MIT](LICENSE.txt) license.