Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.65 KB

README.md

File metadata and controls

28 lines (20 loc) · 1.65 KB
Raw

bonusly-review-bot

Simple bot that automatically rewards your colleagues Bonusly points for reviewing your pull requests.

How does it work?

Every 15 minutes, the bot scans your open pull requests, identifies recent reviewers, locates their Bonusly profiles, and automatically sends them Bonusly points on your behalf in a single post.

Setup

  • You will need to generate 2 Access tokens and set them in your environment variables.

    • GitHub Personal Access Token: Create a GitHub PAT from here. Make sure to grant all read permissions to access complete pull request information. After token is created, click on 'Conifgure SSO' and authorize your organization.
    • Bonusly Access Token: Create a Bonusly access token from here.

  • Run main.go

Troubleshooting

  • I have reviewed someone's PR, but didn't get any points

    • Your GitHub email and Bonusly email is not the same.
    • Your email address is private. The bot will not be able to find your email in order to find your Bonusly account.
      • If your email address is private, the bot will attempt to find your email from any commits pushed with your GitHub account.

  • My email is private and I have no commits, what now?

    • In that case, the bot will attempt to find your email using Bonusly autocomplete request.
    • Note: This method is unreliable and your Bonusly points may be awarded to the wrong person with a similar name.

  • I do not have a name in my GitHub account / does not match with Bonusly.

    • Nothing to do here 🤷. If you have a solution, feel free to open a PR though.

  • Add more FAQs later