Add "adopt a module" message

Author: eLBati

environment.sample

@@ -6,6 +6,10 @@
 # broker URI to use for the celery task queue
 #BROKER_URI=redis://queue
 
+# Maintainer role page URL, used in "adopt a module" message.
+# Set this empty to disable the message
+#MAINTAINER_ROLE_PAGE=https://odoo-community.org/page/maintainer-role
+
 #HTTP_HOST=0.0.0.0
 #HTTP_PORT=8080
 

src/oca_github_bot/config.py

@@ -47,6 +47,10 @@ def func_wrapper(*args, **kwargs):
 
 BROKER_URI = os.environ.get("BROKER_URI", os.environ.get("REDIS_URI", "redis://queue"))
 
+MAINTAINER_ROLE_PAGE = os.environ.get(
+    "MAINTAINER_ROLE_PAGE", "https://odoo-community.org/page/maintainer-role"
+)
+
 SENTRY_DSN = os.environ.get("SENTRY_DSN")
 
 DRY_RUN = os.environ.get("DRY_RUN", "").lower() in ("1", "true", "yes")

src/oca_github_bot/tasks/mention_maintainer.py

@@ -4,7 +4,7 @@
 
 from celery.task import task
 
-from .. import github
+from .. import config, github
 from ..config import switchable
 from ..manifest import (
     addon_dirs_in,
@@ -50,8 +50,11 @@ def mention_maintainer(org, repo, pr, dry_run=False):
             modified_addons_maintainers.update(addon_maintainers)
 
         pr_opener = gh_pr.user.login
-        modified_addons_maintainers.discard(pr_opener)
-        all_mentions_comment = get_mention(modified_addons_maintainers)
+        if not modified_addons_maintainers:
+            all_mentions_comment = get_adopt_mention(pr_opener)
+        else:
+            modified_addons_maintainers.discard(pr_opener)
+            all_mentions_comment = get_mention(modified_addons_maintainers)
 
         if not all_mentions_comment:
             return False
@@ -75,6 +78,19 @@ def get_mention(maintainers):
     return mentions_comment
 
 
+def get_adopt_mention(pr_opener):
+    """Get a comment inviting to adopt the module."""
+    if config.MAINTAINER_ROLE_PAGE:
+        return (
+            "Hi @" + pr_opener + ",\n"
+            "the module you are changing has no declared maintainer.\n"
+            "Would you like to adopt it? (See %s)\n"
+            "Just add your GitHub name to `maintainers` key of `__manifest__.py`"
+            " file!"
+        ) % config.MAINTAINER_ROLE_PAGE
+    return ""
+
+
 def get_maintainers(addon_dirs):
     """Get maintainer for each addon in `addon_dirs`.
 

tests/test_mention_maintainer.py

@@ -113,7 +113,7 @@ def test_pr_by_maintainer_no_mention(git_clone, mocker):
 
 
 @pytest.mark.vcr()
-def test_no_maintainer_no_mention(git_clone, mocker):
+def test_no_maintainer_adopt_module(git_clone, mocker):
     github_mock = mocker.patch("oca_github_bot.tasks.mention_maintainer.github")
     github_mock.temporary_clone.return_value.__enter__.return_value = str(git_clone)
 
@@ -127,4 +127,4 @@ def test_no_maintainer_no_mention(git_clone, mocker):
     mocker.patch("oca_github_bot.tasks.mention_maintainer.check_call")
     mention_maintainer("org", "repo", "pr")
 
-    github_mock.gh_call.assert_not_called()
+    github_mock.gh_call.assert_called_once()