Skip to content
Reviewbot is a Slack bot that shows reviewable pull requests.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
reviewbot
.gitignore
.ruby-version
Gemfile
Gemfile.lock
LICENSE
Procfile
README.md
Rakefile
config.ru
reviewbot.png
reviewbot.rb
web.rb

README.md

Reviewbot

Reviewbot shows you pull requests on GitHub that are ready to be reviewed. How does it know when a pull request is ready? We have a special label in our repositories, aptly named READY TO REVIEW (all caps so it’s easier to spot). When a pull request is ready for review, the author adds this label to their PR to mark it as finished.

Meanwhile, all pull requests without this label are seen as works in progress and shouldn’t be reviewed. Next, an engineer can pick from the READY TO REVIEW pull requests and start reviewing — all code changes at PSPDFKit get reviewed by at least one other person. After the review is done, the pull request author incorporates the feedback and merges the PR.

Read more on the PSPDFKit Blog: https://pspdfkit.com/blog/2018/reviewbot

Made with ❤️ by PSPDFKit

The PSPDFKit SDK is a framework that allows you to view, annotate, sign, and fill PDF forms on iOS, Android, Windows, macOS, and Web. PSPDFKit Instant adds real-time collaboration features to seamlessly share, edit, and annotate PDF documents.

Deployment

We recommend to deploy Reviewbot to Heroku.

Available Environment Variables

  • SLACK_API_TOKEN: Your bot's Slack API token. You can create a new bot integration under /servies/new/bot.
  • GITHUB_ACCESS_TOKEN: Your personal access token for GitHub.
  • ORGANIZATION: Your GitHub organization. Reviewbot will use this organization for repositories that didn't specify an organization, i.e. don't contain a slash.
  • READY_LABELS: Comma-separated list of labels you use to mark pull requests ready for review, e.g. ready, ready for review etc.
  • LABEL_REPOSITORIES: Comma-separated list of repositories that require additional labels. Monorepos that contain both iOS and Android code and use iOS and Android labels for example.

Rake Task

You can use the post_reviewable_pull_requests Rake task and the Heroku Scheduler to post reviewable pull requests in specific channels at specific times. For example:

bundle exec rake post_reviewable_pull_requests[PSPDFKit+Viewer-iOS,ios,iOS]

The above example posts reviewable pull requests of the PSPDFKit and Viewer-iOS repositories if they have the iOS label (and the repository is in the LABEL_REPOSITORIES list) in the #ios Slack channel. Notice that repositories and labels are +-separated.

Development Setup

  1. gem install bundler
  2. bundle install
  3. Create an .env file with the following variables:
SLACK_API_TOKEN=<your-slack-api-token>
GITHUB_ACCESS_TOKEN=<your-github-api-token>
ORGANIZATION=<your-github-organization>
READY_LABELS=<ready,ready-for-review,etc.>
LABEL_REPOSITORIES=<repositories-that-require-additional-labels>
  1. Start the bot with bundle exec foreman start.

License

The MIT License (MIT)

Copyright (c) 2018 PSPDFKit GmbH (pspdfkit.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
You can’t perform that action at this time.