3 # Copyright (c) 2007 Andy Parkins
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.
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:
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
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
29 # This is the list that all pushes will go to; leave it blank to not send
30 # emails for every ref update.
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
39 # All emails have their subjects prefixed with this prefix, or "[SCM]"
40 # if emailprefix is unset, to aid filtering
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.
49 # ---------------------------- Functions
52 # Top level email generation function. This decides what type of update
53 # this is and calls the appropriate body-generation routine after outputting
56 # Note this function doesn't actually generate any email output, that is
57 # taken care of by the functions it calls:
58 # - generate_email_header
59 # - generate_create_XXXX_email
60 # - generate_update_XXXX_email
61 # - generate_delete_XXXX_email
62 # - generate_email_footer
67 oldrev=$(git rev-parse $1)
68 newrev=$(git rev-parse $2)
75 if expr "$oldrev" : '0*$' >/dev/null
79 if expr "$newrev" : '0*$' >/dev/null
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
93 rev_type="$newrev_type"
97 rev_type="$oldrev_type"
101 # The revision type tells us what type the commit is, combined with
102 # the location of the ref we can decide between
107 case "$refname","$rev_type" in
108 refs/tags/*,commit) # un-annotated tag
110 short_refname=${refname##refs/tags/}
112 refs/tags/*,tag) # annotated tag
113 refname_type="annotated tag"
114 short_refname=${refname##refs/tags/}
116 if [ -n "$announcerecipients" ]; then
117 recipients="$announcerecipients"
120 refs/heads/*,commit) # branch
121 refname_type="branch"
122 short_refname=${refname##refs/heads/}
124 refs/remotes/*,commit) # tracking branch
125 refname_type="tracking branch"
126 short_refname=${refname##refs/remotes/}
127 echo >&2 "*** Push-update of tracking branch, $refname"
128 echo >&2 "*** - no email generated."
131 *) # Anything else (is there anything else?)
132 echo >&2 "*** Unknown type of update to $refname ($rev_type)"
133 echo >&2 "*** - no email generated"
138 # Check if we've got anyone to send to
139 if [ -z "$recipients" ]; then
140 case "$refname_type" in
142 config_name="hooks.announcelist"
145 config_name="hooks.mailinglist"
148 echo >&2 "*** $config_name is not set so no email will be sent"
149 echo >&2 "*** for $refname update $oldrev->$newrev"
154 # The email subject will contain the best description of the ref
155 # that we can build from the parameters
156 describe=$(git describe $rev 2>/dev/null)
157 if [ -z "$describe" ]; then
161 generate_email_header
163 # Call the correct body generation function
165 case "$refname_type" in
166 "tracking branch"|branch)
173 generate_${change_type}_${fn_name}_email
175 generate_email_footer
178 # generate a pattern for testing if a string is a hash
179 hpat="";__=1; while [ $__ -le 40 ] ; do hpat=${hpat}'[0-9a-f]';__=$(($__+1)); done
180 function is_hash () {
183 case $hash in $hpat) return 0;; *) return 1;; esac
186 generate_email_header()
188 # --- Email (all stdout will be the email)
189 # optimize output for branch, master
191 if [ "$refname_type" == branch -a "$short_refname" == master ] ; then
194 details="$refname_type, $short_refname,"
196 # trying to improve the layout of $describe
197 # in some cases we get a plain hash, some other times we're getting a composite like
198 # TagName-NumOfCommitsAfterTag-Hash
199 # simple first idea: if it looks like a plain hash, truncate it,
200 # otherwise preserve as-is for now
202 # shortrev=$(awk -F - '{print $NF;}' <<< $describe)
204 is_hash $shortrev && shortrev="$(cut -b1-8 <<< $shortrev).."
208 Subject: ${emailprefix}$projectdesc ${details}${change_type}d. ${shortrev}
209 X-Git-Refname: $refname
210 X-Git-Reftype: $refname_type
211 X-Git-Oldrev: $oldrev
212 X-Git-Newrev: $newrev
214 On $projectdesc, the $refname_type, $short_refname has been ${change_type}d
218 generate_email_footer()
229 # --------------- Branches
232 # Called for the creation of a branch
234 generate_create_branch_email()
236 # This is a new branch and so oldrev is not valid
237 echo " at $newrev ($newrev_type)"
241 # This shows all log entries that are not already covered by
242 # another ref - i.e. commits that are now accessible from this
243 # ref that were previously not accessible
244 # (see generate_update_branch_email for the explanation of this
246 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
247 git rev-list --pretty --stdin $newrev
252 # Called for the change of a pre-existing branch
254 generate_update_branch_email()
257 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
259 # O is $oldrev for $refname
260 # N is $newrev for $refname
261 # X is a revision pointed to by some other ref, for which we may
262 # assume that an email has already been generated.
263 # In this case we want to issue an email containing only revisions
264 # 3, 4, and N. Given (almost) by
266 # git rev-list N ^O --not --all
268 # The reason for the "almost", is that the "--not --all" will take
269 # precedence over the "N", and effectively will translate to
271 # git rev-list N ^O ^X ^N
273 # So, we need to build up the list more carefully. git rev-parse
274 # will generate a list of revs that may be fed into git rev-list.
275 # We can get it to make the "--not --all" part and then filter out
278 # git rev-parse --not --all | grep -v N
280 # Then, using the --stdin switch to git rev-list we have effectively
283 # git rev-list N ^O ^X
285 # This leaves a problem when someone else updates the repository
286 # while this script is running. Their new value of the ref we're
287 # working on would be included in the "--not --all" output; and as
288 # our $newrev would be an ancestor of that commit, it would exclude
289 # all of our commits. What we really want is to exclude the current
290 # value of $refname from the --not list, rather than N itself. So:
292 # git rev-parse --not --all | grep -v $(git rev-parse $refname)
294 # Get's us to something pretty safe (apart from the small time
295 # between refname being read, and git rev-parse running - for that,
299 # Next problem, consider this:
300 # * --- B --- * --- O ($oldrev)
302 # * --- X --- * --- N ($newrev)
304 # That is to say, there is no guarantee that oldrev is a strict
305 # subset of newrev (it would have required a --force, but that's
306 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
307 # Instead we find the common base of the two revs and list from
310 # As above, we need to take into account the presence of X; if
311 # another branch is already in the repository and points at some of
312 # the revisions that we are about to output - we don't want them.
313 # The solution is as before: git rev-parse output filtered.
315 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
317 # Tags pushed into the repository generate nice shortlog emails that
318 # summarise the commits between them and the previous tag. However,
319 # those emails don't include the full commit messages that we output
320 # for a branch update. Therefore we still want to output revisions
321 # that have been output on a tag email.
323 # Luckily, git rev-parse includes just the tool. Instead of using
324 # "--all" we use "--branches"; this has the added benefit that
325 # "remotes/" will be ignored as well.
327 # List all of the revisions that were removed by this update, in a
328 # fast forward update, this list will be empty, because rev-list O
329 # ^N is empty. For a non fast forward, O ^N is the list of removed
333 for rev in $(git rev-list $newrev..$oldrev)
335 revtype=$(git cat-file -t "$rev")
336 echo " discards $rev ($revtype)"
338 if [ -z "$rev" ]; then
342 # List all the revisions from baserev to newrev in a kind of
343 # "table-of-contents"; note this list can include revisions that
344 # have already had notification emails and is present to show the
345 # full detail of the change from rolling back the old revision to
346 # the base revision and then forward to the new revision
347 for rev in $(git rev-list $oldrev..$newrev)
349 revtype=$(git cat-file -t "$rev")
350 echo " via $rev ($revtype)"
353 if [ "$fast_forward" ]; then
354 echo " from $oldrev ($oldrev_type)"
356 # 1. Existing revisions were removed. In this case newrev
357 # is a subset of oldrev - this is the reverse of a
358 # fast-forward, a rewind
359 # 2. New revisions were added on top of an old revision,
360 # this is a rewind and addition.
361 # (1) certainly happened, (2) possibly. When (2) hasn't
362 # happened, we set a flag to indicate that no log printout
367 # Find the common ancestor of the old and new revisions and
368 # compare it with newrev
369 baserev=$(git merge-base $oldrev $newrev)
371 if [ "$baserev" = "$newrev" ]; then
372 echo "This update discarded existing revisions and left the branch pointing at"
373 echo "a previous point in the repository history."
375 echo " * -- * -- N ($newrev)"
377 echo " O -- O -- O ($oldrev)"
379 echo "The removed revisions are not necessarilly gone - if another reference"
380 echo "still refers to them they will stay in the repository."
383 echo "This update added new revisions after undoing existing revisions. That is"
384 echo "to say, the old revision is not a strict subset of the new revision. This"
385 echo "situation occurs when you --force push a change and generate a repository"
386 echo "containing something like this:"
388 echo " * -- * -- B -- O -- O -- O ($oldrev)"
390 echo " N -- N -- N ($newrev)"
392 echo "When this happens we assume that you've already had alert emails for all"
393 echo "of the O revisions, and so we here report only the revisions in the N"
394 echo "branch from the common base, B."
399 if [ -z "$rewind_only" ]; then
402 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
403 git rev-list --pretty --stdin $oldrev..$newrev
405 # XXX: Need a way of detecting whether git rev-list actually
406 # outputted anything, so that we can issue a "no new
407 # revisions added by this update" message
411 echo "No new revisions were added by this update."
414 # The diffstat is shown from the old revision to the new revision.
415 # This is to show the truth of what happened in this change.
416 # There's no point showing the stat from the base to the new
417 # revision because the base is effectively a random revision at this
418 # point - the user will be interested in what this revision changed
419 # - including the undoing of previous revisions in the case of
420 # non-fast forward updates.
422 echo "Summary of changes:"
423 git diff-tree --stat --summary --find-copies-harder $oldrev..$newrev
426 echo "Changes between commits $(cut -b1-8 <<< $oldrev)..$(cut -b1-8 <<< $newrev)"
427 git diff $oldrev..$newrev
431 # Called for the deletion of a branch
433 generate_delete_branch_email()
438 git show -s --pretty=oneline $oldrev
442 # --------------- Annotated tags
445 # Called for the creation of an annotated tag
447 generate_create_atag_email()
449 echo " at $newrev ($newrev_type)"
455 # Called for the update of an annotated tag (this is probably a rare event
456 # and may not even be allowed)
458 generate_update_atag_email()
460 echo " to $newrev ($newrev_type)"
461 echo " from $oldrev (which is now obsolete)"
467 # Called when an annotated tag is created or changed
469 generate_atag_email()
471 # Use git for-each-ref to pull out the individual fields from the tag
472 eval $(git for-each-ref --shell --format='
473 tagobject=%(*objectname)
474 tagtype=%(*objecttype)
476 tagged=%(taggerdate)' $refname
479 echo " tagging $tagobject ($tagtype)"
483 # If the tagged object is a commit, then we assume this is a
484 # release, and so we calculate which tag this tag is
486 prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null)
488 if [ -n "$prevtag" ]; then
489 echo " replaces $prevtag"
493 echo " length $(git cat-file -s $tagobject) bytes"
496 echo " tagged by $tagger"
502 # Show the content of the tag message; this might contain a change
503 # log or release notes so is worth displaying.
504 git cat-file tag $newrev | sed -e '1,/^$/d'
509 # Only commit tags make sense to have rev-list operations
511 if [ -n "$prevtag" ]; then
512 # Show changes since the previous release
513 git rev-list --pretty=short "$prevtag..$newrev" | git shortlog
515 # No previous tag, show all the changes since time began
516 git rev-list --pretty=short $newrev | git shortlog
520 # XXX: Is there anything useful we can do for non-commit objects?
528 # Called for the deletion of an annotated tag
530 generate_delete_atag_email()
535 git show -s --pretty=oneline $oldrev
539 # --------------- General references
542 # Called when any other type of reference is created (most likely a
545 generate_create_general_email()
547 echo " at $newrev ($newrev_type)"
549 generate_general_email
553 # Called when any other type of reference is updated (most likely a
556 generate_update_general_email()
558 echo " to $newrev ($newrev_type)"
561 generate_general_email
565 # Called for creation or update of any other type of reference
567 generate_general_email()
569 # Unannotated tags are more about marking a point than releasing a
570 # version; therefore we don't do the shortlog summary that we do for
571 # annotated tags above - we simply show that the point has been
572 # marked, and print the log message for the marked point for
575 # Note this section also catches any other reference type (although
576 # there aren't any) and deals with them in the same way.
579 if [ "$newrev_type" = "commit" ]; then
581 git show --no-color --root -s $newrev
584 # What can we do here? The tag marks an object that is not
585 # a commit, so there is no log for us to display. It's
586 # probably not wise to output git cat-file as it could be a
587 # binary blob. We'll just say how big it is
588 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
593 # Called for the deletion of any other type of reference
595 generate_delete_general_email()
600 git show -s --pretty=oneline $oldrev
606 COMMITTER=$(git-for-each-ref --format='%(committer)' --sort=-committerdate count=1 refs/heads)
607 COMMITTERNAME=$(cut -d'<' -f1 <<< $COMMITTER)
608 if [ -n "$envelopesender" ] ; then
609 COMMITTERMAIL=$envelopesender
611 COMMITTERMAIL=$(cut -d'<' -f2 <<< $COMMITTER |cut -d'>' -f1)
613 /usr/sbin/sendmail -t -f "$COMMITTERMAIL" -F "$COMMITTERNAME"
616 # ---------------------------- main()
619 LOGBEGIN="-----------------------------------------------------------------------"
620 LOGEND="-----------------------------------------------------------------------"
623 # Set GIT_DIR either from the working directory, or from the environment
625 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
626 if [ -z "$GIT_DIR" ]; then
627 echo >&2 "fatal: post-receive: GIT_DIR not set"
631 if [ -f "$GIT_DIR/description" ]; then
632 projectdesc=$(sed -ne '1p' "$GIT_DIR/description")
634 projectdesc=$(git-config gitweb.description)
636 # Check if the description is unchanged from it's default, and shorten it to
637 # a more manageable length if it is
638 if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null
640 projectdesc="UNNAMED PROJECT"
643 recipients=$(git config hooks.mailinglist)
644 announcerecipients=$(git config hooks.announcelist)
645 envelopesender=$(git config hooks.envelopesender)
646 emailprefix=$(git config hooks.emailprefix || echo '[SCM] ')
649 # Allow dual mode: run from the command line just like the update hook, or
650 # if no arguments are given then run as a hook script
651 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
652 # Output to the terminal in command line mode - if someone wanted to
653 # resend an email; they could redirect the output to sendmail
655 PAGER= generate_email $2 $3 $1
657 while read oldrev newrev refname
659 generate_email $oldrev $newrev $refname | send_mail