README.md in codeowners-checker-1.0.5 vs README.md in codeowners-checker-1.1.1
- old
+ new
@@ -31,12 +31,16 @@
@john.smith
```
GitHub credentials are taken from the following environment variables. You might want to put them into your .bashrc or equivalent:
$ export GITHUB_TOKEN='your GitHub PAT' # your personal access token from GitHub
- $ export GITHUB_ORGANIZATION='company' # name of your GitHub organization
+The Github organization used to retrieve the groups/teams is automatically set according to the git remote URL. You can check and change this value using:
+
+ $ codeowners-checker config list
+ $ codeowners-checker config organization <organization>
+
You can generate your PAT in [Settings -> Developer settings -> Personal access tokens on GitHub](https://github.com/settings/tokens) and `read:org` scope is **required**.
If you don't want to fetch the list from GitHub every-time you run codeowners-checker, you can fetch it and store in your repository
alongside of CODEOWNERS. The following prompt will also ask for your GitHub PAT/organization in case it is not already in environment:
@@ -185,10 +189,10 @@
$ codeowners-checker filter by <owner>
## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing