Issue 4070 - Correctly handle multiline commit messages in the mercurial hook

sitescripts/hg/bin/update_issues.py

 # This file is part of Adblock Plus <https://adblockplus.org/>,
 # Copyright (C) 2006-2016 Eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ skipping 50 matching lines @@
     if changes['action'] == 'resolve':
         updates.append(' - closed')
     if not updates:
         return
 
     with _trac_proxy(ui, config, 'updating issue {}'.format(issue_id)) as tp:
         tp.ticket.update(issue_id, comment, changes, True)
         ui.status('updated {}:\n{}\n'.format(issue_url, '\n'.join(updates)))
 
 
+def _format_description(change):
+    lines = change.description().split('\n')

[kzar, 2016/05/25 18:40:18]

Is it possible for people to use DOS style CR+LF newlines in commit messages?

[Vasily Kuznetsov, 2016/05/26 09:23:17]

Not sure, but better safe then sorry. Done

+    message = lines[0].rstrip()
+    if len(lines) == 1 or lines[1] == '':
+        return message
+    if message.endswith('.'):

[kzar, 2016/05/25 18:40:18]

IMHO if the first line ends with a "." then we should leave it alone instead of
adding the ellipses.

[kzar, 2016/05/26 08:14:10]

(We discussed this in IRC, I didn't realise that there was supposed to be a
blank line after the title before a longer commit message. This logic makes more
sense to me now.)

[Vasily Kuznetsov, 2016/05/26 09:23:17]

Acknowledged.

+        message = message.rstrip('.')
+    return message + '...'
+
+
 def _post_comments(ui, repo, config, refs):
     repo_name = posixpath.split(repo.url())[1]
     template = get_template('hg/template/issue_commit_comment.tmpl',
                             autoescape=False)
     for ref in refs:
-        comment_text = template.render({'repository_name': repo_name,
-                                        'changes': ref.commits})
+        comment_text = template.render({
+            'repository_name': repo_name,
+            'changes': ref.commits,
+            'format_description': _format_description
+        })
         with _trac_proxy(ui, config, 'getting issue {}'.format(ref.id)) as tp:
             attrs = tp.ticket.get(ref.id)[3]
             changes = {'_ts': attrs['_ts'], 'action': 'leave'}
             _update_issue(ui, config, ref.id, changes, comment_text)
 
 
 def _compile_module_regexps(ui, config, modules):
     for module, regexp in config.items('hg_module_milestones'):
         try:
             yield module, re.compile('^{}$'.format(regexp), re.I)
@@ skipping 104 matching lines @@
     added_revs = repo.changelog.findmissingrevs([old_master_rev],
                                                 [new_master_rev])
     added_commits = [repo[rev] for rev in added_revs]
     refs = [ref for ref in _collect_references(ui, added_commits)
             if ref.is_fixed]
     _declare_fixed(ui, config, refs)
 
 
 # Alias for backward compatibility.
 hook = changegroup_hook