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