Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zendesk/setup-check-codeowners
A script to check .github/CODEOWNERS, and a GitHub Action to install it
https://github.com/zendesk/setup-check-codeowners
check ci codeowners lint
Last synced: about 2 months ago
JSON representation
A script to check .github/CODEOWNERS, and a GitHub Action to install it
- Host: GitHub
- URL: https://github.com/zendesk/setup-check-codeowners
- Owner: zendesk
- License: mit
- Created: 2021-08-26T12:08:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T09:38:39.000Z (8 months ago)
- Last Synced: 2024-05-01T19:57:33.694Z (8 months ago)
- Topics: check, ci, codeowners, lint
- Language: Ruby
- Homepage:
- Size: 191 KB
- Stars: 1
- Watchers: 137
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# setup-check-codeowners
A script to check `.github/CODEOWNERS`, and a GitHub Action to install it.
Features include:
- lookups
- given a file, find the owner
- given an owner, find their files
- coverage
- find files which don't have a codeowner
- find codeowner entries which don't match any files
- linting
- find invalid codeowner definitions
- check codeowners are alphabetical
- check consistent indents
See [Usage](Usage.md) for details.
## Usage of the Github Action
This adds `check-codeowners` script to the `PATH`.
```yaml
steps:
- id: setup-check-codeowners
uses: zendesk/setup-check-codeowners@VERSION
```
where `VERSION` is one of the [repo tags](https://github.com/zendesk/setup-check-codeowners/tags)
## Script and Github Action Dependencies
- Ruby (in Github Actions [zendesk/setup-ruby action](https://github.com/zendesk/setup-ruby) can install it)
- Git
## Action Inputs
None.
## Action Output
None.