Disable CI status change comments unless the "automerge" label is used (#578)

Author: ambv

miss_islington/status_change.py

@@ -22,7 +22,8 @@ async def check_status(event, gh, *args, **kwargs):
         event.data["commit"].get("committer")
         and event.data["commit"]["committer"]["login"] == "miss-islington"
     ):
-        await check_ci_status_and_approval(gh, sha, leave_comment=True)
+        # Leave comment temporarily disabled when automerge not used. See #577.
+        await check_ci_status_and_approval(gh, sha, leave_comment=False)
     else:
         pr_for_commit = await util.get_pr_for_commit(gh, sha)
         if pr_for_commit:
@@ -106,12 +107,9 @@ async def check_ci_status_and_approval(
                 )
                 success = result["state"] == "success" and not failure
                 if leave_comment:
-                    if failure:
+                    if failure or not success:
                         emoji = "❌"
                         status = "it's a failure or timed out"
-                    elif not success:
-                        emoji = "❌"
-                        status = "it's a failure"
                     else:
                         emoji = "✅"
                         status = "it's a success"

tests/test_status_change.py

@@ -129,8 +129,9 @@ async def test_ci_passed_with_awaiting_merge_label_pr_is_merged():
 
     gh = FakeGH(getitem=getitem, getiter=getiter)
     await status_change.router.dispatch(event, gh)
-    expected_body = "Status check is done, and it's a success ✅."
-    assert gh.post_data["body"] == expected_body
+    # Leave comment temporarily disabled when automerge not used. See #577.
+    # expected_body = "Status check is done, and it's a success ✅."
+    # assert gh.post_data["body"] == expected_body
     assert gh.put_data["sha"] == sha  # is merged
     assert gh.put_data["merge_method"] == "squash"
     assert (
@@ -197,8 +198,9 @@ async def test_ci_and_check_run_passed_with_no_awaiting_merge_label_pr_is_not_me
 
     gh = FakeGH(getitem=getitem)
     await status_change.router.dispatch(event, gh)
-    expected_body = "Status check is done, and it's a success ✅."
-    assert gh.post_data["body"] == expected_body
+    # Leave comment temporarily disabled when automerge not used. See #577.
+    # expected_body = "Status check is done, and it's a success ✅."
+    # assert gh.post_data["body"] == expected_body
     assert not hasattr(gh, "put_data")  # is not merged
 
 
@@ -254,8 +256,9 @@ async def test_ci_not_passed_awaiting_merge_label_pr_is_not_merged():
 
     gh = FakeGH(getitem=getitem)
     await status_change.router.dispatch(event, gh)
-    expected_body = "@miss-islington and @Mariatta: Status check is done, and it's a failure ❌."
-    assert gh.post_data["body"] == expected_body
+    # Leave comment temporarily disabled when automerge not used. See #577.
+    # expected_body = "@miss-islington and @Mariatta: Status check is done, and it's a failure ❌."
+    # assert gh.post_data["body"] == expected_body
     assert not hasattr(gh, "put_data")  # is not merged
 
 
@@ -323,8 +326,9 @@ async def test_ci_passed_and_check_run_failure_awaiting_merge_label_pr_is_not_me
 
     gh = FakeGH(getitem=getitem, getiter=getiter)
     await status_change.router.dispatch(event, gh)
-    expected_body = "@miss-islington and @Mariatta: Status check is done, and it's a failure or timed out ❌."
-    assert gh.post_data["body"] == expected_body
+    # Leave comment temporarily disabled when automerge not used. See #577.
+    # expected_body = "@miss-islington and @Mariatta: Status check is done, and it's a failure or timed out ❌."
+    # assert gh.post_data["body"] == expected_body
     assert not hasattr(gh, "put_data")  # is not merged
 
 
@@ -471,8 +475,9 @@ async def test_ci_passed_and_check_run_pending_awaiting_merge_label_pr_is_not_me
 
     gh = FakeGH(getitem=getitem, getiter=getiter)
     await status_change.router.dispatch(event, gh)
-    expected_body = "@miss-islington and @Mariatta: Status check is done, and it's a failure or timed out ❌."
-    assert gh.post_data["body"] == expected_body
+    # Leave comment temporarily disabled when automerge not used. See #577.
+    # expected_body = "@miss-islington and @Mariatta: Status check is done, and it's a failure or timed out ❌."
+    # assert gh.post_data["body"] == expected_body
     assert not hasattr(gh, "put_data")  # is not merged
 
 
@@ -540,9 +545,10 @@ async def test_ci_passed_and_check_run_timed_out_awaiting_merge_label_pr_is_not_
 
     gh = FakeGH(getitem=getitem, getiter=getiter)
     await status_change.router.dispatch(event, gh)
-    expected_body = ("@miss-islington and @Mariatta: Status check is done, "
-                      "and it's a failure or timed out ❌.")
-    assert gh.post_data["body"] == expected_body
+    # Leave comment temporarily disabled when automerge not used. See #577.
+    # expected_body = ("@miss-islington and @Mariatta: Status check is done, "
+    #                   "and it's a failure or timed out ❌.")
+    # assert gh.post_data["body"] == expected_body
     assert not hasattr(gh, "put_data")  # is not merged