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