dev/releases: ignore dependabot PRs (#6375)

Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Reinis Cirpons <43414125+reiniscirpons@users.noreply.github.com>

Author: 3 people

.github/workflows/release.yml

@@ -56,8 +56,8 @@ jobs:
       #- name: "Validate types"
       #  run: python -m mypy --disallow-untyped-calls --disallow-untyped-defs dev/releases/*.py
 
-      #- name: "Run tests"
-      #  run: python -m pytest tools/tests/dev/releases*.py -vv
+      - name: "Run tests"
+        run: cd dev/releases && python -m pytest test_release_notes.py
 
   unix:
     name: "Create Unix archives and data"

Makefile.rules

@@ -21,6 +21,14 @@ default: all
 .PHONY: default
 
 
+########################################################################
+# Developer helper targets
+########################################################################
+test_release_notes:
+	cd dev/releases && python3 -m pytest test_release_notes.py
+.PHONY: test_release_notes
+
+
 ########################################################################
 # Source files
 #

dev/releases/release_notes.py

@@ -221,7 +221,7 @@ def get_pr_list(date: str, extra: str) -> List[Dict[str, Any]]:
             "--search",
             query,
             "--json",
-            "number,title,closedAt,labels,mergedAt",
+            "number,title,closedAt,labels,mergedAt,author",
             "--limit",
             "200",
         ],
@@ -245,6 +245,14 @@ def has_label(pr: Dict[str, Any], label: str) -> bool:
     return any(x["name"] == label for x in pr["labels"])
 
 
+def is_dependabot_pr(pr: Dict[str, Any]) -> bool:
+    author = pr.get("author") or {}
+    login = author.get("login")
+    if login in ("app/dependabot", "dependabot[bot]"):
+        return True
+    return author.get("is_bot", False) and has_label(pr, "dependencies")
+
+
 def changes_overview(
     prs: List[Dict[str, Any]], startdate: str, new_version: str
 ) -> None:
@@ -361,6 +369,7 @@ def main(new_version: str) -> None:
 
     print("Downloading filtered PR list")
     prs = get_pr_list(startdate, extra)
+    prs = [pr for pr in prs if not is_dependabot_pr(pr)]
     # print(json.dumps(prs, sort_keys=True, indent=4))
 
     changes_overview(prs, startdate, new_version)

dev/releases/test_release_notes.py

@@ -0,0 +1,107 @@
+import release_notes
+
+
+def test_is_dependabot_pr_detects_dependabot_author():
+    pr = {
+        "author": {"is_bot": True, "login": "app/dependabot"},
+        "labels": [
+            {"name": "dependencies"},
+            {"name": "github_actions"},
+        ],
+    }
+
+    assert release_notes.is_dependabot_pr(pr)
+
+    pr = {
+        "author": {"is_bot": True, "login": "app/notdependabot"},
+        "labels": [
+            {"name": "dependencies"},
+            {"name": "github_actions"},
+        ],
+    }
+
+    assert release_notes.is_dependabot_pr(pr)
+
+    pr = {
+        "author": {"is_bot": False, "login": "app/dependabot"},
+        "labels": [
+            {"name": "dependencies"},
+            {"name": "github_actions"},
+        ],
+    }
+
+    assert release_notes.is_dependabot_pr(pr)
+
+    pr = {
+        "author": {"is_bot": False, "login": "app/notdependabot"},
+        "labels": [
+            {"name": "dependencies"},
+            {"name": "github_actions"},
+        ],
+    }
+
+    assert not release_notes.is_dependabot_pr(pr)
+
+    pr = {
+        "author": {"is_bot": False, "login": "app/dependabot"},
+        "labels": [
+            {"name": "github_actions"},
+        ],
+    }
+
+    assert release_notes.is_dependabot_pr(pr)
+
+    pr = {
+        "author": {"is_bot": False, "login": "app/notdependabot"},
+        "labels": [
+            {"name": "github_actions"},
+        ],
+    }
+
+    assert not release_notes.is_dependabot_pr(pr)
+
+    pr = {
+        "author": {"is_bot": True, "login": "app/notdependabot"},
+        "labels": [
+            {"name": "github_actions"},
+        ],
+    }
+
+    assert not release_notes.is_dependabot_pr(pr)
+
+    pr = {
+        "author": {"is_bot": False, "login": "dependabot[bot]"},
+        "labels": [
+            {"name": "github_actions"},
+        ],
+    }
+
+    assert release_notes.is_dependabot_pr(pr)
+
+    pr = {
+        "author": {"login": "dependabot[bot]"},
+        "labels": [
+            {"name": "github_actions"},
+        ],
+    }
+
+    assert release_notes.is_dependabot_pr(pr)
+
+    pr = {
+        "author": {"login": "app/notdependabot"},
+        "labels": [
+            {"name": "github_actions"},
+        ],
+    }
+
+    assert not release_notes.is_dependabot_pr(pr)
+
+    pr = {
+        "author": {"login": "app/notdependabot"},
+        "labels": [
+            {"name": "dependencies"},
+            {"name": "github_actions"},
+        ],
+    }
+
+    assert not release_notes.is_dependabot_pr(pr)