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-20Lines changed: 5 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
1
# Codeowners
2
+
2
3
This is a CLI tool to generate [GitHub `CODEOWNERS` files](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) from an existing project assuming certain conventions around file annotations and Ruby/Javascript packages.
3
4
It's also the [oxidation](https://wiki.mozilla.org/Oxidation) of an existing [CLI tool](https://github.com/rubyatscale/code_ownership) written in Ruby.
A CLI to validate and generate Github's CODEOWNERS file
@@ -52,9 +53,9 @@ Options:
52
53
Print version
53
54
```
54
55
55
-
####Getting Started
56
+
### Getting Started
56
57
57
-
See the [CONFIGURATION.md](CONFIGURATION.md) file for more information on how to codeowners.
58
+
See the [CONFIGURATION.md](CONFIGURATION.md) file for more information on how to configure codeowners.
58
59
59
60
#### for-file
60
61
@@ -103,24 +104,8 @@ This team owns nothing in this category.
103
104
/gems/payroll_calculator/**/**
104
105
```
105
106
106
-
107
-
### Adoption
108
-
This is an experimental port, use at your own risk and be prepared to fallback to the Ruby implementation if it stops working, if you still wish to adopt it, here are the instructions:
109
-
110
-
```bash
111
-
# sets up a Rust toolchain
112
-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
113
-
114
-
# Compile and install locally
115
-
gh repo clone rubyatscale/codeowners-rs
116
-
cd codeowners-rs
117
-
cargo install --path .
118
-
119
-
# Set an environment variable that switches ZP's commit hook to use the globally installed binary
120
-
echo USE_CODEOWNERS_RS=true >>~/.zshrc
121
-
```
122
-
123
107
### Development
108
+
124
109
The CLI is written in Rust. Rust provides strong type gurantees and an great ecosystem of CLI libraries. To be able to compile the code locally, you'll need to setup a rust compiler (See https://rustup.rs/):
0 commit comments