Publish a review with REQUEST_CHANGES

Author: vrigal

bot/code_review_bot/report/github.py

@@ -43,6 +43,9 @@ def publish(self, issues, revision, task_failures, notices, reviewers):
             logger.info("No publishable issue, nothing to do")
             return
 
-        # Publish a review comment summarizing detected, unresolved and closed issues
-        for issue in issues:
-            self.github_client.comment(revision=revision, issue=issue)
+        message = f"{len(issues)} issues have been found in this revision"
+
+        # Publish a review summarizing detected, unresolved and closed issues
+        self.github_client.publish_review(
+            issues=issues, revision=revision, message=message
+        )

bot/code_review_bot/sources/github.py

@@ -5,6 +5,10 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 from github import Auth, GithubIntegration
+from github.PullRequest import ReviewComment
+
+from code_review_bot import Issue
+from code_review_bot.revisions.base import Revision
 
 
 class GithubClient:
@@ -28,17 +32,25 @@ def __init__(self, client_id: str, pem_key_path: str, installation_id: str):
         # setup API
         self.api = self.installation.get_github_for_installation()
 
-    def comment(
-        self,
-        *,
-        revision,  # GithubRevision
-        issue,
-    ):
-        repo = self.api.get_repo(revision.repository)
-        pull_request = repo.get_pull(revision.pull_id)
-        pull_request.create_comment(
-            commit=revision.commit,
+        self.review_comments = []
+
+    def _build_review_comment(self, issue):
+        return ReviewComment(
             path=issue.path,
             position=issue.line,
             body=issue.message,
         )
+
+    def publish_review(self, issues: list[Issue], revision: Revision, message: str):
+        """
+        Publish a review from a list of publishable issues, requesting changes to the author.
+        """
+        repo = self.api.get_repo(revision.repository)
+        pull_request = repo.get_pull(revision.pull_id)
+        pull_request.create_review(
+            commit=repo.get_commit(revision.commit),
+            body=message,
+            comments=[self._build_review_comment(issue) for issue in issues],
+            # https://docs.github.com/en/rest/pulls/reviews?apiVersion=2022-11-28#create-a-review-for-a-pull-request
+            event="REQUEST_CHANGES",
+        )