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 generate_email_header
168 # Call the correct body generation function
170 case "$refname_type" in
171 "tracking branch"|branch)
178 generate_${change_type}_${fn_name}_email
180 generate_email_footer
183 generate_email_header()
185 # --- Email (all stdout will be the email)
189 Subject: ${emailprefix}$projectdesc $refname_type, $short_refname, ${change_type}d. $describe
190 X-Git-Refname: $refname
191 X-Git-Reftype: $refname_type
192 X-Git-Oldrev: $oldrev
193 X-Git-Newrev: $newrev
195 On $projectdesc, the $refname_type, $short_refname has been ${change_type}d
199 generate_email_footer()
210 # --------------- Branches
213 # Called for the creation of a branch
215 generate_create_branch_email()
217 # This is a new branch and so oldrev is not valid
218 echo " at $newrev ($newrev_type)"
222 # This shows all log entries that are not already covered by
223 # another ref - i.e. commits that are now accessible from this
224 # ref that were previously not accessible
225 # (see generate_update_branch_email for the explanation of this
227 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
228 git rev-list --pretty --stdin $newrev
233 # Called for the change of a pre-existing branch
235 generate_update_branch_email()
238 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
240 # O is $oldrev for $refname
241 # N is $newrev for $refname
242 # X is a revision pointed to by some other ref, for which we may
243 # assume that an email has already been generated.
244 # In this case we want to issue an email containing only revisions
245 # 3, 4, and N. Given (almost) by
247 # git rev-list N ^O --not --all
249 # The reason for the "almost", is that the "--not --all" will take
250 # precedence over the "N", and effectively will translate to
252 # git rev-list N ^O ^X ^N
254 # So, we need to build up the list more carefully. git rev-parse
255 # will generate a list of revs that may be fed into git rev-list.
256 # We can get it to make the "--not --all" part and then filter out
259 # git rev-parse --not --all | grep -v N
261 # Then, using the --stdin switch to git rev-list we have effectively
264 # git rev-list N ^O ^X
266 # This leaves a problem when someone else updates the repository
267 # while this script is running. Their new value of the ref we're
268 # working on would be included in the "--not --all" output; and as
269 # our $newrev would be an ancestor of that commit, it would exclude
270 # all of our commits. What we really want is to exclude the current
271 # value of $refname from the --not list, rather than N itself. So:
273 # git rev-parse --not --all | grep -v $(git rev-parse $refname)
275 # Get's us to something pretty safe (apart from the small time
276 # between refname being read, and git rev-parse running - for that,
280 # Next problem, consider this:
281 # * --- B --- * --- O ($oldrev)
283 # * --- X --- * --- N ($newrev)
285 # That is to say, there is no guarantee that oldrev is a strict
286 # subset of newrev (it would have required a --force, but that's
287 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
288 # Instead we find the common base of the two revs and list from
291 # As above, we need to take into account the presence of X; if
292 # another branch is already in the repository and points at some of
293 # the revisions that we are about to output - we don't want them.
294 # The solution is as before: git rev-parse output filtered.
296 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
298 # Tags pushed into the repository generate nice shortlog emails that
299 # summarise the commits between them and the previous tag. However,
300 # those emails don't include the full commit messages that we output
301 # for a branch update. Therefore we still want to output revisions
302 # that have been output on a tag email.
304 # Luckily, git rev-parse includes just the tool. Instead of using
305 # "--all" we use "--branches"; this has the added benefit that
306 # "remotes/" will be ignored as well.
308 # List all of the revisions that were removed by this update, in a
309 # fast forward update, this list will be empty, because rev-list O
310 # ^N is empty. For a non fast forward, O ^N is the list of removed
314 for rev in $(git rev-list $newrev..$oldrev)
316 revtype=$(git cat-file -t "$rev")
317 echo " discards $rev ($revtype)"
319 if [ -z "$rev" ]; then
323 # List all the revisions from baserev to newrev in a kind of
324 # "table-of-contents"; note this list can include revisions that
325 # have already had notification emails and is present to show the
326 # full detail of the change from rolling back the old revision to
327 # the base revision and then forward to the new revision
328 for rev in $(git rev-list $oldrev..$newrev)
330 revtype=$(git cat-file -t "$rev")
331 echo " via $rev ($revtype)"
334 if [ "$fast_forward" ]; then
335 echo " from $oldrev ($oldrev_type)"
337 # 1. Existing revisions were removed. In this case newrev
338 # is a subset of oldrev - this is the reverse of a
339 # fast-forward, a rewind
340 # 2. New revisions were added on top of an old revision,
341 # this is a rewind and addition.
343 # (1) certainly happened, (2) possibly. When (2) hasn't
344 # happened, we set a flag to indicate that no log printout
349 # Find the common ancestor of the old and new revisions and
350 # compare it with newrev
351 baserev=$(git merge-base $oldrev $newrev)
353 if [ "$baserev" = "$newrev" ]; then
354 echo "This update discarded existing revisions and left the branch pointing at"
355 echo "a previous point in the repository history."
357 echo " * -- * -- N ($newrev)"
359 echo " O -- O -- O ($oldrev)"
361 echo "The removed revisions are not necessarilly gone - if another reference"
362 echo "still refers to them they will stay in the repository."
365 echo "This update added new revisions after undoing existing revisions. That is"
366 echo "to say, the old revision is not a strict subset of the new revision. This"
367 echo "situation occurs when you --force push a change and generate a repository"
368 echo "containing something like this:"
370 echo " * -- * -- B -- O -- O -- O ($oldrev)"
372 echo " N -- N -- N ($newrev)"
374 echo "When this happens we assume that you've already had alert emails for all"
375 echo "of the O revisions, and so we here report only the revisions in the N"
376 echo "branch from the common base, B."
381 if [ -z "$rewind_only" ]; then
384 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
385 git rev-list --pretty --stdin $oldrev..$newrev
387 # XXX: Need a way of detecting whether git rev-list actually
388 # outputted anything, so that we can issue a "no new
389 # revisions added by this update" message
393 echo "No new revisions were added by this update."
396 # The diffstat is shown from the old revision to the new revision.
397 # This is to show the truth of what happened in this change.
398 # There's no point showing the stat from the base to the new
399 # revision because the base is effectively a random revision at this
400 # point - the user will be interested in what this revision changed
401 # - including the undoing of previous revisions in the case of
402 # non-fast forward updates.
404 echo "Summary of changes:"
405 git diff-tree --stat --summary --find-copies-harder $oldrev..$newrev
408 echo "Changes between commits $(cut -b1-8 <<< $oldrev)..$(cut -b1-8 <<< $newrev)"
409 git diff $oldrev..$newrev
413 # Called for the deletion of a branch
415 generate_delete_branch_email()
420 git show -s --pretty=oneline $oldrev
424 # --------------- Annotated tags
427 # Called for the creation of an annotated tag
429 generate_create_atag_email()
431 echo " at $newrev ($newrev_type)"
437 # Called for the update of an annotated tag (this is probably a rare event
438 # and may not even be allowed)
440 generate_update_atag_email()
442 echo " to $newrev ($newrev_type)"
443 echo " from $oldrev (which is now obsolete)"
449 # Called when an annotated tag is created or changed
451 generate_atag_email()
453 # Use git for-each-ref to pull out the individual fields from the
455 eval $(git for-each-ref --shell --format='
456 tagobject=%(*objectname)
457 tagtype=%(*objecttype)
459 tagged=%(taggerdate)' $refname
462 echo " tagging $tagobject ($tagtype)"
466 # If the tagged object is a commit, then we assume this is a
467 # release, and so we calculate which tag this tag is
469 prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null)
471 if [ -n "$prevtag" ]; then
472 echo " replaces $prevtag"
476 echo " length $(git cat-file -s $tagobject) bytes"
479 echo " tagged by $tagger"
485 # Show the content of the tag message; this might contain a change
486 # log or release notes so is worth displaying.
487 git cat-file tag $newrev | sed -e '1,/^$/d'
492 # Only commit tags make sense to have rev-list operations
494 if [ -n "$prevtag" ]; then
495 # Show changes since the previous release
496 git rev-list --pretty=short "$prevtag..$newrev" | git shortlog
498 # No previous tag, show all the changes since time
500 git rev-list --pretty=short $newrev | git shortlog
504 # XXX: Is there anything useful we can do for non-commit
513 # Called for the deletion of an annotated tag
515 generate_delete_atag_email()
520 git show -s --pretty=oneline $oldrev
524 # --------------- General references
527 # Called when any other type of reference is created (most likely a
530 generate_create_general_email()
532 echo " at $newrev ($newrev_type)"
534 generate_general_email
538 # Called when any other type of reference is updated (most likely a
541 generate_update_general_email()
543 echo " to $newrev ($newrev_type)"
546 generate_general_email
550 # Called for creation or update of any other type of reference
552 generate_general_email()
554 # Unannotated tags are more about marking a point than releasing a
555 # version; therefore we don't do the shortlog summary that we do for
556 # annotated tags above - we simply show that the point has been
557 # marked, and print the log message for the marked point for
560 # Note this section also catches any other reference type (although
561 # there aren't any) and deals with them in the same way.
564 if [ "$newrev_type" = "commit" ]; then
566 git show --no-color --root -s $newrev
569 # What can we do here? The tag marks an object that is not
570 # a commit, so there is no log for us to display. It's
571 # probably not wise to output git cat-file as it could be a
572 # binary blob. We'll just say how big it is
573 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
578 # Called for the deletion of any other type of reference
580 generate_delete_general_email()
585 git show -s --pretty=oneline $oldrev
591 COMMITTER=$(git-for-each-ref --format='%(committer)' --sort=-committerdate count=1 refs/heads)
592 COMMITTERNAME=$(cut -d'<' -f1 <<< $COMMITTER)
593 COMMITTERMAIL=$(cut -d'<' -f2 <<< $COMMITTER |cut -d'>' -f1)
594 /usr/sbin/sendmail -t -f "$COMMITTERMAIL" -F "$COMMITTERNAME"
597 # ---------------------------- main()
600 LOGBEGIN="-----------------------------------------------------------------------"
601 LOGEND="-----------------------------------------------------------------------"
604 # Set GIT_DIR either from the working directory, or from the environment
606 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
607 if [ -z "$GIT_DIR" ]; then
608 echo >&2 "fatal: post-receive: GIT_DIR not set"
612 if [ -f "$GIT_DIR/description" ]; then
613 projectdesc=$(sed -ne '1p' "$GIT_DIR/description")
615 projectdesc=$(git-config gitweb.description)
617 # Check if the description is unchanged from it's default, and shorten it to
618 # a more manageable length if it is
619 if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null
621 projectdesc="UNNAMED PROJECT"
624 recipients=$(git config hooks.mailinglist)
625 announcerecipients=$(git config hooks.announcelist)
626 envelopesender=$(git config hooks.envelopesender)
627 emailprefix=$(git config hooks.emailprefix || echo '[SCM] ')
630 # Allow dual mode: run from the command line just like the update hook, or
631 # if no arguments are given then run as a hook script
632 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
633 # Output to the terminal in command line mode - if someone wanted to
634 # resend an email; they could redirect the output to sendmail
636 PAGER= generate_email $2 $3 $1
638 while read oldrev newrev refname
640 generate_email $oldrev $newrev $refname | send_mail