Add ignore blocks for merge commit bodies

Author: oliviacrain

homu/main.py

@@ -41,6 +41,11 @@
 
 VARIABLES_RE = re.compile(r'\${([a-zA-Z_]+)}')
 
+IGNORE_BLOCK_START = '<!-- homu-ignore:start -->'
+IGNORE_BLOCK_END = '<!-- homu-ignore:end -->'
+IGNORE_BLOCK_RE = re.compile(r'<!--\s*homu-ignore:start\s*-->.*<!--\s*homu-ignore:end\s*-->',
+                    flags=re.MULTILINE|re.DOTALL|re.IGNORECASE)
+
 global_cfg = {}
 
 
@@ -49,6 +54,11 @@
 def suppress_pings(text):
     return re.sub(r'\B(@\S+)', r'`\g<1>`', text)  # noqa
 
+# Replace any text between IGNORE_BLOCK_START and IGNORE_BLOCK_END
+# HTML comments with an empty string in merge commits
+def suppress_ignore_block(text):
+    return IGNORE_BLOCK_RE.sub('', text)
+
 
 @contextmanager
 def buildbot_sess(repo_cfg):
@@ -356,6 +366,7 @@ def refresh(self):
 
         self.title = issue.title
         self.body = suppress_pings(issue.body)
+        self.body = suppress_ignore_block(self.body)
 
     def fake_merge(self, repo_cfg):
         if not repo_cfg.get('linear', False):
@@ -1554,6 +1565,7 @@ def synchronize(repo_label, repo_cfg, logger, gh, states, repos, db, mergeable_q
         state = PullReqState(pull.number, pull.head.sha, status, db, repo_label, mergeable_que, gh, repo_cfg['owner'], repo_cfg['name'], repo_cfg.get('labels', {}), repos, repo_cfg.get('test-on-fork'))  # noqa
         state.title = pull.title
         state.body = suppress_pings(pull.body)
+        state.body = suppress_ignore_block(state.body)
         state.head_ref = pull.head.repo[0] + ':' + pull.head.ref
         state.base_ref = pull.base.ref
         state.set_mergeable(None)

homu/server.py

@@ -5,7 +5,11 @@
     PullReqState,
     parse_commands,
     db_query,
+    IGNORE_BLOCK_END,
+    IGNORE_BLOCK_START,
     INTERRUPTED_BY_HOMU_RE,
+    suppress_ignore_block,
+    suppress_pings,
     synchronize,
     LabelEvent,
 )
@@ -306,6 +310,9 @@ def rollup(user_gh, state, repo_label, repo_cfg, repo):
             failures.append(state.num)
             continue
 
+        state.body = suppress_pings(state.body)
+        state.body = suppress_ignore_block(state.body)
+
         merge_msg = 'Rollup merge of #{} - {}, r={}\n\n{}\n\n{}'.format(
             state.num,
             state.head_ref,
@@ -343,7 +350,10 @@ def rollup(user_gh, state, repo_label, repo_cfg, repo):
     if base_url:
         pr_list = ','.join(str(x.num) for x in successes)
         link = '{}/queue/{}?prs={}'.format(base_url, repo_label, pr_list)
-        body += '\n\n[Create a similar rollup]({})'.format(link)
+        body += '\n'
+        body += IGNORE_BLOCK_START
+        body += '\n[Create a similar rollup]({})\n'.format(link)
+        body += IGNORE_BLOCK_END
 
     try:
         pull = base_repo.create_pull(

homu/tests/test_pr_body.py

@@ -1,4 +1,4 @@
-from homu.main import suppress_pings
+from homu.main import suppress_ignore_block, suppress_pings, IGNORE_BLOCK_START, IGNORE_BLOCK_END
 
 
 def test_suppress_pings_in_PR_body():
@@ -15,3 +15,16 @@ def test_suppress_pings_in_PR_body():
     )
 
     assert suppress_pings(body) == expect
+
+def test_suppress_ignore_block_in_PR_body():
+    body = ("Rollup merge\n"
+            "{}\n"
+            "[Create a similar rollup](https://fake.xyz/?prs=1,2,3)\n"
+            "{}"
+    )
+
+    body = body.format(IGNORE_BLOCK_START, IGNORE_BLOCK_END)
+
+    expect = "Rollup merge\n"
+
+    assert suppress_ignore_block(body) == expect