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