You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,19 @@
1
1
# Codeowners
2
-
The [oxidation](https://wiki.mozilla.org/Oxidation) of an [existing CLI](https://github.com/rubyatscale/code_ownership) written in Ruby.
3
-
This tool generates Github's `CODEOWNERS` file, assuming certain conventions around Ruby/Javascript packages.
2
+
This is a CLI tool to generate Github's `CODEOWNERS` file from an existing project assuming certain conventions around file annotations and Ruby/Javascript packages.
3
+
It's also the [oxidation](https://wiki.mozilla.org/Oxidation) of an existing [CLI tool](https://github.com/rubyatscale/code_ownership) written in Ruby.
4
4
5
5
`CODEOWNERS` generation happens as part of our git commit hooks and on Gusto's main repo takes ~18s to run. The Rust implementation which is a drop in replacement cuts that down to <= 2s. (Tested on a Mackbook M1)
6
6
7
-
```
7
+
### Documentation
8
+
```bash
8
9
A CLI to validate and generate Github's CODEOWNERS file
9
10
10
11
Usage: codeowners [OPTIONS] <COMMAND>
11
12
12
13
Commands:
13
14
generate Generate the CODEOWNERS file and save it to '--codeowners-file-path'
14
15
validate Validate the validity of the CODEOWNERS file. A validation failure will exit with a failure code and a detailed output of the validation errors
15
-
generate-and-validate Chains both 'generate' and 'verify' commands
16
+
generate-and-validate Chains both 'generate' and 'validate' commands
16
17
help Print this message or the help of the given subcommand(s)
0 commit comments