A Slack bot used to show who the top reviewers were in GitHub for a given day.
- Go: Ensure you have Go installed. Download and install Go.
- Slack Token: Obtain a Slack token (by creating an app) to enable posting messages. Follow Slack's documentation to get one.
- Slack Channel: Create a Slack channel to post messages to. Follow Slack's documentation to create one.
- GitHub Token: Obtain a GitHub token to enable fetching data from GitHub. Follow GitHub's documentation to get one. Ensure it has the following scopes
public_repo, read:project, read:user, repo:status, user:email
. When making this project I simply used a Classic Token. Ideally just using a Fine-grained personal access token would be better since scoping by organization or user would be more secure.
-
Clone the Repository:
git clone git@github.com:jdboisvert/review-rush.git cd review-rush
-
Set Environment Variables:
cp .env.example .env
This project makes use of a .env file you need to copy .env.example to .env and fill in the values.
-
Build the Project for Quick Use using /cmd:
cd ./cmd go build -o ../review-rush.exe
-
Run the Built Executable:
cd .. ./review-rush.exe
You can skip the build process and run the project directly using
go run ./cmd/main.go
from the root of the project as well. -
The application should now be running and posting to Slack as intended!
If you need more configuration options or to understand deeper aspects of the integration, visit this detailed guide.