The original v1 and v2 versions of PullApprove were built on the OAuth integration system. The current version (v3) is built as a GitHub App and has some significant differences.
PullApprove v3 is built entirely around the official GitHub Reviews, offering more controls for determining who should review what, and automation to help make it happen.
To migrate from an older version, you'll want to roughly follow these steps:
version: 3and validate it
Previous versions of PullApprove used the
code-review/pullapprove status check name. The new version simply uses
pullapprove. Once you remove the repo from the old PullApprove, the old status check will stop showing up on new PRs.
PRs that were already open will continue to show the old status check if it was already present.
People can now set themselves as "unavailable" when they go on vacation or aren't able to help review PRs. PullApprove skips unavailable users when sending out review requests.
A more flexible conditions system allows you to write the precise conditions that you need, using almost any of the data available on your PR.
PullApprove v3 has been redesigned and rebuilt from the ground up to better handle the scale we've grown to.
Notifications and comments play a key role in code review. Now PullApprove has a notifications setting so you can easily integrate automated comments into your PRs that help people know what to do.
Reviewers can now be randomized or chosen in a specific order.
Static PR requirements (such as signed-off-by) are no longer directly a part of PullApprove. Instead we're refocusing on the human element of code review, and you can integrate with other status checks via conditions.
This is a limitation of GitHub Reviews, which v3 is built on. You can, however, still
get similar behavior to the old "auto" approval with the new
PullApprove v3 is built around the offical GitHub Reviews. We no longer allow comments to trigger your review status, and instead you should use the offical review UI in GitHub.
Regardless of how many review "groups" you are a part of in PullApprove, you will only be asked to review a PR once. In previous versions we allowed you to give an approval for each "group" individually (by using a different keyword in the PR comment).