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_email_header()
180 # --- Email (all stdout will be the email)
181 # optimize output for branch, master
183 if [ "$refname_type" == branch -a "$short_refname" == master ] ; then
186 details="$refname_type, $short_refname,"
189 shortrev=$(echo $describe | cut -b1-8)
193 Subject: ${emailprefix}$projectdesc ${details}${change_type}d. ${shortrev}
194 X-Git-Refname: $refname
195 X-Git-Reftype: $refname_type
196 X-Git-Oldrev: $oldrev
197 X-Git-Newrev: $newrev
199 On $projectdesc, the $refname_type, $short_refname has been ${change_type}d
203 generate_email_footer()
214 # --------------- Branches
217 # Called for the creation of a branch
219 generate_create_branch_email()
221 # This is a new branch and so oldrev is not valid
222 echo " at $newrev ($newrev_type)"
226 # This shows all log entries that are not already covered by
227 # another ref - i.e. commits that are now accessible from this
228 # ref that were previously not accessible
229 # (see generate_update_branch_email for the explanation of this
231 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
232 git rev-list --pretty --stdin $newrev
237 # Called for the change of a pre-existing branch
239 generate_update_branch_email()
242 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
244 # O is $oldrev for $refname
245 # N is $newrev for $refname
246 # X is a revision pointed to by some other ref, for which we may
247 # assume that an email has already been generated.
248 # In this case we want to issue an email containing only revisions
249 # 3, 4, and N. Given (almost) by
251 # git rev-list N ^O --not --all
253 # The reason for the "almost", is that the "--not --all" will take
254 # precedence over the "N", and effectively will translate to
256 # git rev-list N ^O ^X ^N
258 # So, we need to build up the list more carefully. git rev-parse
259 # will generate a list of revs that may be fed into git rev-list.
260 # We can get it to make the "--not --all" part and then filter out
263 # git rev-parse --not --all | grep -v N
265 # Then, using the --stdin switch to git rev-list we have effectively
268 # git rev-list N ^O ^X
270 # This leaves a problem when someone else updates the repository
271 # while this script is running. Their new value of the ref we're
272 # working on would be included in the "--not --all" output; and as
273 # our $newrev would be an ancestor of that commit, it would exclude
274 # all of our commits. What we really want is to exclude the current
275 # value of $refname from the --not list, rather than N itself. So:
277 # git rev-parse --not --all | grep -v $(git rev-parse $refname)
279 # Get's us to something pretty safe (apart from the small time
280 # between refname being read, and git rev-parse running - for that,
284 # Next problem, consider this:
285 # * --- B --- * --- O ($oldrev)
287 # * --- X --- * --- N ($newrev)
289 # That is to say, there is no guarantee that oldrev is a strict
290 # subset of newrev (it would have required a --force, but that's
291 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
292 # Instead we find the common base of the two revs and list from
295 # As above, we need to take into account the presence of X; if
296 # another branch is already in the repository and points at some of
297 # the revisions that we are about to output - we don't want them.
298 # The solution is as before: git rev-parse output filtered.
300 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
302 # Tags pushed into the repository generate nice shortlog emails that
303 # summarise the commits between them and the previous tag. However,
304 # those emails don't include the full commit messages that we output
305 # for a branch update. Therefore we still want to output revisions
306 # that have been output on a tag email.
308 # Luckily, git rev-parse includes just the tool. Instead of using
309 # "--all" we use "--branches"; this has the added benefit that
310 # "remotes/" will be ignored as well.
312 # List all of the revisions that were removed by this update, in a
313 # fast forward update, this list will be empty, because rev-list O
314 # ^N is empty. For a non fast forward, O ^N is the list of removed
318 for rev in $(git rev-list $newrev..$oldrev)
320 revtype=$(git cat-file -t "$rev")
321 echo " discards $rev ($revtype)"
323 if [ -z "$rev" ]; then
327 # List all the revisions from baserev to newrev in a kind of
328 # "table-of-contents"; note this list can include revisions that
329 # have already had notification emails and is present to show the
330 # full detail of the change from rolling back the old revision to
331 # the base revision and then forward to the new revision
332 for rev in $(git rev-list $oldrev..$newrev)
334 revtype=$(git cat-file -t "$rev")
335 echo " via $rev ($revtype)"
338 if [ "$fast_forward" ]; then
339 echo " from $oldrev ($oldrev_type)"
341 # 1. Existing revisions were removed. In this case newrev
342 # is a subset of oldrev - this is the reverse of a
343 # fast-forward, a rewind
344 # 2. New revisions were added on top of an old revision,
345 # this is a rewind and addition.
346 # (1) certainly happened, (2) possibly. When (2) hasn't
347 # happened, we set a flag to indicate that no log printout
352 # Find the common ancestor of the old and new revisions and
353 # compare it with newrev
354 baserev=$(git merge-base $oldrev $newrev)
356 if [ "$baserev" = "$newrev" ]; then
357 echo "This update discarded existing revisions and left the branch pointing at"
358 echo "a previous point in the repository history."
360 echo " * -- * -- N ($newrev)"
362 echo " O -- O -- O ($oldrev)"
364 echo "The removed revisions are not necessarilly gone - if another reference"
365 echo "still refers to them they will stay in the repository."
368 echo "This update added new revisions after undoing existing revisions. That is"
369 echo "to say, the old revision is not a strict subset of the new revision. This"
370 echo "situation occurs when you --force push a change and generate a repository"
371 echo "containing something like this:"
373 echo " * -- * -- B -- O -- O -- O ($oldrev)"
375 echo " N -- N -- N ($newrev)"
377 echo "When this happens we assume that you've already had alert emails for all"
378 echo "of the O revisions, and so we here report only the revisions in the N"
379 echo "branch from the common base, B."
384 if [ -z "$rewind_only" ]; then
387 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
388 git rev-list --pretty --stdin $oldrev..$newrev
390 # XXX: Need a way of detecting whether git rev-list actually
391 # outputted anything, so that we can issue a "no new
392 # revisions added by this update" message
396 echo "No new revisions were added by this update."
399 # The diffstat is shown from the old revision to the new revision.
400 # This is to show the truth of what happened in this change.
401 # There's no point showing the stat from the base to the new
402 # revision because the base is effectively a random revision at this
403 # point - the user will be interested in what this revision changed
404 # - including the undoing of previous revisions in the case of
405 # non-fast forward updates.
407 echo "Summary of changes:"
408 git diff-tree --stat --summary --find-copies-harder $oldrev..$newrev
411 echo "Changes between commits $(cut -b1-8 <<< $oldrev)..$(cut -b1-8 <<< $newrev)"
412 git diff $oldrev..$newrev
416 # Called for the deletion of a branch
418 generate_delete_branch_email()
423 git show -s --pretty=oneline $oldrev
427 # --------------- Annotated tags
430 # Called for the creation of an annotated tag
432 generate_create_atag_email()
434 echo " at $newrev ($newrev_type)"
440 # Called for the update of an annotated tag (this is probably a rare event
441 # and may not even be allowed)
443 generate_update_atag_email()
445 echo " to $newrev ($newrev_type)"
446 echo " from $oldrev (which is now obsolete)"
452 # Called when an annotated tag is created or changed
454 generate_atag_email()
456 # Use git for-each-ref to pull out the individual fields from the tag
457 eval $(git for-each-ref --shell --format='
458 tagobject=%(*objectname)
459 tagtype=%(*objecttype)
461 tagged=%(taggerdate)' $refname
464 echo " tagging $tagobject ($tagtype)"
468 # If the tagged object is a commit, then we assume this is a
469 # release, and so we calculate which tag this tag is
471 prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null)
473 if [ -n "$prevtag" ]; then
474 echo " replaces $prevtag"
478 echo " length $(git cat-file -s $tagobject) bytes"
481 echo " tagged by $tagger"
487 # Show the content of the tag message; this might contain a change
488 # log or release notes so is worth displaying.
489 git cat-file tag $newrev | sed -e '1,/^$/d'
494 # Only commit tags make sense to have rev-list operations
496 if [ -n "$prevtag" ]; then
497 # Show changes since the previous release
498 git rev-list --pretty=short "$prevtag..$newrev" | git shortlog
500 # No previous tag, show all the changes since time began
501 git rev-list --pretty=short $newrev | git shortlog
505 # XXX: Is there anything useful we can do for non-commit objects?
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 if [ -n "$envelopesender" ] ; then
594 COMMITTERMAIL=$envelopesender
596 COMMITTERMAIL=$(cut -d'<' -f2 <<< $COMMITTER |cut -d'>' -f1)
598 /usr/sbin/sendmail -t -f "$COMMITTERMAIL" -F "$COMMITTERNAME"
601 # ---------------------------- main()
604 LOGBEGIN="-----------------------------------------------------------------------"
605 LOGEND="-----------------------------------------------------------------------"
608 # Set GIT_DIR either from the working directory, or from the environment
610 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
611 if [ -z "$GIT_DIR" ]; then
612 echo >&2 "fatal: post-receive: GIT_DIR not set"
616 if [ -f "$GIT_DIR/description" ]; then
617 projectdesc=$(sed -ne '1p' "$GIT_DIR/description")
619 projectdesc=$(git-config gitweb.description)
621 # Check if the description is unchanged from it's default, and shorten it to
622 # a more manageable length if it is
623 if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null
625 projectdesc="UNNAMED PROJECT"
628 recipients=$(git config hooks.mailinglist)
629 announcerecipients=$(git config hooks.announcelist)
630 envelopesender=$(git config hooks.envelopesender)
631 emailprefix=$(git config hooks.emailprefix || echo '[SCM] ')
634 # Allow dual mode: run from the command line just like the update hook, or
635 # if no arguments are given then run as a hook script
636 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
637 # Output to the terminal in command line mode - if someone wanted to
638 # resend an email; they could redirect the output to sendmail
640 PAGER= generate_email $2 $3 $1
642 while read oldrev newrev refname
644 generate_email $oldrev $newrev $refname | send_mail