Merge pull request #578 from mvlassis/add-all-reviewers-input

feat: Add `copy_all_reviewers`  input

This PR implements a new `copy_all_reviewers` input. Note that this input would always add a superset of the reviewers added in `copy_requested_reviewers`:

- All users that have already submitted a reviews (regardless of whether it is approved or not)
- All requested users, meaning people that have not yet submitted a review

Author: korthout

README.md

@@ -234,6 +234,15 @@ Specifically, those reachable from the pull request's head and not reachable fro
 
 By default, the action cherry-picks the commits based on the method used to merge the pull request.
 
+### `copy_all_reviewers`
+
+Default: `false` (disabled)
+
+Controls whether to copy all reviewers from the original pull request to the backport pull request.
+Note that this requests reviews from both requested reviewers, and people that have already reviewed the original pull request.
+Use `copy_requested_reviewers` instead to only request reviews from requested reviewers.
+By default, all reviewers are not copied.
+
 ### `copy_assignees`
 
 Default: `false` (disabled)
@@ -262,6 +271,7 @@ Default: `false` (disabled)
 
 Controls whether to copy the requested reviewers from the original pull request to the backport pull request.
 Note that this does not request reviews from those users who already reviewed the original pull request.
+Use `copy_all_reviewers` instead to also request reviews from those users.
 By default, the requested reviewers are not copied.
 
 ### `experimental`

action.yml

@@ -51,6 +51,13 @@ inputs:
 
       By default, the action cherry-picks the commits based on the method used to merge the pull request.
     default: auto
+  copy_all_reviewers:
+    description: >
+      Controls whether to copy all reviewers from the original pull request to the backport pull request.
+      Note that this requests reviews from both requested reviewers, and people that have already reviewed the original pull request.
+      Use `copy_requested_reviewers` instead to only request reviews from requested reviewers.
+      By default, all reviewers are not copied.
+    default: false
   copy_assignees:
     description: >
       Controls whether to copy the assignees from the original pull request to the backport pull request.
@@ -70,6 +77,7 @@ inputs:
     description: >
       Controls whether to copy the requested reviewers from the original pull request to the backport pull request.
       Note that this does not request reviews from those users who already reviewed the original pull request.
+      Use `copy_all_reviewers` instead to also request reviews from those users.
       By default, the requested reviewers are not copied.
     default: false
   experimental:

dist/index.js

@@ -34,6 +34,7 @@ export type Config = {
   };
   copy_milestone: boolean;
   copy_assignees: boolean;
+  copy_all_reviewers: boolean;
   copy_requested_reviewers: boolean;
   add_author_as_assignee: boolean;
   add_author_as_reviewer: boolean;
@@ -450,6 +451,52 @@ export class Backport {
             }
           }
 
+          if (this.config.copy_all_reviewers == true) {
+            const requestedReviewers =
+              mainpr.requested_reviewers?.map((reviewer) => reviewer.login) ??
+              [];
+
+            let submittedReviewers: string[] = [];
+            try {
+              const { data: reviews } = await this.github.listReviews(
+                workflowOwner,
+                workflowRepo,
+                mainpr.number,
+              );
+
+              submittedReviewers = [
+                ...new Set(
+                  reviews
+                    .map((review) => review.user?.login)
+                    .filter((login): login is string => Boolean(login)),
+                ),
+              ];
+            } catch (error) {
+              if (!(error instanceof RequestError)) throw error;
+              console.error(JSON.stringify(error.response));
+            }
+
+            const reviewers = [
+              ...new Set([...requestedReviewers, ...submittedReviewers]),
+            ];
+
+            if (reviewers.length > 0) {
+              console.info("Setting reviewers " + reviewers);
+              const reviewRequest = {
+                owner,
+                repo,
+                pull_number: new_pr.number,
+                reviewers: reviewers,
+              };
+              try {
+                await this.github.requestReviewers(reviewRequest);
+              } catch (error) {
+                if (!(error instanceof RequestError)) throw error;
+                console.error(JSON.stringify(error.response));
+              }
+            }
+          }
+
           if (this.config.copy_requested_reviewers == true) {
             const reviewers =
               mainpr.requested_reviewers?.map((reviewer) => reviewer.login) ??

src/backport.ts

@@ -24,6 +24,11 @@ export interface GithubApi {
     labels: string[],
     repo: Repo,
   ): Promise<LabelPullRequestResponse>;
+  listReviews(
+    owner: string,
+    repo: string,
+    pull_number: number,
+  ): Promise<ListReviewsResponse>;
   requestReviewers(request: ReviewRequest): Promise<RequestReviewersResponse>;
   addAssignees(
     pr: number,
@@ -136,6 +141,24 @@ export class Github implements GithubApi {
     return this.#octokit.rest.pulls.create(pr);
   }
 
+  /**
+   * Retrieves a list of reviews for a specific pull request.
+
+   * @param owner - The account owner of the repository.
+   * @param repo - The name of the repository.
+   * @param pull_number - The unique identifier of the pull request.
+   * @returns A promise that resolves to the list of reviews from the GitHub API.
+   * @throws Will throw an error if the Octokit request fails (e.g., 404 Not Found).
+   */
+  public async listReviews(owner: string, repo: string, pull_number: number) {
+    console.log(`Retrieving reviews from pull request: ${pull_number}`);
+    return this.#octokit.rest.pulls.listReviews({
+      owner,
+      repo,
+      pull_number,
+    });
+  }
+
   public async requestReviewers(request: ReviewRequest) {
     console.log(`Request reviewers: ${request.reviewers}`);
     return this.#octokit.rest.pulls.requestReviewers(request);
@@ -455,6 +478,17 @@ export type CreatePullRequestResponse = {
 };
 export type RequestReviewersResponse = CreatePullRequestResponse;
 
+export type PullRequestReview = {
+  user: {
+    login: string;
+  } | null;
+};
+
+export type ListReviewsResponse = {
+  status: number;
+  data: PullRequestReview[];
+};
+
 export type GenericResponse = {
   status: number;
 };

src/github.ts

@@ -30,6 +30,7 @@ async function run(): Promise<void> {
   const merge_commits = core.getInput("merge_commits");
   const copy_assignees = core.getInput("copy_assignees");
   const copy_milestone = core.getInput("copy_milestone");
+  const copy_all_reviewers = core.getInput("copy_all_reviewers");
   const copy_requested_reviewers = core.getInput("copy_requested_reviewers");
   const add_author_as_assignee = core.getInput("add_author_as_assignee");
   const add_author_as_reviewer = core.getInput("add_author_as_reviewer");
@@ -112,6 +113,7 @@ async function run(): Promise<void> {
     commits: { cherry_picking, merge_commits },
     copy_assignees: copy_assignees === "true",
     copy_milestone: copy_milestone === "true",
+    copy_all_reviewers: copy_all_reviewers === "true",
     copy_requested_reviewers: copy_requested_reviewers === "true",
     add_author_as_assignee: add_author_as_assignee === "true",
     add_author_as_reviewer: add_author_as_reviewer === "true",