fix: update release script to consider only PRs with base.ref "main" (#398)

Author: miguelteixeiraa

tools/release/lib/release.py

@@ -39,8 +39,9 @@ def get_sorted_merged_pulls(
                 pull
                 for pull in pulls
                 if pull.merged
-                   and not pull.title.startswith("chore: release")
-                   and not pull.user.login.startswith("github-actions")
+                and pull.base.ref == "main"
+                and not pull.title.startswith("chore: release")
+                and not pull.user.login.startswith("github-actions")
             ),
             key=lambda pull: pull.merged_at,
         )
@@ -50,9 +51,10 @@ def get_sorted_merged_pulls(
             pull
             for pull in pulls
             if pull.merged
-               and (pull.merged_at > last_release.created_at)
-               and not pull.title.startswith("chore: release")
-               and not pull.user.login.startswith("github-actions")
+            and pull.base.ref == "main"
+            and (pull.merged_at > last_release.created_at)
+            and not pull.title.startswith("chore: release")
+            and not pull.user.login.startswith("github-actions")
         ),
         key=lambda pull: pull.merged_at,
     )
@@ -127,7 +129,7 @@ def multiple_contributors_mention_md(contributors: List[str]) -> str:
         contrib_by = (
             contrib_by[:last_comma].strip()
             + " and "
-            + contrib_by[last_comma + 1:].strip()
+            + contrib_by[last_comma + 1 :].strip()
         )
     return contrib_by
 

tools/release/lib/tests/test_release.py

@@ -6,9 +6,10 @@
 User = namedtuple("User", ["login"])
 Commit = namedtuple("Commit", ["author", "commit"])
 CommitMessage = namedtuple("CommitMessage", ["message"])
+PullRequestBase = namedtuple("PullRequestBase", "ref")
 PullRequestTuple = namedtuple(
     "PullRequest",
-    ["title", "number", "state", "merged", "merged_at", "user", "commits"],
+    ["title", "number", "state", "base", "merged", "merged_at", "user", "commits"],
 )
 
 
@@ -41,6 +42,7 @@ def get_pulls(state="closed"):
                         number=1,
                         state="open",
                         merged=False,
+                        base=PullRequestBase("main"),
                         merged_at=datetime(2023, 2, 2),
                         user=User("contributor_1"),
                         commits=[
@@ -68,6 +70,7 @@ def get_pulls(state="closed"):
                         state="closed",
                         merged=True,
                         merged_at=datetime(2023, 2, 1),
+                        base=PullRequestBase("main"),
                         user=User("contributor_2"),
                         commits=[
                             Commit(
@@ -106,6 +109,7 @@ def get_pulls(state="closed"):
                         state="closed",
                         merged=True,
                         merged_at=datetime(2023, 2, 2),
+                        base=PullRequestBase("main"),
                         user=User("contributor_3"),
                         commits=[
                             Commit(
@@ -132,6 +136,7 @@ def get_pulls(state="closed"):
                         state="closed",
                         merged=True,
                         merged_at=datetime(2023, 2, 3),
+                        base=PullRequestBase("main"),
                         user=User("contributor_4"),
                         commits=[
                             Commit(
@@ -158,6 +163,7 @@ def get_pulls(state="closed"):
                         state="closed",
                         merged=False,
                         merged_at=datetime(2023, 2, 4),
+                        base=PullRequestBase("main"),
                         user=User("contributor_3"),
                         commits=[
                             Commit(
@@ -184,6 +190,7 @@ def get_pulls(state="closed"):
                         state="closed",
                         merged=True,
                         merged_at=datetime(2023, 2, 5),
+                        base=PullRequestBase("main"),
                         user=User("contributor_2"),
                         commits=[
                             Commit(
@@ -210,6 +217,7 @@ def get_pulls(state="closed"):
                         state="closed",
                         merged=True,
                         merged_at=datetime(2023, 5, 2),
+                        base=PullRequestBase("main"),
                         user=User("new_contributor_2"),
                         commits=[
                             Commit(
@@ -242,6 +250,7 @@ def get_pulls(state="closed"):
                         state="closed",
                         merged=True,
                         merged_at=datetime(2023, 5, 5),
+                        base=PullRequestBase("main"),
                         user=User("contributor_3"),
                         commits=[
                             Commit(
@@ -274,6 +283,7 @@ def get_pulls(state="closed"):
                         state="closed",
                         merged=True,
                         merged_at=datetime(2023, 5, 1),
+                        base=PullRequestBase("main"),
                         user=User("new_contributor_1"),
                         commits=[
                             Commit(
@@ -312,6 +322,7 @@ def get_pulls(state="closed"):
                         state="closed",
                         merged=True,
                         merged_at=datetime(2023, 5, 10),
+                        base=PullRequestBase("another_branch"),
                         user=User("new_contributor_1"),
                         commits=[
                             Commit(
@@ -330,6 +341,7 @@ def get_pulls(state="closed"):
                         state="closed",
                         merged=True,
                         merged_at=datetime(2023, 5, 9),
+                        base=PullRequestBase("main"),
                         user=User("new_contributor_1"),
                         commits=[
                             Commit(
@@ -359,8 +371,9 @@ def test_get_sorted_merged_pulls():
             pull
             for pull in pulls
             if pull.merged
-               and not pull.title.startswith("chore: release")
-               and not pull.user.login.startswith("github-actions")
+            and pull.base.ref == "main"
+            and not pull.title.startswith("chore: release")
+            and not pull.user.login.startswith("github-actions")
         ],
         key=lambda pull: pull.merged_at,
     )
@@ -428,7 +441,6 @@ def test_whats_changed_md():
         "* Feature 8 by @new_contributor_1, @new_contributor_coauthor3 and @new_contributor_coauthor4 in https://github.com/ada-url/ada/pull/15",
         "* Feature 9 by @new_contributor_2 and @new_contributor_coauthor1 in https://github.com/ada-url/ada/pull/13",
         "* Feature 7 by @contributor_3 and @new_contributor_coauthor2 in https://github.com/ada-url/ada/pull/14",
-        "* Feature 11 by @new_contributor_1 in https://github.com/ada-url/ada/pull/16",
     ]
 
 
@@ -479,7 +491,6 @@ def test_contruct_release_notes():
         + "* Feature 8 by @new_contributor_1, @new_contributor_coauthor3 and @new_contributor_coauthor4 in https://github.com/ada-url/ada/pull/15\n"
         + "* Feature 9 by @new_contributor_2 and @new_contributor_coauthor1 in https://github.com/ada-url/ada/pull/13\n"
         + "* Feature 7 by @contributor_3 and @new_contributor_coauthor2 in https://github.com/ada-url/ada/pull/14\n"
-        + "* Feature 11 by @new_contributor_1 in https://github.com/ada-url/ada/pull/16\n"
         + "\n"
         + "## New Contributors\n"
         + "* @new_contributor_2 and @new_contributor_coauthor1 made their first contribution in https://github.com/ada-url/ada/pull/13\n"