Skip to content

Latest commit

 

History

History
124 lines (84 loc) · 5.14 KB

readme.md

File metadata and controls

124 lines (84 loc) · 5.14 KB
Raw

github-review-bot

This was originally based off the peer-review-bot by Felix Rieseberg.

This is a node.js bot that checks repositories for Pull Requests to see if they the appropriate number of reviews. It will automatically label, and merge the PRs.

Peer Review Bot responds to Github WebHooks and labels PRs as 'needs-review' or as 'peer-reviewed', depending on how many people had commented with a 'LGTM' or ':+1:' or ':shipit:'.

If anyone replies with 'needs work', or ':-1:' it will not 'move ahead' with the merge until that person follows up with 'LGTM' or ':+1:'.

Pushing a new commit to a pull request will reset any votes, as committing code after a review needs to be reviewed again.

Once you create a Pull Request, in a repository that Peer Review Bot is monitoring, it will comment on the Pull Request on how things work.

Initial Comment

Peer Review Bot also registers with Github as a status. This will allow you to configure your repository to prevent the merge from being performed, unless the reviews are met.

Status

Don't think you can fool Peer Review Bot by just voting on your own Pull Request, he does not like that.

Shame!

Once the Pull Request has the needed number of reviews, Peer Review Bot will update the check status as Passed.

Passed!

Configuration

For local development

These values should be set in an .env file that is located in the root of the project. These values are then loaded into the environment when the bot initializes.

Required
  • env[GRB_BOT_USERNAME] : The github username for the bot
  • env[GRB_ACCESS_TOKEN] : A personal access token that is used to authenticate the user
  • env[GRB_ORGANIZATION] : The github organization name
  • env[GRB_BOT_URL] : The base url for the callbacks to the bot
  • env[GRB_WEBHOOK_SECRET] : A secret token that is provided to Github for verification
  • env[GRB_AUTH_CLIENT_ID] : Github oAuth2 client id
  • env[GRB_AUTH_CLIENT_SECRET] : Github oAuth2 client secret
Optional
  • env[GRB_NEEDS_REVIEW_LABEL] : The label to be applied when a PR needs to be reviewed
  • env[GRB_PEER_REVIEWED_LABEL] : The label to be applied after a PR has been reviewed
  • env[GRB_NEEDS_WORK_LABEL] : The label to be applied when a PR is marked as needing more work

Azure

You need to set Application Settings for the following:

Required
  • GRB_BOT_USERNAME : The github username for the bot
  • GRB_ACCESS_TOKEN : A personal access token that is used to authenticate the user
  • GRB_ORGANIZATION : The github organization name
  • GRB_BOT_URL : The base url for the callbacks to the bot
  • GRB_WEBHOOK_SECRET : A secret token that is provided to Github for verification
  • GRB_AUTH_CLIENT_ID : Github oAuth2 client id
  • GRB_AUTH_CLIENT_SECRET: Github oAuth2 client secret
Optional
  • WEBSITE_NODE_DEFAULT_VERSION : The version of NodeJS to use.
  • GRB_NEEDS_REVIEW_LABEL : The label to be applied when a PR needs to be reviewed
  • GRB_PEER_REVIEWED_LABEL : The label to be applied after a PR has been reviewed
  • GRB_NEEDS_WORK_LABEL : The label to be applied when a PR is marked as needing more work

Deploy to Azure

Heroku

You need to set Application Settings for the following:

Required
  • GRB_BOT_USERNAME : The github username for the bot
  • GRB_ACCESS_TOKEN : A personal access token that is used to authenticate the user
  • GRB_ORGANIZATION : The github organization name
  • GRB_BOT_URL : The base url for the callbacks to the bot
  • GRB_WEBHOOK_SECRET : A secret token that is provided to Github for verification
  • GRB_AUTH_CLIENT_ID : Github oAuth2 client id
  • GRB_AUTH_CLIENT_SECRET: Github oAuth2 client secret
Optional
  • GRB_NEEDS_REVIEW_LABEL : The label to be applied when a PR needs to be reviewed
  • GRB_PEER_REVIEWED_LABEL : The label to be applied after a PR has been reviewed
  • GRB_NEEDS_WORK_LABEL : The label to be applied when a PR is marked as needing more work

The application should also be set as with the heroku/nodejs build pack. There is an app.json that defines all the information for a Heroku deployment.

Deploy to Heroku

Endpoints

  • / : Default information page
  • /repos : configure the repositories that should be monitored
  • /repos/:repo : configure the specified repo that should be monitored
  • /repos/setup : adds the bot to all repos in the org
  • /audit : a page that shows all users in the organization that do not have 2-factor enabled
  • /managed : lists all the repositories that currently have webhooks defined for the peer review bot
  • /nonmanaged : lists all the repositories that currently do not have webhooks defined for the peer review bot
  • /pullrequest : endpoint for the webhook to notify of the pull request
  • /repository : endpoint for org level webhook to notify when a repository is created