git-multimail: update to release 1.3.0
[git.git] / contrib / hooks / multimail / CHANGES
blob53c71b422a7ac26511b76bc3854e1f04918096f6
1 Release 1.3.0
2 =============
4 * New options multimailhook.htmlInIntro and multimailhook.htmlInFooter
5   now allow using HTML in the introduction and footer of emails (e.g.
6   for a more pleasant formatting or to insert a link to the commit on
7   a web interface).
9 * A new option multimailhook.commitBrowseURL gives a simpler (and less
10   flexible) way to add a link to a web interface for commit emails
11   than multimailhook.htmlInIntro and multimailhook.htmlInFooter.
13 * A new public function config.add_config_parameters was added to
14   allow custom hooks to set specific Git configuration variables
15   without modifying the configuration files. See an example in
16   post-receive.example.
18 * Error handling for SMTP has been improved (we used to print Python
19   backtraces for legitimate errors).
21 * The SMTP mailer can now check TLS certificates when the newly added
22   configuration variable multimailhook.smtpCACerts.
24 * Python 3 portability has been improved.
26 * The documentation's formatting has been improved.
28 * The testsuite has been improved (we now use pyflakes to check for
29   errors in the code).
31 This version has been tested with Python 2.4 and 2.6 to 3.5, and Git
32 v1.7.10-406-gdc801e7, 2.1.4 and 2.8.1.339.g3ad15fd.
34 No change since 1.3 RC1.
36 Release 1.2.0
37 =============
39 * It is now possible to exclude some refs (e.g. exclude some branches
40   or tags). See refFilterDoSendRegex, refFilterDontSendRegex,
41   refFilterInclusionRegex and refFilterExclusionRegex.
43 * New commitEmailFormat option which can be set to "html" to generate
44   simple colorized diffs using HTML for the commit emails.
46 * git-multimail can now be ran as a Gerrit ref-updated hook, or from
47   Atlassian BitBucket Server (formerly known as Atlassian Stash).
49 * The From: field is now more customizeable. It can be set
50   independently for refchange emails and commit emails (see
51   fromCommit, fromRefChange). The special values pusher and author can
52   be used in these configuration variable.
54 * A new command-line option, --version, was added. The version is also
55   available in the X-Git-Multimail-Version header of sent emails.
57 * Set X-Git-NotificationType header to differentiate the various types
58   of notifications. Current values are: diff, ref_changed_plus_diff,
59   ref_changed.
61 * Preliminary support for Python 3. The testsuite passes with Python 3,
62   but it has not received as much testing as the Python 2 version yet.
64 * Several encoding-related fixes. UTF-8 characters work in more
65   situations (but non-ascii characters in email address are still not
66   supported).
68 * The testsuite and its documentation has been greatly improved.
70 Plus all the bugfixes from version 1.1.1.
72 This version has been tested with Python 2.4 and 2.6 to 3.5, and Git
73 v1.7.10-406-gdc801e7, git-1.8.2.3 and 2.6.0. Git versions prior to
74 v1.7.10-406-gdc801e7 probably work, but cannot run the testsuite
75 properly.
77 Release 1.1.1 (bugfix-only release)
78 ===================================
80 * The SMTP mailer was not working with Python 2.4.
82 Release 1.1.0
83 =============
85 * When a single commit is pushed, omit the reference changed email.
86   Set multimailhook.combineWhenSingleCommit to false to disable this
87   new feature.
89 * In gitolite environments, the pusher's email address can be used as
90   the From address by creating a specially formatted comment block in
91   gitolite.conf (see multimailhook.from in README).
93 * Support for SMTP authentication and SSL/TLS encryption was added,
94   see smtpUser, smtpPass, smtpEncryption in README.
96 * A new option scanCommitForCc was added to allow git-multimail to
97   search the commit message for 'Cc: ...' lines, and add the
98   corresponding emails in Cc.
100 * If $USER is not set, use the variable $USERNAME. This is needed on
101   Windows platform to recognize the pusher.
103 * The emailPrefix variable can now be set to an empty string to remove
104   the prefix.
106 * A short tutorial was added in doc/gitolite.rst to set up
107   git-multimail with gitolite.
109 * The post-receive file was renamed to post-receive.example. It has
110   always been an example (the standard way to call git-multimail is to
111   call git_multimail.py), but it was unclear to many users.
113 * A new refchangeShowGraph option was added to make it possible to
114   include both a graph and a log in the summary emails.  The options
115   to control the graph formatting can be set via the new graphOpts
116   option.
118 * New option --force-send was added to disable new commit detection
119   for update hook. One use-case is to run git_multimail.py after
120   running "git fetch" to send emails about commits that have just been
121   fetched (the detection of new commits was unreliable in this mode).
123 * The testing infrastructure was considerably improved (continuous
124   integration with travis-ci, automatic check of PEP8 and RST syntax,
125   many improvements to the test scripts).
127 This version has been tested with Python 2.4 to 2.7, and Git 1.7.1 to
128 2.4.
130 Release 1.0.0
131 =============
133 * Fix encoding of non-ASCII email addresses in email headers.
135 * Fix backwards-compatibility bugs for older Python 2.x versions.
137 * Fix a backwards-compatibility bug for Git 1.7.1.
139 * Add an option commitDiffOpts to customize logs for revisions.
141 * Pass "-oi" to sendmail by default to prevent premature termination
142   on a line containing only ".".
144 * Stagger email "Date:" values in an attempt to help mail clients
145   thread the emails in the right order.
147 * If a mailing list setting is missing, just skip sending the
148   corresponding email (with a warning) instead of failing.
150 * Add a X-Git-Host header that can be used for email filtering.
152 * Allow the sender's fully-qualified domain name to be configured.
154 * Minor documentation improvements.
156 * Add this CHANGES file.
159 Release 0.9.0
160 =============
162 * Initial release.