3 # 2010-09-01 tzz@lifelogs.com
5 # Use the email address of the author of the last commit.
6 export USER_EMAIL=$(git log -1 --format=format:%ae HEAD)
7 export USER_NAME=$(git log -1 --format=format:%an HEAD)
9 # the remainder is the standard git-core post-receive-email with some changes:
11 # - USER_EMAIL and USER_NAME are used in the header
12 # - the update message is after the diff
13 # - without annotations, we use `git log --format=oneline' to generate the change summary (joining multiples with semicolons)
15 # Copyright (c) 2007 Andy Parkins
17 # An example hook script to mail out commit update information. This hook
18 # sends emails listing new revisions to the repository introduced by the
19 # change being reported. The rule is that (for branch updates) each commit
20 # will appear on one email and one email only.
22 # This hook is stored in the contrib/hooks directory. Your distribution
23 # will have put this somewhere standard. You should make this script
24 # executable then link to it in the repository you would like to use it in.
25 # For example, on debian the hook is stored in
26 # /usr/share/doc/git-core/contrib/hooks/post-receive-email:
28 # chmod a+x post-receive-email
29 # cd /path/to/your/repository.git
30 # ln -sf /usr/share/doc/git-core/contrib/hooks/post-receive-email hooks/post-receive
32 # This hook script assumes it is enabled on the central repository of a
33 # project, with all users pushing only to it and not between each other. It
34 # will still work if you don't operate in that style, but it would become
35 # possible for the email to be from someone other than the person doing the
41 # This is the list that all pushes will go to; leave it blank to not send
42 # emails for every ref update.
44 # This is the list that all pushes of annotated tags will go to. Leave it
45 # blank to default to the mailinglist field. The announce emails lists
46 # the short log summary of the changes since the last annotated tag.
47 # hooks.envelopesender
48 # If set then the -f option is passed to sendmail to allow the envelope
49 # sender address to be set
51 # All emails have their subjects prefixed with this prefix, or "[SCM]"
52 # if emailprefix is unset, to aid filtering
54 # The shell command used to format each revision in the email, with
55 # "%s" replaced with the commit id. Defaults to "git rev-list -1
56 # --pretty %s", displaying the commit id, author, date and log
57 # message. To list full patches separated by a blank line, you
58 # could set this to "git show -C %s; echo".
59 # To list a gitweb/cgit URL *and* a full patch for each change set, use this:
60 # "t=%s; printf 'http://.../?id=%%s' \$t; echo;echo; git show -C \$t; echo"
61 # Be careful if "..." contains things that will be expanded by shell "eval"
66 # All emails include the headers "X-Git-Refname", "X-Git-Oldrev",
67 # "X-Git-Newrev", and "X-Git-Reftype" to enable fine tuned filtering and
68 # give information for debugging.
71 # ---------------------------- Functions
74 # Top level email generation function. This decides what type of update
75 # this is and calls the appropriate body-generation routine after outputting
78 # Note this function doesn't actually generate any email output, that is
79 # taken care of by the functions it calls:
80 # - generate_email_header
81 # - generate_create_XXXX_email
82 # - generate_update_XXXX_email
83 # - generate_delete_XXXX_email
84 # - generate_email_footer
89 oldrev=$(git rev-parse $1)
90 newrev=$(git rev-parse $2)
97 if expr "$oldrev" : '0*$' >/dev/null
101 if expr "$newrev" : '0*$' >/dev/null
109 # --- Get the revision types
110 newrev_type=$(git cat-file -t $newrev 2> /dev/null)
111 oldrev_type=$(git cat-file -t "$oldrev" 2> /dev/null)
112 case "$change_type" in
115 rev_type="$newrev_type"
119 rev_type="$oldrev_type"
123 # The revision type tells us what type the commit is, combined with
124 # the location of the ref we can decide between
129 case "$refname","$rev_type" in
133 short_refname=${refname##refs/tags/}
137 refname_type="annotated tag"
138 short_refname=${refname##refs/tags/}
140 if [ -n "$announcerecipients" ]; then
141 recipients="$announcerecipients"
146 refname_type="branch"
147 short_refname=${refname##refs/heads/}
149 refs/remotes/*,commit)
151 refname_type="tracking branch"
152 short_refname=${refname##refs/remotes/}
153 echo >&2 "*** Push-update of tracking branch, $refname"
154 echo >&2 "*** - no email generated."
158 # Anything else (is there anything else?)
159 echo >&2 "*** Unknown type of update to $refname ($rev_type)"
160 echo >&2 "*** - no email generated"
165 # Check if we've got anyone to send to
166 if [ -z "$recipients" ]; then
167 case "$refname_type" in
169 config_name="hooks.announcelist"
172 config_name="hooks.mailinglist"
175 echo >&2 "*** $config_name is not set so no email will be sent"
176 echo >&2 "*** for $refname update $oldrev->$newrev"
181 # The email subject will contain the best description of the ref
182 # that we can build from the parameters
183 describe=$(git describe $rev 2>/dev/null)
184 if [ -z "$describe" ]; then
185 describe=$((git log --format=oneline $oldrev...$newrev | perl -e'@p = <>; chomp @p; print join " ; ", @p') 2>/dev/null)
188 if [ -z "$describe" ]; then
192 generate_email_header
194 # Call the correct body generation function
196 case "$refname_type" in
197 "tracking branch"|branch)
204 generate_${change_type}_${fn_name}_email
206 generate_email_footer
209 generate_email_header()
211 # --- Email (all stdout will be the email)
214 From: ${USER_NAME} <${USER_EMAIL}>
216 Subject: ${emailprefix}$projectdesc $refname_type, $short_refname, ${change_type}d. $describe
217 X-Git-Refname: $refname
218 X-Git-Reftype: $refname_type
219 X-Git-Oldrev: $oldrev
220 X-Git-Newrev: $newrev
225 generate_email_footer()
230 This is an automated email from the git hooks/post-receive script. It was
231 generated because a ref change was pushed to the repository containing
232 the project "$projectdesc".
234 The $refname_type, $short_refname has been ${change_type}d
243 # --------------- Branches
246 # Called for the creation of a branch
248 generate_create_branch_email()
250 # This is a new branch and so oldrev is not valid
251 echo " at $newrev ($newrev_type)"
260 # Called for the change of a pre-existing branch
262 generate_update_branch_email()
265 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
267 # O is $oldrev for $refname
268 # N is $newrev for $refname
269 # X is a revision pointed to by some other ref, for which we may
270 # assume that an email has already been generated.
271 # In this case we want to issue an email containing only revisions
272 # 3, 4, and N. Given (almost) by
274 # git rev-list N ^O --not --all
276 # The reason for the "almost", is that the "--not --all" will take
277 # precedence over the "N", and effectively will translate to
279 # git rev-list N ^O ^X ^N
281 # So, we need to build up the list more carefully. git rev-parse
282 # will generate a list of revs that may be fed into git rev-list.
283 # We can get it to make the "--not --all" part and then filter out
286 # git rev-parse --not --all | grep -v N
288 # Then, using the --stdin switch to git rev-list we have effectively
291 # git rev-list N ^O ^X
293 # This leaves a problem when someone else updates the repository
294 # while this script is running. Their new value of the ref we're
295 # working on would be included in the "--not --all" output; and as
296 # our $newrev would be an ancestor of that commit, it would exclude
297 # all of our commits. What we really want is to exclude the current
298 # value of $refname from the --not list, rather than N itself. So:
300 # git rev-parse --not --all | grep -v $(git rev-parse $refname)
302 # Get's us to something pretty safe (apart from the small time
303 # between refname being read, and git rev-parse running - for that,
307 # Next problem, consider this:
308 # * --- B --- * --- O ($oldrev)
310 # * --- X --- * --- N ($newrev)
312 # That is to say, there is no guarantee that oldrev is a strict
313 # subset of newrev (it would have required a --force, but that's
314 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
315 # Instead we find the common base of the two revs and list from
318 # As above, we need to take into account the presence of X; if
319 # another branch is already in the repository and points at some of
320 # the revisions that we are about to output - we don't want them.
321 # The solution is as before: git rev-parse output filtered.
323 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
325 # Tags pushed into the repository generate nice shortlog emails that
326 # summarise the commits between them and the previous tag. However,
327 # those emails don't include the full commit messages that we output
328 # for a branch update. Therefore we still want to output revisions
329 # that have been output on a tag email.
331 # Luckily, git rev-parse includes just the tool. Instead of using
332 # "--all" we use "--branches"; this has the added benefit that
333 # "remotes/" will be ignored as well.
335 # List all of the revisions that were removed by this update, in a
336 # fast-forward update, this list will be empty, because rev-list O
337 # ^N is empty. For a non-fast-forward, O ^N is the list of removed
341 for rev in $(git rev-list $newrev..$oldrev)
343 revtype=$(git cat-file -t "$rev")
344 echo " discards $rev ($revtype)"
346 if [ -z "$rev" ]; then
350 # List all the revisions from baserev to newrev in a kind of
351 # "table-of-contents"; note this list can include revisions that
352 # have already had notification emails and is present to show the
353 # full detail of the change from rolling back the old revision to
354 # the base revision and then forward to the new revision
355 for rev in $(git rev-list $oldrev..$newrev)
357 revtype=$(git cat-file -t "$rev")
358 echo " via $rev ($revtype)"
361 if [ "$fast_forward" ]; then
362 echo " from $oldrev ($oldrev_type)"
364 # 1. Existing revisions were removed. In this case newrev
365 # is a subset of oldrev - this is the reverse of a
366 # fast-forward, a rewind
367 # 2. New revisions were added on top of an old revision,
368 # this is a rewind and addition.
370 # (1) certainly happened, (2) possibly. When (2) hasn't
371 # happened, we set a flag to indicate that no log printout
376 # Find the common ancestor of the old and new revisions and
377 # compare it with newrev
378 baserev=$(git merge-base $oldrev $newrev)
380 if [ "$baserev" = "$newrev" ]; then
381 echo "This update discarded existing revisions and left the branch pointing at"
382 echo "a previous point in the repository history."
384 echo " * -- * -- N ($newrev)"
386 echo " O -- O -- O ($oldrev)"
388 echo "The removed revisions are not necessarilly gone - if another reference"
389 echo "still refers to them they will stay in the repository."
392 echo "This update added new revisions after undoing existing revisions. That is"
393 echo "to say, the old revision is not a strict subset of the new revision. This"
394 echo "situation occurs when you --force push a change and generate a repository"
395 echo "containing something like this:"
397 echo " * -- * -- B -- O -- O -- O ($oldrev)"
399 echo " N -- N -- N ($newrev)"
401 echo "When this happens we assume that you've already had alert emails for all"
402 echo "of the O revisions, and so we here report only the revisions in the N"
403 echo "branch from the common base, B."
408 if [ -z "$rewind_only" ]; then
413 # XXX: Need a way of detecting whether git rev-list actually
414 # outputted anything, so that we can issue a "no new
415 # revisions added by this update" message
419 echo "Those revisions listed above that are new to this repository have"
420 echo "not appeared on any other notification email; so we listed those"
421 echo "revisions in full, above."
424 echo "No new revisions were added by this update."
427 # The diffstat is shown from the old revision to the new revision.
428 # This is to show the truth of what happened in this change.
429 # There's no point showing the stat from the base to the new
430 # revision because the base is effectively a random revision at this
431 # point - the user will be interested in what this revision changed
432 # - including the undoing of previous revisions in the case of
433 # non-fast-forward updates.
435 echo "Summary of changes:"
436 git diff-tree --stat --summary --find-copies-harder $oldrev..$newrev
440 # Called for the deletion of a branch
442 generate_delete_branch_email()
447 git show -s --pretty=oneline $oldrev
451 # --------------- Annotated tags
454 # Called for the creation of an annotated tag
456 generate_create_atag_email()
458 echo " at $newrev ($newrev_type)"
464 # Called for the update of an annotated tag (this is probably a rare event
465 # and may not even be allowed)
467 generate_update_atag_email()
469 echo " to $newrev ($newrev_type)"
470 echo " from $oldrev (which is now obsolete)"
476 # Called when an annotated tag is created or changed
478 generate_atag_email()
480 # Use git for-each-ref to pull out the individual fields from the
482 eval $(git for-each-ref --shell --format='
483 tagobject=%(*objectname)
484 tagtype=%(*objecttype)
486 tagged=%(taggerdate)' $refname
489 echo " tagging $tagobject ($tagtype)"
493 # If the tagged object is a commit, then we assume this is a
494 # release, and so we calculate which tag this tag is
496 prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null)
498 if [ -n "$prevtag" ]; then
499 echo " replaces $prevtag"
503 echo " length $(git cat-file -s $tagobject) bytes"
506 echo " tagged by $tagger"
512 # Show the content of the tag message; this might contain a change
513 # log or release notes so is worth displaying.
514 git cat-file tag $newrev | sed -e '1,/^$/d'
519 # Only commit tags make sense to have rev-list operations
521 if [ -n "$prevtag" ]; then
522 # Show changes since the previous release
523 git rev-list --pretty=short "$prevtag..$newrev" | git shortlog
525 # No previous tag, show all the changes since time
527 git rev-list --pretty=short $newrev | git shortlog
531 # XXX: Is there anything useful we can do for non-commit
540 # Called for the deletion of an annotated tag
542 generate_delete_atag_email()
547 git show -s --pretty=oneline $oldrev
551 # --------------- General references
554 # Called when any other type of reference is created (most likely a
557 generate_create_general_email()
559 echo " at $newrev ($newrev_type)"
561 generate_general_email
565 # Called when any other type of reference is updated (most likely a
568 generate_update_general_email()
570 echo " to $newrev ($newrev_type)"
573 generate_general_email
577 # Called for creation or update of any other type of reference
579 generate_general_email()
581 # Unannotated tags are more about marking a point than releasing a
582 # version; therefore we don't do the shortlog summary that we do for
583 # annotated tags above - we simply show that the point has been
584 # marked, and print the log message for the marked point for
587 # Note this section also catches any other reference type (although
588 # there aren't any) and deals with them in the same way.
591 if [ "$newrev_type" = "commit" ]; then
593 git show --no-color --root -s --pretty=medium $newrev
596 # What can we do here? The tag marks an object that is not
597 # a commit, so there is no log for us to display. It's
598 # probably not wise to output git cat-file as it could be a
599 # binary blob. We'll just say how big it is
600 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
605 # Called for the deletion of any other type of reference
607 generate_delete_general_email()
612 git show -s --pretty=oneline $oldrev
617 # --------------- Miscellaneous utilities
620 # Show new revisions as the user would like to see them in the email.
624 # This shows all log entries that are not already covered by
625 # another ref - i.e. commits that are now accessible from this
626 # ref that were previously not accessible
627 # (see generate_update_branch_email for the explanation of this
630 # Revision range passed to rev-list differs for new vs. updated
632 if [ "$change_type" = create ]
634 # Show all revisions exclusive to this (new) branch.
637 # Branch update; show revisions not part of $oldrev.
638 revspec=$oldrev..$newrev
641 other_branches=$(git for-each-ref --format='%(refname)' refs/heads/ |
643 git rev-parse --not $other_branches |
644 if [ -z "$custom_showrev" ]
646 git rev-list --pretty --stdin $revspec
648 git rev-list --stdin $revspec |
651 eval $(printf "$custom_showrev" $onerev)
659 if [ -n "$envelopesender" ]; then
660 /usr/sbin/sendmail -t -f "$envelopesender"
662 /usr/sbin/sendmail -t
666 # ---------------------------- main()
669 LOGBEGIN="- Log -----------------------------------------------------------------"
670 LOGEND="-----------------------------------------------------------------------"
673 # Set GIT_DIR either from the working directory, or from the environment
675 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
676 if [ -z "$GIT_DIR" ]; then
677 echo >&2 "fatal: post-receive: GIT_DIR not set"
681 projectdesc=$(sed -ne '1p' "$GIT_DIR/description")
682 # Check if the description is unchanged from it's default, and shorten it to
683 # a more manageable length if it is
684 if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null
686 projectdesc="UNNAMED PROJECT"
689 recipients=$(git config hooks.mailinglist)
690 announcerecipients=$(git config hooks.announcelist)
691 envelopesender=$(git config hooks.envelopesender)
692 emailprefix=$(git config hooks.emailprefix || echo '[SCM] ')
693 custom_showrev=$(git config hooks.showrev)
696 # Allow dual mode: run from the command line just like the update hook, or
697 # if no arguments are given then run as a hook script
698 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
699 # Output to the terminal in command line mode - if someone wanted to
700 # resend an email; they could redirect the output to sendmail
702 PAGER= generate_email $2 $3 $1
704 while read oldrev newrev refname
706 generate_email $oldrev $newrev $refname | send_mail