Git-multimail

Backward-incompatible change
----------------------------

The name of classes for environment was misnamed as `*Environement`.
It is now `*Environment`.

New features
------------

* A Thread-Index header is now added to each email sent (except for
combined emails where it would not make sense), so that MS Outlook
properly groups messages by threads even though they have a
different subject line. Unfortunately, even adding this header the
threading still seems to be unreliable, but it is unclear whether
this is an issue on our side or on MS Outlook's side (see discussion
here: https://github.com/git-multimail/git-multimail/pull/194).

* A new variable multimailhook.ExcludeMergeRevisions was added to send
notification emails only for non-merge commits.

* For gitolite environment, it is now possible to specify the mail map
in a separate file in addition to gitolite.conf, using the variable
multimailhook.MailaddressMap.

Internal changes
----------------

* The testsuite now uses GIT_PRINT_SHA1_ELLIPSIS where needed for
compatibility with recent Git versions. Only tests are affected.

* We don't try to install pyflakes in the continuous integration job
for old Python versions where it's no longer available.

* Stop using the deprecated cgi.escape in Python 3.

* New flake8 warnings have been fixed.

* Python 3.6 is now tested against on Travis-CI.

* A bunch of lgtm.com warnings have been fixed.

Bug fixes
---------

* SMTPMailer logs in only once now. It used to re-login for each email
sent which triggered errors for some SMTP servers.

* migrate-mailhook-config was broken by internal refactoring, it
should now work again.

This version was tested with Python 2.6 to 3.7. It was tested with Git
1.7.10.406.gdc801, 2.15.1 and 2.20.1.98.gecbdaf0.

New features to troubleshoot a git-multimail installation
- One can now perform a basic check of git-multimail's setup by running the hook with the environment variable GIT_MULTIMAIL_CHECK_SETUP set to a non-empty string. See doc/troubleshooting.rst for details.
- A new log files system was added. See the multimailhook.logFile, multimailhook.errorLogFile and multimailhook.debugLogFile variables.
- git_multimail.py can now be made more verbose using multimailhook.verbose.
- A new option --check-ref-filter is now available to help debugging the refFilter\* options.

Formatting emails
- Formatting of emails was made slightly more compact, to reduce the odds of having long subject lines truncated or wrapped in short list of commits.
- multimailhook.emailPrefix may now use the '%(repo_shortname)s' placeholder for the repository's short name.
- A new option multimailhook.subjectMaxLength is available to truncate overly long subject lines.

Bug fixes and minor changes
- Options refFilterDoSendRegex and refFilterDontSendRegex were essentially broken. They should work now.
- The behavior when both refFilter{Do,Dont}SendRegex and refFilter{Exclusion,Inclusion}Regex are set have been slightly changed. Exclusion/Inclusion is now strictly stronger than DoSend/DontSend.
- The management of precedence when a setting can be computed in multiple ways has been considerably refactored and modified. multimailhook.from and multimailhook.reponame now have precedence over the environment-specific settings ($GL_REPO/$GL_USER for gitolite, --stash-user/repo for Stash, --submitter/--project for Gerrit).
- The coverage of the testsuite has been considerably improved. All configuration variables now appear at least once in the testsuite.

This version was tested with Python 2.6 to 3.5. It also mostly works with Python 2.4, but there is one known breakage in the testsuite related to non-ascii characters. It was tested with Git 1.7.10.406.gdc801, 1.8.5.6, 2.1.4, and 2.10.0.rc0.1.g07c9292.

[Documentation for git-multimail 1.4](https://github.com/git-multimail/git-multimail/tree/1.4).

- Generate links to commits in combined emails (it was done only for
commit emails in 1.3.0).
- Fix broken links on PyPi.

- New options multimailhook.htmlInIntro and multimailhook.htmlInFooter
now allow using HTML in the introduction and footer of emails (e.g.
for a more pleasant formatting or to insert a link to the commit on
a web interface).
- A new option multimailhook.commitBrowseURL gives a simpler (and less
flexible) way to add a link to a web interface for commit emails
than multimailhook.htmlInIntro and multimailhook.htmlInFooter.
- A new public function config.add_config_parameters was added to
allow custom hooks to set specific Git configuration variables
without modifying the configuration files. See an example in
post-receive.example.
- Error handling for SMTP has been improved (we used to print Python
backtraces for legitimate errors).
- The SMTP mailer can now check TLS certificates when the newly added
configuration variable multimailhook.smtpCACerts.
- Python 3 portability has been improved.
- The documentation's formatting has been improved.
- The testsuite has been improved (we now use pyflakes to check for
errors in the code).

This version has been tested with Python 2.4 and 2.6 to 3.5, and Git
v1.7.10-406-gdc801e7, 2.1.4 and 2.8.1.339.g3ad15fd.

This is the first release since a long time with an empty pull-request queue!

Changes are as follows:
- It is now possible to exclude some refs (e.g. exclude some branches or tags). See refFilterDoSendRegex, refFilterDontSendRegex, refFilterInclusionRegex and refFilterExclusionRegex.
- New commitEmailFormat option which can be set to "html" to generate simple colorized diffs using HTML for the commit emails.
- git-multimail can now be ran as a Gerrit ref-updated hook, or from Atlassian BitBucket Server (formerly known as Atlassian Stash).
- The From: field is now more customizeable. It can be set independently for refchange emails and commit emails (see fromCommit, fromRefChange). The special values pusher and author can be used in these configuration variable.
- A new command-line option, --version, was added. The version is also available in the X-Git-Multimail-Version header of sent emails.
- Set X-Git-NotificationType header to differentiate the various types of notifications. Current values are: diff, ref_changed_plus_diff, ref_changed.
- Preliminary support for Python 3. The testsuite passes with Python 3, but it has not received as much testing as the Python 2 version yet.
- Several encoding-related fixes. UTF-8 characters work in more situations (but non-ascii characters in email address are still not supported).
- The testsuite and its documentation has been greatly improved.

Plus all the bugfixes from version 1.1.1.

This version has been tested with Python 2.4 and 2.6 to 3.5, and Git v1.7.10-406-gdc801e7, git-1.8.2.3 and 2.6.0. Git versions prior to v1.7.10-406-gdc801e7 probably work, but cannot run the testsuite properly.

Change since RC1 : Python 2.4 compatibility for gitolite environment.