]>
Commit | Line | Data |
---|---|---|
4557e0de AP |
1 | #!/bin/sh |
2 | # | |
3 | # Copyright (c) 2007 Andy Parkins | |
4 | # | |
15a2f530 GP |
5 | # An example hook script to mail out commit update information. This hook |
6 | # sends emails listing new revisions to the repository introduced by the | |
7 | # change being reported. The rule is that (for branch updates) each commit | |
8 | # will appear on one email and one email only. | |
4557e0de | 9 | # |
15a2f530 GP |
10 | # This hook is stored in the contrib/hooks directory. Your distribution |
11 | # will have put this somewhere standard. You should make this script | |
12 | # executable then link to it in the repository you would like to use it in. | |
13 | # For example, on debian the hook is stored in | |
f6f17885 | 14 | # /usr/share/git-core/contrib/hooks/post-receive-email: |
4557e0de AP |
15 | # |
16 | # chmod a+x post-receive-email | |
17 | # cd /path/to/your/repository.git | |
f6f17885 | 18 | # ln -sf /usr/share/git-core/contrib/hooks/post-receive-email hooks/post-receive |
4557e0de | 19 | # |
15a2f530 GP |
20 | # This hook script assumes it is enabled on the central repository of a |
21 | # project, with all users pushing only to it and not between each other. It | |
22 | # will still work if you don't operate in that style, but it would become | |
23 | # possible for the email to be from someone other than the person doing the | |
24 | # push. | |
4557e0de | 25 | # |
cc24a1d8 JN |
26 | # To help with debugging and use on pre-v1.5.1 git servers, this script will |
27 | # also obey the interface of hooks/update, taking its arguments on the | |
28 | # command line. Unfortunately, hooks/update is called once for each ref. | |
29 | # To avoid firing one email per ref, this script just prints its output to | |
30 | # the screen when used in this mode. The output can then be redirected if | |
31 | # wanted. | |
32 | # | |
4557e0de AP |
33 | # Config |
34 | # ------ | |
35 | # hooks.mailinglist | |
36 | # This is the list that all pushes will go to; leave it blank to not send | |
37 | # emails for every ref update. | |
38 | # hooks.announcelist | |
39 | # This is the list that all pushes of annotated tags will go to. Leave it | |
15a2f530 GP |
40 | # blank to default to the mailinglist field. The announce emails lists |
41 | # the short log summary of the changes since the last annotated tag. | |
b5786c82 | 42 | # hooks.envelopesender |
15a2f530 GP |
43 | # If set then the -f option is passed to sendmail to allow the envelope |
44 | # sender address to be set | |
e7509ee3 GP |
45 | # hooks.emailprefix |
46 | # All emails have their subjects prefixed with this prefix, or "[SCM]" | |
47 | # if emailprefix is unset, to aid filtering | |
b0a7d111 PH |
48 | # hooks.showrev |
49 | # The shell command used to format each revision in the email, with | |
50 | # "%s" replaced with the commit id. Defaults to "git rev-list -1 | |
51 | # --pretty %s", displaying the commit id, author, date and log | |
52 | # message. To list full patches separated by a blank line, you | |
53 | # could set this to "git show -C %s; echo". | |
5ffd3113 JM |
54 | # To list a gitweb/cgit URL *and* a full patch for each change set, use this: |
55 | # "t=%s; printf 'http://.../?id=%%s' \$t; echo;echo; git show -C \$t; echo" | |
56 | # Be careful if "..." contains things that will be expanded by shell "eval" | |
57 | # or printf. | |
b03e7b7d KF |
58 | # hooks.emailmaxlines |
59 | # The maximum number of lines that should be included in the generated | |
60 | # email body. If not specified, there is no limit. | |
61 | # Lines beyond the limit are suppressed and counted, and a final | |
62 | # line is added indicating the number of suppressed lines. | |
0d7c01c9 JJ |
63 | # hooks.diffopts |
64 | # Alternate options for the git diff-tree invocation that shows changes. | |
65 | # Default is "--stat --summary --find-copies-harder". Add -p to those | |
66 | # options to include a unified diff of changes in addition to the usual | |
67 | # summary output. | |
4557e0de AP |
68 | # |
69 | # Notes | |
70 | # ----- | |
4557e0de AP |
71 | # All emails include the headers "X-Git-Refname", "X-Git-Oldrev", |
72 | # "X-Git-Newrev", and "X-Git-Reftype" to enable fine tuned filtering and | |
73 | # give information for debugging. | |
74 | # | |
75 | ||
76 | # ---------------------------- Functions | |
77 | ||
78 | # | |
53cad691 KF |
79 | # Function to prepare for email generation. This decides what type |
80 | # of update this is and whether an email should even be generated. | |
4557e0de | 81 | # |
53cad691 | 82 | prep_for_email() |
4557e0de AP |
83 | { |
84 | # --- Arguments | |
85 | oldrev=$(git rev-parse $1) | |
86 | newrev=$(git rev-parse $2) | |
87 | refname="$3" | |
88 | ||
89 | # --- Interpret | |
90 | # 0000->1234 (create) | |
91 | # 1234->2345 (update) | |
92 | # 2345->0000 (delete) | |
93 | if expr "$oldrev" : '0*$' >/dev/null | |
94 | then | |
95 | change_type="create" | |
96 | else | |
97 | if expr "$newrev" : '0*$' >/dev/null | |
98 | then | |
99 | change_type="delete" | |
100 | else | |
101 | change_type="update" | |
102 | fi | |
103 | fi | |
104 | ||
105 | # --- Get the revision types | |
106 | newrev_type=$(git cat-file -t $newrev 2> /dev/null) | |
107 | oldrev_type=$(git cat-file -t "$oldrev" 2> /dev/null) | |
108 | case "$change_type" in | |
109 | create|update) | |
110 | rev="$newrev" | |
111 | rev_type="$newrev_type" | |
112 | ;; | |
113 | delete) | |
114 | rev="$oldrev" | |
115 | rev_type="$oldrev_type" | |
116 | ;; | |
117 | esac | |
118 | ||
119 | # The revision type tells us what type the commit is, combined with | |
120 | # the location of the ref we can decide between | |
121 | # - working branch | |
122 | # - tracking branch | |
123 | # - unannoted tag | |
124 | # - annotated tag | |
125 | case "$refname","$rev_type" in | |
126 | refs/tags/*,commit) | |
127 | # un-annotated tag | |
128 | refname_type="tag" | |
129 | short_refname=${refname##refs/tags/} | |
130 | ;; | |
131 | refs/tags/*,tag) | |
132 | # annotated tag | |
133 | refname_type="annotated tag" | |
134 | short_refname=${refname##refs/tags/} | |
135 | # change recipients | |
136 | if [ -n "$announcerecipients" ]; then | |
137 | recipients="$announcerecipients" | |
138 | fi | |
139 | ;; | |
140 | refs/heads/*,commit) | |
141 | # branch | |
142 | refname_type="branch" | |
143 | short_refname=${refname##refs/heads/} | |
144 | ;; | |
145 | refs/remotes/*,commit) | |
146 | # tracking branch | |
147 | refname_type="tracking branch" | |
148 | short_refname=${refname##refs/remotes/} | |
149 | echo >&2 "*** Push-update of tracking branch, $refname" | |
150 | echo >&2 "*** - no email generated." | |
8828aa34 | 151 | return 1 |
4557e0de AP |
152 | ;; |
153 | *) | |
154 | # Anything else (is there anything else?) | |
155 | echo >&2 "*** Unknown type of update to $refname ($rev_type)" | |
156 | echo >&2 "*** - no email generated" | |
8828aa34 | 157 | return 1 |
4557e0de AP |
158 | ;; |
159 | esac | |
160 | ||
161 | # Check if we've got anyone to send to | |
162 | if [ -z "$recipients" ]; then | |
fdfeb87c JM |
163 | case "$refname_type" in |
164 | "annotated tag") | |
165 | config_name="hooks.announcelist" | |
166 | ;; | |
167 | *) | |
168 | config_name="hooks.mailinglist" | |
169 | ;; | |
170 | esac | |
171 | echo >&2 "*** $config_name is not set so no email will be sent" | |
4557e0de | 172 | echo >&2 "*** for $refname update $oldrev->$newrev" |
8828aa34 | 173 | return 1 |
4557e0de AP |
174 | fi |
175 | ||
8828aa34 | 176 | return 0 |
53cad691 KF |
177 | } |
178 | ||
179 | # | |
180 | # Top level email generation function. This calls the appropriate | |
181 | # body-generation routine after outputting the common header. | |
182 | # | |
183 | # Note this function doesn't actually generate any email output, that is | |
184 | # taken care of by the functions it calls: | |
185 | # - generate_email_header | |
186 | # - generate_create_XXXX_email | |
187 | # - generate_update_XXXX_email | |
188 | # - generate_delete_XXXX_email | |
189 | # - generate_email_footer | |
190 | # | |
191 | # Note also that this function cannot 'exit' from the script; when this | |
192 | # function is running (in hook script mode), the send_mail() function | |
193 | # is already executing in another process, connected via a pipe, and | |
194 | # if this function exits without, whatever has been generated to that | |
195 | # point will be sent as an email... even if nothing has been generated. | |
196 | # | |
197 | generate_email() | |
198 | { | |
4557e0de | 199 | # Email parameters |
4557e0de AP |
200 | # The email subject will contain the best description of the ref |
201 | # that we can build from the parameters | |
202 | describe=$(git describe $rev 2>/dev/null) | |
203 | if [ -z "$describe" ]; then | |
204 | describe=$rev | |
205 | fi | |
206 | ||
207 | generate_email_header | |
208 | ||
209 | # Call the correct body generation function | |
210 | fn_name=general | |
211 | case "$refname_type" in | |
212 | "tracking branch"|branch) | |
213 | fn_name=branch | |
214 | ;; | |
215 | "annotated tag") | |
216 | fn_name=atag | |
217 | ;; | |
218 | esac | |
b03e7b7d KF |
219 | |
220 | if [ -z "$maxlines" ]; then | |
221 | generate_${change_type}_${fn_name}_email | |
222 | else | |
223 | generate_${change_type}_${fn_name}_email | limit_lines $maxlines | |
224 | fi | |
4557e0de AP |
225 | |
226 | generate_email_footer | |
227 | } | |
228 | ||
229 | generate_email_header() | |
230 | { | |
231 | # --- Email (all stdout will be the email) | |
232 | # Generate header | |
233 | cat <<-EOF | |
4557e0de | 234 | To: $recipients |
b5e233ec | 235 | Subject: ${emailprefix}$projectdesc $refname_type $short_refname ${change_type}d. $describe |
4557e0de AP |
236 | X-Git-Refname: $refname |
237 | X-Git-Reftype: $refname_type | |
238 | X-Git-Oldrev: $oldrev | |
239 | X-Git-Newrev: $newrev | |
7811aabb | 240 | Auto-Submitted: auto-generated |
4557e0de AP |
241 | |
242 | This is an automated email from the git hooks/post-receive script. It was | |
243 | generated because a ref change was pushed to the repository containing | |
244 | the project "$projectdesc". | |
245 | ||
246 | The $refname_type, $short_refname has been ${change_type}d | |
247 | EOF | |
248 | } | |
249 | ||
250 | generate_email_footer() | |
251 | { | |
71bd81ad | 252 | SPACE=" " |
4557e0de AP |
253 | cat <<-EOF |
254 | ||
255 | ||
256 | hooks/post-receive | |
71bd81ad | 257 | --${SPACE} |
4557e0de AP |
258 | $projectdesc |
259 | EOF | |
260 | } | |
261 | ||
262 | # --------------- Branches | |
263 | ||
264 | # | |
265 | # Called for the creation of a branch | |
266 | # | |
267 | generate_create_branch_email() | |
268 | { | |
269 | # This is a new branch and so oldrev is not valid | |
270 | echo " at $newrev ($newrev_type)" | |
271 | echo "" | |
272 | ||
273 | echo $LOGBEGIN | |
4471649f | 274 | show_new_revisions |
4557e0de AP |
275 | echo $LOGEND |
276 | } | |
277 | ||
278 | # | |
279 | # Called for the change of a pre-existing branch | |
280 | # | |
281 | generate_update_branch_email() | |
282 | { | |
283 | # Consider this: | |
284 | # 1 --- 2 --- O --- X --- 3 --- 4 --- N | |
285 | # | |
286 | # O is $oldrev for $refname | |
287 | # N is $newrev for $refname | |
288 | # X is a revision pointed to by some other ref, for which we may | |
289 | # assume that an email has already been generated. | |
290 | # In this case we want to issue an email containing only revisions | |
291 | # 3, 4, and N. Given (almost) by | |
292 | # | |
22fa97d4 | 293 | # git rev-list N ^O --not --all |
4557e0de AP |
294 | # |
295 | # The reason for the "almost", is that the "--not --all" will take | |
296 | # precedence over the "N", and effectively will translate to | |
297 | # | |
22fa97d4 | 298 | # git rev-list N ^O ^X ^N |
4557e0de | 299 | # |
22fa97d4 DM |
300 | # So, we need to build up the list more carefully. git rev-parse |
301 | # will generate a list of revs that may be fed into git rev-list. | |
15a2f530 GP |
302 | # We can get it to make the "--not --all" part and then filter out |
303 | # the "^N" with: | |
4557e0de | 304 | # |
22fa97d4 | 305 | # git rev-parse --not --all | grep -v N |
4557e0de | 306 | # |
22fa97d4 | 307 | # Then, using the --stdin switch to git rev-list we have effectively |
4557e0de AP |
308 | # manufactured |
309 | # | |
22fa97d4 | 310 | # git rev-list N ^O ^X |
4557e0de AP |
311 | # |
312 | # This leaves a problem when someone else updates the repository | |
15a2f530 GP |
313 | # while this script is running. Their new value of the ref we're |
314 | # working on would be included in the "--not --all" output; and as | |
315 | # our $newrev would be an ancestor of that commit, it would exclude | |
316 | # all of our commits. What we really want is to exclude the current | |
317 | # value of $refname from the --not list, rather than N itself. So: | |
4557e0de | 318 | # |
22fa97d4 | 319 | # git rev-parse --not --all | grep -v $(git rev-parse $refname) |
4557e0de | 320 | # |
15a2f530 | 321 | # Get's us to something pretty safe (apart from the small time |
22fa97d4 | 322 | # between refname being read, and git rev-parse running - for that, |
15a2f530 | 323 | # I give up) |
4557e0de AP |
324 | # |
325 | # | |
326 | # Next problem, consider this: | |
327 | # * --- B --- * --- O ($oldrev) | |
328 | # \ | |
329 | # * --- X --- * --- N ($newrev) | |
330 | # | |
15a2f530 GP |
331 | # That is to say, there is no guarantee that oldrev is a strict |
332 | # subset of newrev (it would have required a --force, but that's | |
333 | # allowed). So, we can't simply say rev-list $oldrev..$newrev. | |
334 | # Instead we find the common base of the two revs and list from | |
335 | # there. | |
4557e0de | 336 | # |
15a2f530 GP |
337 | # As above, we need to take into account the presence of X; if |
338 | # another branch is already in the repository and points at some of | |
339 | # the revisions that we are about to output - we don't want them. | |
22fa97d4 | 340 | # The solution is as before: git rev-parse output filtered. |
4557e0de | 341 | # |
15a2f530 | 342 | # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N |
4557e0de AP |
343 | # |
344 | # Tags pushed into the repository generate nice shortlog emails that | |
345 | # summarise the commits between them and the previous tag. However, | |
346 | # those emails don't include the full commit messages that we output | |
347 | # for a branch update. Therefore we still want to output revisions | |
348 | # that have been output on a tag email. | |
349 | # | |
22fa97d4 | 350 | # Luckily, git rev-parse includes just the tool. Instead of using |
15a2f530 GP |
351 | # "--all" we use "--branches"; this has the added benefit that |
352 | # "remotes/" will be ignored as well. | |
353 | ||
354 | # List all of the revisions that were removed by this update, in a | |
a75d7b54 FC |
355 | # fast-forward update, this list will be empty, because rev-list O |
356 | # ^N is empty. For a non-fast-forward, O ^N is the list of removed | |
15a2f530 | 357 | # revisions |
8e404f82 | 358 | fast_forward="" |
4557e0de AP |
359 | rev="" |
360 | for rev in $(git rev-list $newrev..$oldrev) | |
361 | do | |
362 | revtype=$(git cat-file -t "$rev") | |
363 | echo " discards $rev ($revtype)" | |
364 | done | |
365 | if [ -z "$rev" ]; then | |
366 | fast_forward=1 | |
367 | fi | |
368 | ||
369 | # List all the revisions from baserev to newrev in a kind of | |
15a2f530 GP |
370 | # "table-of-contents"; note this list can include revisions that |
371 | # have already had notification emails and is present to show the | |
372 | # full detail of the change from rolling back the old revision to | |
373 | # the base revision and then forward to the new revision | |
4557e0de AP |
374 | for rev in $(git rev-list $oldrev..$newrev) |
375 | do | |
376 | revtype=$(git cat-file -t "$rev") | |
377 | echo " via $rev ($revtype)" | |
378 | done | |
379 | ||
a2d6b872 | 380 | if [ "$fast_forward" ]; then |
4557e0de AP |
381 | echo " from $oldrev ($oldrev_type)" |
382 | else | |
15a2f530 GP |
383 | # 1. Existing revisions were removed. In this case newrev |
384 | # is a subset of oldrev - this is the reverse of a | |
385 | # fast-forward, a rewind | |
386 | # 2. New revisions were added on top of an old revision, | |
387 | # this is a rewind and addition. | |
024e5b31 | 388 | |
15a2f530 GP |
389 | # (1) certainly happened, (2) possibly. When (2) hasn't |
390 | # happened, we set a flag to indicate that no log printout | |
391 | # is required. | |
024e5b31 | 392 | |
4557e0de | 393 | echo "" |
024e5b31 | 394 | |
15a2f530 GP |
395 | # Find the common ancestor of the old and new revisions and |
396 | # compare it with newrev | |
024e5b31 AP |
397 | baserev=$(git merge-base $oldrev $newrev) |
398 | rewind_only="" | |
399 | if [ "$baserev" = "$newrev" ]; then | |
400 | echo "This update discarded existing revisions and left the branch pointing at" | |
401 | echo "a previous point in the repository history." | |
402 | echo "" | |
403 | echo " * -- * -- N ($newrev)" | |
404 | echo " \\" | |
405 | echo " O -- O -- O ($oldrev)" | |
406 | echo "" | |
7703477a | 407 | echo "The removed revisions are not necessarily gone - if another reference" |
024e5b31 AP |
408 | echo "still refers to them they will stay in the repository." |
409 | rewind_only=1 | |
410 | else | |
411 | echo "This update added new revisions after undoing existing revisions. That is" | |
412 | echo "to say, the old revision is not a strict subset of the new revision. This" | |
413 | echo "situation occurs when you --force push a change and generate a repository" | |
414 | echo "containing something like this:" | |
415 | echo "" | |
416 | echo " * -- * -- B -- O -- O -- O ($oldrev)" | |
417 | echo " \\" | |
418 | echo " N -- N -- N ($newrev)" | |
419 | echo "" | |
420 | echo "When this happens we assume that you've already had alert emails for all" | |
421 | echo "of the O revisions, and so we here report only the revisions in the N" | |
422 | echo "branch from the common base, B." | |
423 | fi | |
4557e0de AP |
424 | fi |
425 | ||
426 | echo "" | |
024e5b31 AP |
427 | if [ -z "$rewind_only" ]; then |
428 | echo "Those revisions listed above that are new to this repository have" | |
429 | echo "not appeared on any other notification email; so we list those" | |
430 | echo "revisions in full, below." | |
4557e0de | 431 | |
024e5b31 AP |
432 | echo "" |
433 | echo $LOGBEGIN | |
4471649f | 434 | show_new_revisions |
4557e0de | 435 | |
15a2f530 GP |
436 | # XXX: Need a way of detecting whether git rev-list actually |
437 | # outputted anything, so that we can issue a "no new | |
438 | # revisions added by this update" message | |
4557e0de | 439 | |
024e5b31 AP |
440 | echo $LOGEND |
441 | else | |
442 | echo "No new revisions were added by this update." | |
443 | fi | |
4557e0de | 444 | |
15a2f530 GP |
445 | # The diffstat is shown from the old revision to the new revision. |
446 | # This is to show the truth of what happened in this change. | |
447 | # There's no point showing the stat from the base to the new | |
448 | # revision because the base is effectively a random revision at this | |
449 | # point - the user will be interested in what this revision changed | |
450 | # - including the undoing of previous revisions in the case of | |
a75d7b54 | 451 | # non-fast-forward updates. |
4557e0de AP |
452 | echo "" |
453 | echo "Summary of changes:" | |
0d7c01c9 | 454 | git diff-tree $diffopts $oldrev..$newrev |
4557e0de AP |
455 | } |
456 | ||
457 | # | |
458 | # Called for the deletion of a branch | |
459 | # | |
460 | generate_delete_branch_email() | |
461 | { | |
462 | echo " was $oldrev" | |
463 | echo "" | |
64baa415 | 464 | echo $LOGBEGIN |
4557e0de AP |
465 | git show -s --pretty=oneline $oldrev |
466 | echo $LOGEND | |
467 | } | |
468 | ||
469 | # --------------- Annotated tags | |
470 | ||
471 | # | |
472 | # Called for the creation of an annotated tag | |
473 | # | |
474 | generate_create_atag_email() | |
475 | { | |
476 | echo " at $newrev ($newrev_type)" | |
477 | ||
478 | generate_atag_email | |
479 | } | |
480 | ||
481 | # | |
482 | # Called for the update of an annotated tag (this is probably a rare event | |
483 | # and may not even be allowed) | |
484 | # | |
485 | generate_update_atag_email() | |
486 | { | |
487 | echo " to $newrev ($newrev_type)" | |
488 | echo " from $oldrev (which is now obsolete)" | |
489 | ||
490 | generate_atag_email | |
491 | } | |
492 | ||
493 | # | |
494 | # Called when an annotated tag is created or changed | |
495 | # | |
496 | generate_atag_email() | |
497 | { | |
22fa97d4 | 498 | # Use git for-each-ref to pull out the individual fields from the |
15a2f530 | 499 | # tag |
4557e0de AP |
500 | eval $(git for-each-ref --shell --format=' |
501 | tagobject=%(*objectname) | |
502 | tagtype=%(*objecttype) | |
503 | tagger=%(taggername) | |
504 | tagged=%(taggerdate)' $refname | |
505 | ) | |
506 | ||
507 | echo " tagging $tagobject ($tagtype)" | |
508 | case "$tagtype" in | |
509 | commit) | |
15a2f530 | 510 | |
4557e0de | 511 | # If the tagged object is a commit, then we assume this is a |
15a2f530 GP |
512 | # release, and so we calculate which tag this tag is |
513 | # replacing | |
4557e0de AP |
514 | prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null) |
515 | ||
516 | if [ -n "$prevtag" ]; then | |
517 | echo " replaces $prevtag" | |
518 | fi | |
519 | ;; | |
520 | *) | |
521 | echo " length $(git cat-file -s $tagobject) bytes" | |
522 | ;; | |
523 | esac | |
524 | echo " tagged by $tagger" | |
525 | echo " on $tagged" | |
526 | ||
527 | echo "" | |
528 | echo $LOGBEGIN | |
529 | ||
15a2f530 GP |
530 | # Show the content of the tag message; this might contain a change |
531 | # log or release notes so is worth displaying. | |
4557e0de AP |
532 | git cat-file tag $newrev | sed -e '1,/^$/d' |
533 | ||
534 | echo "" | |
535 | case "$tagtype" in | |
536 | commit) | |
15a2f530 GP |
537 | # Only commit tags make sense to have rev-list operations |
538 | # performed on them | |
4557e0de AP |
539 | if [ -n "$prevtag" ]; then |
540 | # Show changes since the previous release | |
541 | git rev-list --pretty=short "$prevtag..$newrev" | git shortlog | |
542 | else | |
15a2f530 GP |
543 | # No previous tag, show all the changes since time |
544 | # began | |
4557e0de AP |
545 | git rev-list --pretty=short $newrev | git shortlog |
546 | fi | |
547 | ;; | |
548 | *) | |
15a2f530 GP |
549 | # XXX: Is there anything useful we can do for non-commit |
550 | # objects? | |
4557e0de AP |
551 | ;; |
552 | esac | |
553 | ||
554 | echo $LOGEND | |
555 | } | |
556 | ||
557 | # | |
558 | # Called for the deletion of an annotated tag | |
559 | # | |
560 | generate_delete_atag_email() | |
561 | { | |
562 | echo " was $oldrev" | |
563 | echo "" | |
64baa415 | 564 | echo $LOGBEGIN |
4557e0de AP |
565 | git show -s --pretty=oneline $oldrev |
566 | echo $LOGEND | |
567 | } | |
568 | ||
569 | # --------------- General references | |
570 | ||
571 | # | |
572 | # Called when any other type of reference is created (most likely a | |
573 | # non-annotated tag) | |
574 | # | |
575 | generate_create_general_email() | |
576 | { | |
577 | echo " at $newrev ($newrev_type)" | |
578 | ||
579 | generate_general_email | |
580 | } | |
581 | ||
582 | # | |
583 | # Called when any other type of reference is updated (most likely a | |
584 | # non-annotated tag) | |
585 | # | |
586 | generate_update_general_email() | |
587 | { | |
588 | echo " to $newrev ($newrev_type)" | |
589 | echo " from $oldrev" | |
590 | ||
591 | generate_general_email | |
592 | } | |
593 | ||
594 | # | |
595 | # Called for creation or update of any other type of reference | |
596 | # | |
597 | generate_general_email() | |
598 | { | |
15a2f530 GP |
599 | # Unannotated tags are more about marking a point than releasing a |
600 | # version; therefore we don't do the shortlog summary that we do for | |
601 | # annotated tags above - we simply show that the point has been | |
602 | # marked, and print the log message for the marked point for | |
603 | # reference purposes | |
4557e0de | 604 | # |
15a2f530 GP |
605 | # Note this section also catches any other reference type (although |
606 | # there aren't any) and deals with them in the same way. | |
4557e0de AP |
607 | |
608 | echo "" | |
609 | if [ "$newrev_type" = "commit" ]; then | |
610 | echo $LOGBEGIN | |
9225d7be | 611 | git show --no-color --root -s --pretty=medium $newrev |
4557e0de AP |
612 | echo $LOGEND |
613 | else | |
15a2f530 GP |
614 | # What can we do here? The tag marks an object that is not |
615 | # a commit, so there is no log for us to display. It's | |
22fa97d4 | 616 | # probably not wise to output git cat-file as it could be a |
15a2f530 | 617 | # binary blob. We'll just say how big it is |
4557e0de AP |
618 | echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long." |
619 | fi | |
620 | } | |
621 | ||
622 | # | |
623 | # Called for the deletion of any other type of reference | |
624 | # | |
625 | generate_delete_general_email() | |
626 | { | |
627 | echo " was $oldrev" | |
628 | echo "" | |
64baa415 | 629 | echo $LOGBEGIN |
4557e0de AP |
630 | git show -s --pretty=oneline $oldrev |
631 | echo $LOGEND | |
632 | } | |
633 | ||
4471649f PH |
634 | |
635 | # --------------- Miscellaneous utilities | |
636 | ||
637 | # | |
638 | # Show new revisions as the user would like to see them in the email. | |
639 | # | |
640 | show_new_revisions() | |
641 | { | |
642 | # This shows all log entries that are not already covered by | |
643 | # another ref - i.e. commits that are now accessible from this | |
644 | # ref that were previously not accessible | |
645 | # (see generate_update_branch_email for the explanation of this | |
646 | # command) | |
647 | ||
648 | # Revision range passed to rev-list differs for new vs. updated | |
649 | # branches. | |
650 | if [ "$change_type" = create ] | |
651 | then | |
652 | # Show all revisions exclusive to this (new) branch. | |
653 | revspec=$newrev | |
654 | else | |
655 | # Branch update; show revisions not part of $oldrev. | |
656 | revspec=$oldrev..$newrev | |
657 | fi | |
658 | ||
e5f5050e PN |
659 | other_branches=$(git for-each-ref --format='%(refname)' refs/heads/ | |
660 | grep -F -v $refname) | |
661 | git rev-parse --not $other_branches | | |
b0a7d111 PH |
662 | if [ -z "$custom_showrev" ] |
663 | then | |
664 | git rev-list --pretty --stdin $revspec | |
665 | else | |
666 | git rev-list --stdin $revspec | | |
667 | while read onerev | |
668 | do | |
669 | eval $(printf "$custom_showrev" $onerev) | |
670 | done | |
671 | fi | |
4471649f PH |
672 | } |
673 | ||
674 | ||
b03e7b7d KF |
675 | limit_lines() |
676 | { | |
677 | lines=0 | |
678 | skipped=0 | |
679 | while IFS="" read -r line; do | |
680 | lines=$((lines + 1)) | |
681 | if [ $lines -gt $1 ]; then | |
682 | skipped=$((skipped + 1)) | |
683 | else | |
684 | printf "%s\n" "$line" | |
685 | fi | |
686 | done | |
687 | if [ $skipped -ne 0 ]; then | |
688 | echo "... $skipped lines suppressed ..." | |
689 | fi | |
690 | } | |
691 | ||
692 | ||
d1637a07 JM |
693 | send_mail() |
694 | { | |
695 | if [ -n "$envelopesender" ]; then | |
696 | /usr/sbin/sendmail -t -f "$envelopesender" | |
697 | else | |
698 | /usr/sbin/sendmail -t | |
699 | fi | |
700 | } | |
701 | ||
4557e0de AP |
702 | # ---------------------------- main() |
703 | ||
704 | # --- Constants | |
4557e0de AP |
705 | LOGBEGIN="- Log -----------------------------------------------------------------" |
706 | LOGEND="-----------------------------------------------------------------------" | |
707 | ||
708 | # --- Config | |
709 | # Set GIT_DIR either from the working directory, or from the environment | |
710 | # variable. | |
711 | GIT_DIR=$(git rev-parse --git-dir 2>/dev/null) | |
712 | if [ -z "$GIT_DIR" ]; then | |
713 | echo >&2 "fatal: post-receive: GIT_DIR not set" | |
714 | exit 1 | |
715 | fi | |
716 | ||
80aa55b4 | 717 | projectdesc=$(sed -ne '1p' "$GIT_DIR/description" 2>/dev/null) |
15a2f530 GP |
718 | # Check if the description is unchanged from it's default, and shorten it to |
719 | # a more manageable length if it is | |
4557e0de AP |
720 | if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null |
721 | then | |
722 | projectdesc="UNNAMED PROJECT" | |
723 | fi | |
724 | ||
22fa97d4 DM |
725 | recipients=$(git config hooks.mailinglist) |
726 | announcerecipients=$(git config hooks.announcelist) | |
727 | envelopesender=$(git config hooks.envelopesender) | |
728 | emailprefix=$(git config hooks.emailprefix || echo '[SCM] ') | |
b0a7d111 | 729 | custom_showrev=$(git config hooks.showrev) |
b03e7b7d | 730 | maxlines=$(git config hooks.emailmaxlines) |
0d7c01c9 JJ |
731 | diffopts=$(git config hooks.diffopts) |
732 | : ${diffopts:="--stat --summary --find-copies-harder"} | |
4557e0de AP |
733 | |
734 | # --- Main loop | |
15a2f530 GP |
735 | # Allow dual mode: run from the command line just like the update hook, or |
736 | # if no arguments are given then run as a hook script | |
4557e0de AP |
737 | if [ -n "$1" -a -n "$2" -a -n "$3" ]; then |
738 | # Output to the terminal in command line mode - if someone wanted to | |
15a2f530 GP |
739 | # resend an email; they could redirect the output to sendmail |
740 | # themselves | |
53cad691 | 741 | prep_for_email $2 $3 $1 && PAGER= generate_email |
4557e0de | 742 | else |
4557e0de AP |
743 | while read oldrev newrev refname |
744 | do | |
53cad691 KF |
745 | prep_for_email $oldrev $newrev $refname || continue |
746 | generate_email $maxlines | send_mail | |
4557e0de AP |
747 | done |
748 | fi |