{"id":13994367,"url":"https://github.com/PSPDFKit-labs/reviewbot","last_synced_at":"2025-07-22T19:32:04.844Z","repository":{"id":51201113,"uuid":"121410728","full_name":"PSPDFKit-labs/reviewbot","owner":"PSPDFKit-labs","description":"Reviewbot is a Slack bot that shows reviewable pull requests.","archived":false,"fork":false,"pushed_at":"2021-05-20T08:58:29.000Z","size":111,"stargazers_count":40,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-10T14:16:00.856Z","etag":null,"topics":["bot","integration","pspdfkit","pull-requests","slack-bot"],"latest_commit_sha":null,"homepage":"https://pspdfkit.com/blog/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PSPDFKit-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-13T17:08:37.000Z","updated_at":"2022-04-03T12:05:55.000Z","dependencies_parsed_at":"2022-08-29T20:20:43.742Z","dependency_job_id":null,"html_url":"https://github.com/PSPDFKit-labs/reviewbot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSPDFKit-labs%2Freviewbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSPDFKit-labs%2Freviewbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSPDFKit-labs%2Freviewbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSPDFKit-labs%2Freviewbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PSPDFKit-labs","download_url":"https://codeload.github.com/PSPDFKit-labs/reviewbot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227166692,"owners_count":17740961,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","integration","pspdfkit","pull-requests","slack-bot"],"created_at":"2024-08-09T14:02:50.115Z","updated_at":"2024-11-29T16:31:17.384Z","avatar_url":"https://github.com/PSPDFKit-labs.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# Reviewbot\n\n[![](https://github.com/PSPDFKit-labs/reviewbot/blob/master/reviewbot.png?raw=true)](https://pspdfkit.com/blog/2018/reviewbot/)\n\nReviewbot 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.\n\nMeanwhile, 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.\n\nRead more on the PSPDFKit Blog: https://pspdfkit.com/blog/2018/reviewbot\n\n# Made with ❤️ by PSPDFKit\n\nThe [PSPDFKit SDK](https://pspdfkit.com/pdf-sdk/) is a framework that allows you to view, annotate, sign, and fill PDF forms on iOS, Android, Windows, macOS, and Web. [PSPDFKit Instant](https://pspdfkit.com/instant/) adds real-time collaboration features to seamlessly share, edit, and annotate PDF documents.\n\n# Deployment\n\nWe recommend to deploy Reviewbot to [Heroku](https://www.heroku.com).\n\n# Available Environment Variables\n\n* `SLACK_API_TOKEN`: Your bot's Slack API token. You can create a new bot integration under [/servies/new/bot](http://slack.com/services/new/bot).\n* `GITHUB_ACCESS_TOKEN`: Your [personal access token for GitHub](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\n* `ORGANIZATION`: Your GitHub organization. Reviewbot will use this organization for repositories that didn't specify an organization, i.e. don't contain a slash.\n* `READY_LABELS`: Comma-separated list of labels you use to mark pull requests ready for review, e.g. `ready`, `ready for review` etc.\n* `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.\n\n# Rake Task\n\nYou can use the `post_reviewable_pull_requests` Rake task and the [Heroku Scheduler](https://devcenter.heroku.com/articles/scheduler) to post reviewable pull requests in specific channels at specific times. For example:\n\n```\nbundle exec rake post_reviewable_pull_requests[PSPDFKit+Viewer-iOS,ios,iOS]\n```\n\nThe 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.\n\n# Development Setup\n\n1. `gem install bundler`\n2. `bundle install`\n3. Create an `.env` file with the following variables:\n\n```\nSLACK_API_TOKEN=\u003cyour-slack-api-token\u003e\nGITHUB_ACCESS_TOKEN=\u003cyour-github-api-token\u003e\nORGANIZATION=\u003cyour-github-organization\u003e\nREADY_LABELS=\u003cready,ready-for-review,etc.\u003e\nLABEL_REPOSITORIES=\u003crepositories-that-require-additional-labels\u003e\n```\n\n4. Start the bot with `bundle exec foreman start`.\n\n# License\n\n```\nThe MIT License (MIT)\n\nCopyright (c) 2018 PSPDFKit GmbH (pspdfkit.com)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPSPDFKit-labs%2Freviewbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPSPDFKit-labs%2Freviewbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPSPDFKit-labs%2Freviewbot/lists"}