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