A new workflow to ease pull request review by labelling them

.github/actions/pull_request_size/action.yml

@@ -0,0 +1,34 @@
+name: Calculate pull request size
+description: Evaluate pull request size.
+author: Aubin Bikouo (@abikouo)
+
+inputs:
+  path:
+    description: The path to the collection.
+    required: true
+  github_token:
+    description: The Github token used to comment/label pull requests.
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: setup python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+
+    - name: Install python required libraries
+      run: pip install -U requests
+      shell: bash
+
+    - name: Evaluate pull request size
+      run: >-
+        python3 ${{ github.action_path }}/check_pr.py
+        --path ${{ inputs.path }}
+        --repository ${{ github.repository }}
+        --pr-number ${{ github.event.pull_request.number }}
+        --base-ref ${{ github.event.pull_request.base.ref }}
+      shell: bash
+      env:
+        GITHUB_TOKEN: ${{ inputs.github_token }}

.github/actions/pull_request_size/check_pr.py

@@ -0,0 +1,144 @@
+# -*- coding: utf-8 -*-
+# (c) 2024 Aubin Bikouo <@abikouo>
+# GNU General Public License v3.0+
+#     (see https://www.gnu.org/licenses/gpl-3.0.txt)
+
+import os
+import re
+import subprocess
+from argparse import ArgumentParser
+from collections import defaultdict
+
+import requests
+
+DEFAULT_PR_SIZE_THRESHOLD = {
+    "XS": "0-50",
+    "S": "51-200",
+    "M": "201-400",
+    "L": "401-700",
+    "XL": "701",
+}
+
+
+def WriteComment(repository: str, pr_number: int, comment: str) -> None:
+    url = f"https://api.github.com/repos/{repository}/issues/{pr_number}/comments"
+    result = requests.post(
+        url,
+        headers={
+            "Accept": "application/vnd.github+json",
+            "X-GitHub-Api-Version": "2022-11-28",
+            "Authorization": "Bearer %s" % os.environ.get("GITHUB_TOKEN"),
+        },
+        json={"body": comment},
+    )
+    # Successful call to the API will return '201' (created)
+    if result.status_code != 201:
+        raise RuntimeError(f"Post to URL {url} returned status code = {result.status_code}")
+
+
+def AddLabelToPR(repository: str, pr_number: int, type: str) -> None:
+    all_labels = [f"size/{k}" for k in DEFAULT_PR_SIZE_THRESHOLD.keys()]
+    url_base = f"https://api.github.com/repos/{repository}/issues/{pr_number}/"
+    headers = {
+        "Accept": "application/vnd.github+json",
+        "X-GitHub-Api-Version": "2022-11-28",
+        "Authorization": "Bearer %s" % os.environ.get("GITHUB_TOKEN"),
+    }
+
+    # Read current labels
+    response = requests.get(url_base + "labels", headers=headers)
+    if response.status_code != 200:
+        raise RuntimeError(
+            f"Unable to retrieve labels from issue {repository}/{pr_number} - status_code = {response.status_code}"
+        )
+
+    pr_labels_to_remove = [x["name"] for x in response.json() if x["name"] in all_labels]
+
+    # Remove labels from issue
+    for label in pr_labels_to_remove:
+        response = requests.delete(url_base + f"labels/{label}", headers=headers)
+        if response.status_code != 200:
+            raise RuntimeError(
+                f"Unable to remove label '{label}' from issue {repository}/{pr_number} - status_code = {response.status_code}"
+            )
+
+    # add new label to pull request
+    response = requests.put(url_base + "labels", headers=headers, json={"labels": [f"size/{type}"]})
+    if response.status_code != 200:
+        raise RuntimeError(
+            f"Unable to add label '{label}' to issue {repository}/{pr_number} - status_code = {response.status_code}"
+        )
+
+
+def LabelCommentPR(repository: str, pr_number: int, insertions: int, deletions: int) -> None:
+    # Calculating PR Size:
+    # The PR size is calculated using the formula: insertions + deletions * 0.5.
+    # This calculation considers both the lines of code added and a weighted count of deletions to assess the overall size.
+    pr_size = insertions + 0.5 * deletions
+    for type, value in DEFAULT_PR_SIZE_THRESHOLD.items():
+        v = value.split("-")
+        max, min = None, int(v[0])
+        if len(v) > 1:
+            max = int(v[1])
+        if pr_size < min:
+            continue
+        if max and max < pr_size:
+            continue
+        AddLabelToPR(repository, pr_number, type)
+        if type == "XL":
+            comment = (
+                f"<b>This is a big Pull Request, we found {int(pr_size)} changes (additions and deletions).</b><br/>"
+                "We strongly recommend that you break down this Pull Request into smaller ones to ease the review process."
+            )
+            WriteComment(repository, pr_number, comment)
+
+
+def RunDiff(path: str, repository: str, pr_number: int, base_ref: str) -> None:
+    # List files
+    git_diff_status = f"git --no-pager diff --cached origin/{base_ref} --name-status"
+    proc = subprocess.Popen(
+        git_diff_status,
+        stdout=subprocess.PIPE,
+        shell=True,
+        cwd=path,
+    )
+    stdout = proc.communicate()
+    name_status = defaultdict(list)
+    for i in stdout.decode().split("\n"):
+        m = re.match("^(A|M|D)[\t](.+)", i)
+        if m:
+            name_status[m.group(1)].append(m.group(2))
+
+    # Calculate insertion/deletion
+    insertions, deletions = 0, 0
+    for type, files in name_status.items():
+        if type == "D":
+            continue
+        for f in files:
+            git_diff_stat = f"git --no-pager diff --cached --stat origin/{base_ref} -- {f}"
+            proc = subprocess.Popen(
+                git_diff_stat,
+                stdout=subprocess.PIPE,
+                shell=True,
+                cwd=path,
+            )
+            stdout = proc.communicate()
+            m = re.search("(\\d*) deletion[s]?\\(\\-\\)", stdout.decode())
+            if m:
+                deletions += int(m.group(1))
+            m = re.search("(\\d*) insertion[s]?\\(\\+\\)", stdout.decode())
+            if m:
+                insertions += int(m.group(1))
+    LabelCommentPR(repository, pr_number, insertions, deletions)
+
+
+if __name__ == "__main__":
+    """Check PR size and push corresponding message and/or add label."""
+    parser = ArgumentParser()
+    parser.add_argument("--path", required=True, help="Path to the repository.")
+    parser.add_argument("--repository", required=True, help="Repository name org/name.")
+    parser.add_argument("--pr-number", type=int, required=True, help="The pull request number.")
+    parser.add_argument("--base-ref", required=True, help="The pull request base ref.")
+
+    args = parser.parse_args()
+    RunDiff(args.path, args.repository, args.pr_number, args.base_ref)

.github/workflows/review.yml

@@ -0,0 +1,18 @@
+name: Code review
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+
+jobs:
+  pull-request-size:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: "0"
+      - uses: ansible-collections/amazon.aws/.github/actions/pull_request_size@main
+        with:
+          path: "."
+          github_token: ${{ github.token }}