https://github.com/gitangle/gh-codeowners
✨ An all-in-one solution for your CODEOWNERS needs
https://github.com/gitangle/gh-codeowners
cli codeowners codeowners-validator gh gh-extension
Last synced: about 1 month ago
JSON representation
✨ An all-in-one solution for your CODEOWNERS needs
- Host: GitHub
- URL: https://github.com/gitangle/gh-codeowners
- Owner: gitangle
- Created: 2024-07-20T19:32:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-23T23:00:03.000Z (over 1 year ago)
- Last Synced: 2024-11-13T13:50:48.724Z (over 1 year ago)
- Topics: cli, codeowners, codeowners-validator, gh, gh-extension
- Language: Go
- Homepage:
- Size: 208 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
```ruby
gh extension install github.com/gitangle/gh-codeowners
```
✨ An all-in-one solution for your CODEOWNERS needs
GitHub CLI extension designed to simplify managing and validating CODEOWNERS files directly from your terminal or CI environment.
Like the idea? Give a GitHub star ⭐!
## Quick Start
To install the `codeowners` CLI extension, run:
```sh
gh extension install github.com/gitangle/gh-codeowners
```
Navigate to your repository and run:
```sh
# Validate CODEOWNERS across all repos for the GitHub owner taken from the current repository directory.
gh codeowners validate --all
# Validate CODEOWNERS for a specific owner across all their repos
gh codeowners validate --owner "mszostok" --all
```
## Why?
While GitHub's CODEOWNERS feature is powerful, interpreting the CODEOWNERS data outside of GitHub can be challenging. This tool helps streamline that process.
## Exit Status Codes
The application uses exit status codes to indicate different types of errors:
| Code | Description |
|:-----:|:--------------------------------------------------------------------------------|
| **1** | Application startup failed due to incorrect configuration or an internal error. |
| **3** | CODEOWNERS validation failed due to issues found during checks. |
> [!TIP]
> To prevent the CLI from failing when validation issues are detected, you can set the exit code for validation issues to `0`. Run the following command:
> `gh codeowners validate --issues-exit-code 0`.
## Contributing
We welcome contributions from the community! To contribute, please follow the standard GitHub pull request process.