This is a small program that allows a user to display contributions made by GitHub users.
The basic flow is something like.
- Add in an org.
- Refresh users for that org.
- Add in a repo.
- Refresh prs, commits, and reviews.
- Display contributions for your users.
$ ghcc orgs add <name>
$ ghcc users refresh -v
$ ghcc repos add -n <repo name> -o <org name> -v
$ ghcc prs -v
$ ghcc reviews refresh -v
$ ghcc contributions all
For ruby please see the .ruby-version
file
bundle install
You have to export a variable called GHCC_ACCESS_TOKEN
with classic Personal access GitHub token.
It needs to have the right permissions to get the information.
See the lib/scripts file
See the lib/scripts file
Before you install it cd to the root directory and run the following:
./ghcc dev install
./ghcc dev run_migrations
You might run into issues with creating symlinks. Try sudo if you dare.
DB isn't created on its own:
sqlite3 ghcc.db
depending on where your db is located, you might have to change
the connection location in lib/shared/database.rb
After you install it you can simply run the command
ghcc help
- Write tests
- Make
lib/commands/users/list_spec.rb
into a unit test
- Make
- Refactor
lib/commands/contributions
to be sane - Add in github actions build
- Make commits associated with a pr not double counted
- Pull commits for PRs
- Update contributions from commits to check that they are not a part of a PR
- Update commits to pull from to process on org or repo
- Automatic refresh of pull requests, reviews, and commits