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
111 short_refname=${refname##refs/tags/}
115 refname_type="annotated tag"
116 short_refname=${refname##refs/tags/}
118 if [ -n "$announcerecipients" ]; then
119 recipients="$announcerecipients"
124 refname_type="branch"
125 short_refname=${refname##refs/heads/}
127 refs/remotes/*,commit)
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."
136 # Anything else (is there anything else?)
137 echo >&2 "*** Unknown type of update to $refname ($rev_type)"
138 echo >&2 "*** - no email generated"
143 # Check if we've got anyone to send to
144 if [ -z "$recipients" ]; then
145 case "$refname_type" in
147 config_name="hooks.announcelist"
150 config_name="hooks.mailinglist"
153 echo >&2 "*** $config_name is not set so no email will be sent"
154 echo >&2 "*** for $refname update $oldrev->$newrev"
158 # The email subject will contain the best description of the ref
159 # that we can build from the parameters
162 # Call the correct body generation function
164 case "$refname_type" in
165 "tracking branch"|branch)
176 revs=$(list_${change_type}_branch_revs 2>/dev/null)
177 if [ "$(echo "$revs" | wc -l)" -gt 1 ]
182 if [ "$change_type" != "update" ]
184 set_update_branch_subject
186 generate_email_header
187 generate_${change_type}_branch_email
188 summarize_branch_revs
189 generate_email_footer
199 # set_update_branch_subject will return false if the
200 # commit is boring (no change). Then we don't even
202 set_update_branch_subject || continue
204 generate_email_header
205 print_change_info $newrev
206 summarize_branch_revs
207 generate_email_footer
214 generate_email_header
215 generate_${change_type}_${fn_name}_email
216 generate_email_footer
224 describe=$(git describe $1 2>/dev/null)
225 if [ -z "$describe" ]; then
230 generate_email_header()
232 # --- Email (all stdout will be the email)
234 print_change_type=" ${change_type}d"
235 case "$change_type" in
241 print_refname="$refname_type "
242 case "$refname_type" in
250 Subject: ${emailprefix}$print_refname$short_refname${print_change_type}: $describe
251 X-Git-Refname: $refname
252 X-Git-Reftype: $refname_type
253 X-Git-Newrev: $newrev
258 generate_email_footer()
268 # --------------- Branches
271 # Called for the creation of a branch
273 generate_create_branch_email()
275 # This is a new branch and so oldrev is not valid
276 echo " at $newrev ($newrev_type)"
279 list_create_branch_revs()
281 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
282 git rev-list --reverse --stdin $newrev
286 # Called for the change of a pre-existing branch
288 generate_update_branch_email()
290 # XXX only valid for fast forwards
292 # List all the revisions from baserev to newrev in a kind of
293 # "table-of-contents"; note this list can include revisions that
294 # have already had notification emails and is present to show the
295 # full detail of the change from rolling back the old revision to
296 # the base revision and then forward to the new revision
297 for rev in $(git rev-list $oldrev..$newrev)
299 revtype=$(git cat-file -t "$rev")
300 echo " via $rev ($revtype)"
303 echo " from $oldrev ($oldrev_type)"
308 skip_diff_tree_parent()
318 set_update_branch_subject()
322 describe="$(git diff-tree -r --name-only $oldrev${oldrev:+..}$newrev |
323 skip_diff_tree_parent | sed -e 's/^/ /') $describe"
324 [ -n "$(git diff-tree -r --name-only --cc $oldrev${oldrev:+..}$newrev |
325 skip_diff_tree_parent)" ]
328 list_update_branch_revs()
330 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
331 git rev-list --reverse --stdin $oldrev..$newrev
334 summarize_branch_revs()
336 echo "Summary of changes:"
337 git diff-tree --stat --summary --find-copies-harder $oldrev${oldrev:+..}$newrev | skip_diff_tree_parent
339 if [ -n "$gitweburl" ]
342 echo "$gitweburl?p=$reponame;a=commitdiff;h=$newrev${oldrev:+;hp=}$oldrev"
348 git rev-list -n 1 --pretty $1
352 # Called for the deletion of a branch
354 generate_delete_branch_email()
359 git show -s --pretty=oneline $oldrev
363 # --------------- Annotated tags
366 # Called for the creation of an annotated tag
368 generate_create_atag_email()
370 echo " at $newrev ($newrev_type)"
376 # Called for the update of an annotated tag (this is probably a rare event
377 # and may not even be allowed)
379 generate_update_atag_email()
381 echo " to $newrev ($newrev_type)"
382 echo " from $oldrev (which is now obsolete)"
388 # Called when an annotated tag is created or changed
390 generate_atag_email()
392 # Use git for-each-ref to pull out the individual fields from the
394 eval $(git for-each-ref --shell --format='
395 tagobject=%(*objectname)
396 tagtype=%(*objecttype)
398 tagged=%(taggerdate)' $refname
401 echo " tagging $tagobject ($tagtype)"
405 # If the tagged object is a commit, then we assume this is a
406 # release, and so we calculate which tag this tag is
408 prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null)
410 if [ -n "$prevtag" ]; then
411 echo " replaces $prevtag"
415 echo " length $(git cat-file -s $tagobject) bytes"
418 echo " tagged by $tagger"
424 # Show the content of the tag message; this might contain a change
425 # log or release notes so is worth displaying.
426 git cat-file tag $newrev | sed -e '1,/^$/d'
431 # Only commit tags make sense to have rev-list operations
433 if [ -n "$prevtag" ]; then
434 # Show changes since the previous release
435 git rev-list --pretty=short "$prevtag..$newrev" | git shortlog
437 # No previous tag, show all the changes since time
439 git rev-list --pretty=short $newrev | git shortlog
443 # XXX: Is there anything useful we can do for non-commit
452 # Called for the deletion of an annotated tag
454 generate_delete_atag_email()
459 git show -s --pretty=oneline $oldrev
463 # --------------- General references
466 # Called when any other type of reference is created (most likely a
469 generate_create_general_email()
471 echo " at $newrev ($newrev_type)"
473 generate_general_email
477 # Called when any other type of reference is updated (most likely a
480 generate_update_general_email()
482 echo " to $newrev ($newrev_type)"
485 generate_general_email
489 # Called for creation or update of any other type of reference
491 generate_general_email()
493 # Unannotated tags are more about marking a point than releasing a
494 # version; therefore we don't do the shortlog summary that we do for
495 # annotated tags above - we simply show that the point has been
496 # marked, and print the log message for the marked point for
499 # Note this section also catches any other reference type (although
500 # there aren't any) and deals with them in the same way.
503 if [ "$newrev_type" = "commit" ]; then
505 git show --no-color --root -s --pretty=medium $newrev
508 # What can we do here? The tag marks an object that is not
509 # a commit, so there is no log for us to display. It's
510 # probably not wise to output git cat-file as it could be a
511 # binary blob. We'll just say how big it is
512 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
517 # Called for the deletion of any other type of reference
519 generate_delete_general_email()
524 git show -s --pretty=oneline $oldrev
530 if [ -n "$envelopesender" ]; then
531 /usr/sbin/sendmail -t -f "$envelopesender"
533 /usr/sbin/sendmail -t
537 # ---------------------------- main()
540 LOGBEGIN="- Log -----------------------------------------------------------------"
541 LOGEND="-----------------------------------------------------------------------"
544 # Set GIT_DIR either from the working directory, or from the environment
546 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
547 if [ -z "$GIT_DIR" ]; then
548 echo >&2 "fatal: post-receive: GIT_DIR not set"
552 projectdesc=$(sed -ne '1p' "$GIT_DIR/description")
553 # Check if the description is unchanged from it's default, and shorten it to
554 # a more manageable length if it is
555 if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null
557 projectdesc="UNNAMED PROJECT"
560 recipients=$(git config hooks.mailinglist)
561 announcerecipients=$(git config hooks.announcelist)
562 envelopesender=$(git config hooks.envelopesender)
563 emailprefix=$(git config hooks.emailprefix || echo '[SCM] ')
564 gitweburl=$(git config hooks.gitweburl)
565 reponame=$(git config hooks.reponame || basename $(realpath $GIT_DIR))
568 # Allow dual mode: run from the command line just like the update hook, or
569 # if no arguments are given then run as a hook script
570 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
571 # Output to the terminal in command line mode - if someone wanted to
572 # resend an email; they could redirect the output to sendmail
575 generate_email $2 $3 $1
577 while read oldrev newrev refname
580 generate_email $oldrev $newrev $refname