Improves Github utils script (Netflix#3238)

mvilanova · web-flow · commit 6078abe8719c · 2023-04-07T09:27:51.000-07:00
diff --git a/utils/github_utils.py b/utils/github_utils.py
@@ -4,9 +4,10 @@
 
 Instructions on how to install gh can be found here: https://github.com/cli/cli#installation
 """
-import json
-import os
 import click
+import json
+import subprocess
+from time import sleep
 from typing import NoReturn
 
 
@@ -15,6 +16,13 @@ def cli():
     pass
 
 
+def run_command(command: str) -> str:
+    """Utility function to run commands."""
+    process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
+    output, _ = process.communicate()
+    return output.decode("utf-8")
+
+
 @cli.command()
 @click.option(
     "--label",
@@ -25,14 +33,46 @@ def cli():
 )
 def bulk_merge(label: str) -> NoReturn:
     """Utility function to assist with bulk merging pull requests."""
-    gh_pr_list_command = f"gh pr list -s open -l {label} --json number"
-    gh_pr_bulk_merge_command = "gh pr merge -s -d"
+    gh_pr_list_command = f"gh pr list -s open -l {label} --json title,number"
+    gh_pr_bulk_merge_command = "gh pr merge -s -d --admin"
+
+    click.echo(f"Fetching open PRs with {label} label...")
+    pull_requests = json.loads(run_command(gh_pr_list_command))
 
-    stream = os.popen(gh_pr_list_command)
-    pull_requests = json.loads(stream.read())
+    if not pull_requests:
+        click.echo(f"No open PRs with {label} label found.")
+        return
 
     for pull_request in pull_requests:
-        stream = os.popen(f"{gh_pr_bulk_merge_command} {pull_request['number']}")
+        number = pull_request["number"]
+        title = pull_request["title"]
+        click.echo(f"Merging PR #{number} {title}...")
+        run_command(f"{gh_pr_bulk_merge_command} {number}")
+        sleep(
+            5
+        )  # NOTE: Needed to avoid error "Base branch was modified. Review and try the merge again"
+
+    click.echo(f"Open PRs with {label} label merged.")
+
+
+def is_excluded_label(label: str, exclude_labels: list) -> bool:
+    """Checks if label is in the excluded labels list."""
+    return label["name"] in exclude_labels
+
+
+def is_excluded_author(pull_request: dict, exclude_bot_authors: bool) -> bool:
+    """Checks if author is a bot."""
+    return exclude_bot_authors and pull_request["author"]["is_bot"]
+
+
+def update_section(
+    pull_request: dict, sections: dict, label_name: str, dispatch_pr_url: str
+) -> NoReturn:
+    """Updates release notes section."""
+    title = pull_request["title"]
+    number = pull_request["number"]
+    author = pull_request["author"]["login"]
+    sections[label_name] += f"\n* {title} ([#{number}]({dispatch_pr_url}{number})) by @{author}"
 
 
 @cli.command()
@@ -49,10 +89,6 @@ def release_notes(pull_request_number: int) -> NoReturn:
     exclude_bot_authors = True
     exclude_labels = ["skip-changelog", "UI/UX", "javascript"]
     gh_pr_list_merged_command = 'gh pr list -s merged --json "title,author,number,labels" -L 250'
-
-    stream = os.popen(gh_pr_list_merged_command)
-    pull_requests = json.loads(stream.read())
-
     sections = {
         "bug": "",
         "dependencies": "",
@@ -63,27 +99,26 @@ def release_notes(pull_request_number: int) -> NoReturn:
         "tests": "",
     }
 
+    click.echo(f"Fetching list of merged PRs since #{pull_request_number}...")
+    pull_requests = json.loads(run_command(gh_pr_list_merged_command))
+
+    if not pull_requests:
+        click.echo(f"No PRs merged since #{pull_request_number}.")
+
     for pull_request in pull_requests:
-        author = pull_request["author"]["login"]
-        is_bot_author = pull_request["author"]["is_bot"]
-        title = pull_request["title"]
         number = pull_request["number"]
 
         if number < pull_request_number:
             break
 
-        if exclude_bot_authors and is_bot_author:
+        if is_excluded_author(pull_request, exclude_bot_authors):
             continue
 
         for label in pull_request["labels"]:
-            label_name = label["name"]
-            if label_name in exclude_labels:
+            if is_excluded_label(label, exclude_labels):
                 continue
 
-            sections[label_name] = (
-                sections[label_name]
-                + f"\n* {title} ([#{number}]({dispatch_pr_url}{number})) by @{author}"
-            )
+            update_section(pull_request, sections, label["name"], dispatch_pr_url)
 
     print(
         f"""
