fix: Exclude dependabot from thanks message (#102)

Author: edgarrmondragon

cz_version_bump/thanks.py

@@ -7,7 +7,7 @@
 import typing as t
 from warnings import warn
 
-from github import Auth, Consts, Github
+from github import Auth, Consts, Github, NamedUser
 
 if t.TYPE_CHECKING:
     from collections.abc import Iterable
@@ -53,12 +53,16 @@ def thanks_message(self, commit: git.GitCommit) -> str:
 
     def third_party_contributors(self: Thanker, commit: git.GitCommit) -> Iterable[str]:
         for contributor in self.contributors(commit):
-            if contributor not in self.org_members:
-                yield contributor
+            # Exclude org members and dependabot from the thanks message
+            if contributor.login not in self.org_members and contributor.type != "Bot":
+                yield contributor.login
 
-    def contributors(self: Thanker, commit: git.GitCommit) -> Iterable[str]:
+    def contributors(
+        self: Thanker,
+        commit: git.GitCommit,
+    ) -> Iterable[NamedUser.NamedUser]:
         github_commit = self.repo.get_commit(commit.rev)
-        yield github_commit.author.login
+        yield github_commit.author
         # FIXME: Cannot thank co-authors automatically until `email_to_github_username`
         # is implemented.
         # yield from self.co_authors(github_commit.commit.message)  # noqa: ERA001

tests/test_thanks.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import dataclasses
 import typing as t
 
 import pytest
@@ -16,7 +17,35 @@ def _env(monkeypatch: pytest.MonkeyPatch) -> None:
     monkeypatch.setenv("INPUT_GITHUB_TOKEN", "my_gh_token")
 
 
-def test_thanker(httpserver: HTTPServer) -> None:
+@dataclasses.dataclass
+class DummyAuthor:
+    id: int
+    login: str
+    path: str
+    type: str
+
+
+@pytest.mark.parametrize(
+    "author,expected",
+    [
+        pytest.param(
+            DummyAuthor(101, "jappleseed", "users/j.appleseed", "User"),
+            " -- _**Thanks @jappleseed!**_",
+            id="third_party_contributor",
+        ),
+        pytest.param(
+            DummyAuthor(1, "user1", "users/user1", "User"),
+            "",
+            id="org_member",
+        ),
+        pytest.param(
+            DummyAuthor(2, "dependabot[bot]", "users/dependabot[bot]", "Bot"),
+            "",
+            id="bot",
+        ),
+    ],
+)
+def test_thanker(httpserver: HTTPServer, author: DummyAuthor, expected: str) -> None:
     org = "my_gh_org"
     repo = "my_gh_repo"
     base_url = httpserver.url_for("/")
@@ -73,12 +102,13 @@ def test_thanker(httpserver: HTTPServer) -> None:
                 },
             },
             "author": {
-                "id": 101,
-                "login": "jappleseed",
-                "url": f"{base_url}users/j.appleseed",
+                "id": author.id,
+                "login": author.login,
+                "url": f"{base_url}{author.path}",
+                "type": author.type,
             },
         },
     )
 
     thanker = Thanker(f"{org}/{repo}", base_url=base_url)
-    assert thanker.thanks_message(commit) == " -- _**Thanks @jappleseed!**_"
+    assert thanker.thanks_message(commit) == expected