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"
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
166 # Call the correct body generation function
168 case "$refname_type" in
169 "tracking branch"|branch)
180 revs=$(list_${change_type}_branch_revs 2>/dev/null)
181 if [ "$(echo "$revs" | wc -l)" -gt 1 ]
186 if [ -z "$split" -a "$change_type" = "update" ]
189 set_update_branch_subject
190 generate_email_header
191 print_change_info $newrev
192 summarize_branch_revs
193 generate_email_footer
197 set_update_branch_subject
198 generate_email_header
199 generate_${change_type}_branch_email
200 summarize_branch_revs
201 generate_email_footer
208 set_update_branch_subject
209 generate_email_header
210 print_change_info $newrev
211 summarize_branch_revs
212 generate_email_footer
222 generate_email_header
223 generate_${change_type}_${fn_name}_email
224 generate_email_footer
230 generate_email_header()
232 # --- Email (all stdout will be the email)
234 print_change_type=" ${change_type}d"
235 case "$change_type" in
243 Subject: ${emailprefix}$projectdesc $refname_type $short_refname${print_change_type}: $detail$describe
244 X-Git-Refname: $refname
245 X-Git-Reftype: $refname_type
246 X-Git-Oldrev: $oldrev
247 X-Git-Newrev: $newrev
252 generate_email_footer()
262 # --------------- Branches
265 # Called for the creation of a branch
267 generate_create_branch_email()
269 # This is a new branch and so oldrev is not valid
270 echo " at $newrev ($newrev_type)"
273 list_create_branch_revs()
275 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
276 git rev-list --reverse --stdin $newrev
280 # Called for the change of a pre-existing branch
282 generate_update_branch_email()
284 # XXX only valid for fast forwards
286 # List all the revisions from baserev to newrev in a kind of
287 # "table-of-contents"; note this list can include revisions that
288 # have already had notification emails and is present to show the
289 # full detail of the change from rolling back the old revision to
290 # the base revision and then forward to the new revision
291 for rev in $(git rev-list $oldrev..$newrev)
293 revtype=$(git cat-file -t "$rev")
294 echo " via $rev ($revtype)"
297 echo " from $oldrev ($oldrev_type)"
302 set_update_branch_subject()
304 detail="$(git diff-tree -r --name-only $oldrev..$newrev | tr '\n' ' ') "
307 list_update_branch_revs()
309 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
310 git rev-list --reverse --stdin $oldrev..$newrev
313 summarize_branch_revs()
315 echo "Summary of changes:"
316 git diff-tree --stat --summary --find-copies-harder $oldrev..$newrev
318 if [ -n "$gitweburl" ]
321 echo "$gitweburl?p=$reponame;a=commitdiff;h=$newrev;hp=$oldrev"
327 git rev-list -n 1 --pretty $1
331 # Called for the deletion of a branch
333 generate_delete_branch_email()
338 git show -s --pretty=oneline $oldrev
342 # --------------- Annotated tags
345 # Called for the creation of an annotated tag
347 generate_create_atag_email()
349 echo " at $newrev ($newrev_type)"
355 # Called for the update of an annotated tag (this is probably a rare event
356 # and may not even be allowed)
358 generate_update_atag_email()
360 echo " to $newrev ($newrev_type)"
361 echo " from $oldrev (which is now obsolete)"
367 # Called when an annotated tag is created or changed
369 generate_atag_email()
371 # Use git for-each-ref to pull out the individual fields from the
373 eval $(git for-each-ref --shell --format='
374 tagobject=%(*objectname)
375 tagtype=%(*objecttype)
377 tagged=%(taggerdate)' $refname
380 echo " tagging $tagobject ($tagtype)"
384 # If the tagged object is a commit, then we assume this is a
385 # release, and so we calculate which tag this tag is
387 prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null)
389 if [ -n "$prevtag" ]; then
390 echo " replaces $prevtag"
394 echo " length $(git cat-file -s $tagobject) bytes"
397 echo " tagged by $tagger"
403 # Show the content of the tag message; this might contain a change
404 # log or release notes so is worth displaying.
405 git cat-file tag $newrev | sed -e '1,/^$/d'
410 # Only commit tags make sense to have rev-list operations
412 if [ -n "$prevtag" ]; then
413 # Show changes since the previous release
414 git rev-list --pretty=short "$prevtag..$newrev" | git shortlog
416 # No previous tag, show all the changes since time
418 git rev-list --pretty=short $newrev | git shortlog
422 # XXX: Is there anything useful we can do for non-commit
431 # Called for the deletion of an annotated tag
433 generate_delete_atag_email()
438 git show -s --pretty=oneline $oldrev
442 # --------------- General references
445 # Called when any other type of reference is created (most likely a
448 generate_create_general_email()
450 echo " at $newrev ($newrev_type)"
452 generate_general_email
456 # Called when any other type of reference is updated (most likely a
459 generate_update_general_email()
461 echo " to $newrev ($newrev_type)"
464 generate_general_email
468 # Called for creation or update of any other type of reference
470 generate_general_email()
472 # Unannotated tags are more about marking a point than releasing a
473 # version; therefore we don't do the shortlog summary that we do for
474 # annotated tags above - we simply show that the point has been
475 # marked, and print the log message for the marked point for
478 # Note this section also catches any other reference type (although
479 # there aren't any) and deals with them in the same way.
482 if [ "$newrev_type" = "commit" ]; then
484 git show --no-color --root -s --pretty=medium $newrev
487 # What can we do here? The tag marks an object that is not
488 # a commit, so there is no log for us to display. It's
489 # probably not wise to output git cat-file as it could be a
490 # binary blob. We'll just say how big it is
491 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
496 # Called for the deletion of any other type of reference
498 generate_delete_general_email()
503 git show -s --pretty=oneline $oldrev
509 if [ -n "$envelopesender" ]; then
510 /usr/sbin/sendmail -t -f "$envelopesender"
512 /usr/sbin/sendmail -t
516 # ---------------------------- main()
519 LOGBEGIN="- Log -----------------------------------------------------------------"
520 LOGEND="-----------------------------------------------------------------------"
523 # Set GIT_DIR either from the working directory, or from the environment
525 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
526 if [ -z "$GIT_DIR" ]; then
527 echo >&2 "fatal: post-receive: GIT_DIR not set"
531 projectdesc=$(sed -ne '1p' "$GIT_DIR/description")
532 # Check if the description is unchanged from it's default, and shorten it to
533 # a more manageable length if it is
534 if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null
536 projectdesc="UNNAMED PROJECT"
539 recipients=$(git config hooks.mailinglist)
540 announcerecipients=$(git config hooks.announcelist)
541 envelopesender=$(git config hooks.envelopesender)
542 emailprefix=$(git config hooks.emailprefix || echo '[SCM] ')
543 gitweburl=$(git config hooks.gitweburl)
544 reponame=$(git config hooks.reponame || basename $(realpath $GIT_DIR))
547 # Allow dual mode: run from the command line just like the update hook, or
548 # if no arguments are given then run as a hook script
549 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
550 # Output to the terminal in command line mode - if someone wanted to
551 # resend an email; they could redirect the output to sendmail
554 generate_email $2 $3 $1
556 while read oldrev newrev refname
559 generate_email $oldrev $newrev $refname