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.
11 # This is Girocco-customized version. No matter what is said below, it has
13 # * Calling with arguments is same as giving them on stdin.
14 # * Optional fourth parameter is project name, used at most places instead
16 # * Optional fifth parameter is email sender.
18 # * Default subject prefix is site name.
19 # * Unsubscribe instructions in email footer.
20 # * Default showrev includes gitweb link and show -C.
21 # * Nicer subject line.
22 # * Limit mail size to 256kb.
25 # This hook is stored in the contrib/hooks directory. Your distribution
26 # will have put this somewhere standard. You should make this script
27 # executable then link to it in the repository you would like to use it in.
28 # For example, on debian the hook is stored in
29 # /usr/share/doc/git-core/contrib/hooks/post-receive-email:
31 # chmod a+x post-receive-email
32 # cd /path/to/your/repository.git
33 # ln -sf /usr/share/doc/git-core/contrib/hooks/post-receive-email hooks/post-receive
35 # This hook script assumes it is enabled on the central repository of a
36 # project, with all users pushing only to it and not between each other. It
37 # will still work if you don't operate in that style, but it would become
38 # possible for the email to be from someone other than the person doing the
44 # This is the list that all pushes will go to; leave it blank to not send
45 # emails for every ref update.
47 # This is the list that all pushes of annotated tags will go to. Leave it
48 # blank to default to the mailinglist field. The announce emails lists
49 # the short log summary of the changes since the last annotated tag.
50 # hooks.envelopesender
51 # If set then the -f option is passed to sendmail to allow the envelope
52 # sender address to be set
54 # All emails have their subjects prefixed with this prefix, or "[SCM]"
55 # if emailprefix is unset, to aid filtering
57 # The shell command used to format each revision in the email, with
58 # "%s" replaced with the commit id. Defaults to "git rev-list -1
59 # --pretty %s", displaying the commit id, author, date and log
60 # message. To list full patches separated by a blank line, you
61 # could set this to "git show -C %s; echo".
62 # To list a gitweb/cgit URL *and* a full patch for each change set, use this:
63 # "t=%s; printf 'http://.../?id=%%s' \$t; echo;echo; git show -C \$t; echo"
64 # Be careful if "..." contains things that will be expanded by shell "eval"
69 # All emails include the headers "X-Git-Refname", "X-Git-Oldrev",
70 # "X-Git-Newrev", and "X-Git-Reftype" to enable fine tuned filtering and
71 # give information for debugging.
74 # ---------------------------- Functions
77 # Top level email generation function. This decides what type of update
78 # this is and calls the appropriate body-generation routine after outputting
81 # Note this function doesn't actually generate any email output, that is
82 # taken care of by the functions it calls:
83 # - generate_email_header
84 # - generate_create_XXXX_email
85 # - generate_update_XXXX_email
86 # - generate_delete_XXXX_email
87 # - generate_email_footer
92 oldrev
=$
(git rev-parse
$1)
93 newrev
=$
(git rev-parse
$2)
100 if expr "$oldrev" : '0*$' >/dev
/null
104 if expr "$newrev" : '0*$' >/dev
/null
112 # --- Get the revision types
113 newrev_type
=$
(git cat-file
-t $newrev 2> /dev
/null
)
114 oldrev_type
=$
(git cat-file
-t "$oldrev" 2> /dev
/null
)
115 case "$change_type" in
118 rev_type
="$newrev_type"
122 rev_type
="$oldrev_type"
126 # The revision type tells us what type the commit is, combined with
127 # the location of the ref we can decide between
132 case "$refname","$rev_type" in
136 short_refname
=${refname##refs/tags/}
140 refname_type
="annotated tag"
141 short_refname
=${refname##refs/tags/}
143 if [ -n "$announcerecipients" ]; then
144 recipients
="$announcerecipients"
149 refname_type
="branch"
150 short_refname
=${refname##refs/heads/}
152 refs
/remotes
/*,commit
)
154 refname_type
="tracking branch"
155 short_refname
=${refname##refs/remotes/}
156 echo >&2 "*** Push-update of tracking branch, $refname"
157 echo >&2 "*** - no email generated."
161 refs
/mob
/*,commit|refs
/mob
/*,tag
)
163 refname_type
="personal mob ref"
164 short_refname
=${refname##refs/mob/}
165 echo >&2 "*** Push-update of personal mob ref, $refname"
166 echo >&2 "*** - no email generated."
171 # Anything else (is there anything else?)
172 echo >&2 "*** Unknown type of update to $refname ($rev_type)"
173 echo >&2 "*** - no email generated"
178 # Check if we've got anyone to send to
179 if [ -z "$recipients" ]; then
180 case "$refname_type" in
182 config_name
="hooks.announcelist"
185 config_name
="hooks.mailinglist"
188 echo >&2 "*** $config_name is not set so no email will be sent"
189 echo >&2 "*** for $refname update $oldrev->$newrev"
195 # The email subject will contain the best description of the ref
196 # that we can build from the parameters
197 describe
=$
(git describe
$rev 2>/dev
/null
)
198 if [ -z "$describe" ]; then
202 generate_email_header
204 # Call the correct body generation function
206 case "$refname_type" in
207 "tracking branch"|branch
)
214 generate_
${change_type}_
${fn_name}_email
216 generate_email_footer
219 generate_email_header
()
221 # --- Email (all stdout will be the email)
223 if [ -n "$emailsender" ]; then
224 echo "From: $emailsender"
228 Subject: ${emailprefix}$projectname $refname_type $short_refname ${change_type}d: $describe
230 [ -z "$emailextraheader" ] ||
echo "$emailextraheader"
232 X-Git-Refname: $refname
233 X-Git-Reftype: $refname_type
234 X-Git-Oldrev: $oldrev
235 X-Git-Newrev: $newrev
237 This is an automated email from the git hooks/post-receive script. It was
238 generated because a ref change was pushed to the repository containing
239 the project $projectname.
241 The $refname_type, $short_refname has been ${change_type}d
245 generate_email_footer
()
251 $cfg_name automatic notification. Contact project admin $projectowner
252 if you want to unsubscribe, or site admin $cfg_admin if you receive
259 # --------------- Branches
262 # Called for the creation of a branch
264 generate_create_branch_email
()
266 # This is a new branch and so oldrev is not valid
267 echo " at $newrev ($newrev_type)"
276 # Called for the change of a pre-existing branch
278 generate_update_branch_email
()
281 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
283 # O is $oldrev for $refname
284 # N is $newrev for $refname
285 # X is a revision pointed to by some other ref, for which we may
286 # assume that an email has already been generated.
287 # In this case we want to issue an email containing only revisions
288 # 3, 4, and N. Given (almost) by
290 # git rev-list N ^O --not --all
292 # The reason for the "almost", is that the "--not --all" will take
293 # precedence over the "N", and effectively will translate to
295 # git rev-list N ^O ^X ^N
297 # So, we need to build up the list more carefully. git rev-parse
298 # will generate a list of revs that may be fed into git rev-list.
299 # We can get it to make the "--not --all" part and then filter out
302 # git rev-parse --not --all | grep -v N
304 # Then, using the --stdin switch to git rev-list we have effectively
307 # git rev-list N ^O ^X
309 # This leaves a problem when someone else updates the repository
310 # while this script is running. Their new value of the ref we're
311 # working on would be included in the "--not --all" output; and as
312 # our $newrev would be an ancestor of that commit, it would exclude
313 # all of our commits. What we really want is to exclude the current
314 # value of $refname from the --not list, rather than N itself. So:
316 # git rev-parse --not --all | grep -v $(git rev-parse $refname)
318 # Get's us to something pretty safe (apart from the small time
319 # between refname being read, and git rev-parse running - for that,
323 # Next problem, consider this:
324 # * --- B --- * --- O ($oldrev)
326 # * --- X --- * --- N ($newrev)
328 # That is to say, there is no guarantee that oldrev is a strict
329 # subset of newrev (it would have required a --force, but that's
330 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
331 # Instead we find the common base of the two revs and list from
334 # As above, we need to take into account the presence of X; if
335 # another branch is already in the repository and points at some of
336 # the revisions that we are about to output - we don't want them.
337 # The solution is as before: git rev-parse output filtered.
339 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
341 # Tags pushed into the repository generate nice shortlog emails that
342 # summarise the commits between them and the previous tag. However,
343 # those emails don't include the full commit messages that we output
344 # for a branch update. Therefore we still want to output revisions
345 # that have been output on a tag email.
347 # Luckily, git rev-parse includes just the tool. Instead of using
348 # "--all" we use "--branches"; this has the added benefit that
349 # "remotes/" will be ignored as well.
351 # List all of the revisions that were removed by this update, in a
352 # fast forward update, this list will be empty, because rev-list O
353 # ^N is empty. For a non fast forward, O ^N is the list of removed
357 for rev in $
(git rev-list
$newrev..
$oldrev)
359 revtype
=$
(git cat-file
-t "$rev")
360 echo " discards $rev ($revtype)"
362 if [ -z "$rev" ]; then
366 # List all the revisions from baserev to newrev in a kind of
367 # "table-of-contents"; note this list can include revisions that
368 # have already had notification emails and is present to show the
369 # full detail of the change from rolling back the old revision to
370 # the base revision and then forward to the new revision
371 for rev in $
(git rev-list
$oldrev..
$newrev)
373 revtype
=$
(git cat-file
-t "$rev")
374 echo " via $rev ($revtype)"
377 if [ "$fast_forward" ]; then
378 echo " from $oldrev ($oldrev_type)"
380 # 1. Existing revisions were removed. In this case newrev
381 # is a subset of oldrev - this is the reverse of a
382 # fast-forward, a rewind
383 # 2. New revisions were added on top of an old revision,
384 # this is a rewind and addition.
386 # (1) certainly happened, (2) possibly. When (2) hasn't
387 # happened, we set a flag to indicate that no log printout
392 # Find the common ancestor of the old and new revisions and
393 # compare it with newrev
394 baserev
=$
(git merge-base
$oldrev $newrev)
396 if [ "$baserev" = "$newrev" ]; then
397 echo "This update discarded existing revisions and left the branch pointing at"
398 echo "a previous point in the repository history."
400 echo " * -- * -- N ($newrev)"
402 echo " O -- O -- O ($oldrev)"
404 echo "The removed revisions are not necessarilly gone - if another reference"
405 echo "still refers to them they will stay in the repository."
408 echo "This update added new revisions after undoing existing revisions. That is"
409 echo "to say, the old revision is not a strict subset of the new revision. This"
410 echo "situation occurs when you --force push a change and generate a repository"
411 echo "containing something like this:"
413 echo " * -- * -- B -- O -- O -- O ($oldrev)"
415 echo " N -- N -- N ($newrev)"
417 echo "When this happens we assume that you've already had alert emails for all"
418 echo "of the O revisions, and so we here report only the revisions in the N"
419 echo "branch from the common base, B."
424 if [ -z "$rewind_only" ]; then
425 echo "Those revisions listed above that are new to this repository have"
426 echo "not appeared on any other notification email; so we list those"
427 echo "revisions in full, below."
433 # XXX: Need a way of detecting whether git rev-list actually
434 # outputted anything, so that we can issue a "no new
435 # revisions added by this update" message
439 echo "No new revisions were added by this update."
442 # The diffstat is shown from the old revision to the new revision.
443 # This is to show the truth of what happened in this change.
444 # There's no point showing the stat from the base to the new
445 # revision because the base is effectively a random revision at this
446 # point - the user will be interested in what this revision changed
447 # - including the undoing of previous revisions in the case of
448 # non-fast forward updates.
450 echo "Summary of changes:"
451 git diff-tree
--stat --summary --find-copies-harder $oldrev..
$newrev
455 # Called for the deletion of a branch
457 generate_delete_branch_email
()
462 git show
-s --pretty=oneline
$oldrev
466 # --------------- Annotated tags
469 # Called for the creation of an annotated tag
471 generate_create_atag_email
()
473 echo " at $newrev ($newrev_type)"
479 # Called for the update of an annotated tag (this is probably a rare event
480 # and may not even be allowed)
482 generate_update_atag_email
()
484 echo " to $newrev ($newrev_type)"
485 echo " from $oldrev (which is now obsolete)"
491 # Called when an annotated tag is created or changed
493 generate_atag_email
()
495 # Use git for-each-ref to pull out the individual fields from the
497 eval $
(git for-each-ref
--shell --format='
498 tagobject=%(*objectname)
499 tagtype=%(*objecttype)
501 tagged=%(taggerdate)' $refname
504 echo " tagging $tagobject ($tagtype)"
508 # If the tagged object is a commit, then we assume this is a
509 # release, and so we calculate which tag this tag is
511 prevtag
=$
(git describe
--abbrev=0 $newrev^
2>/dev
/null
)
513 if [ -n "$prevtag" ]; then
514 echo " replaces $prevtag"
518 echo " length $(git cat-file -s $tagobject) bytes"
521 echo " tagged by $tagger"
527 # Show the content of the tag message; this might contain a change
528 # log or release notes so is worth displaying.
529 git cat-file tag
$newrev |
sed -e '1,/^$/d'
534 # Only commit tags make sense to have rev-list operations
536 if [ -n "$prevtag" ]; then
537 # Show changes since the previous release
538 git rev-list
--pretty=short
"$prevtag..$newrev" | git shortlog
540 # No previous tag, show all the changes since time
542 git rev-list
--pretty=short
$newrev | git shortlog
546 # XXX: Is there anything useful we can do for non-commit
555 # Called for the deletion of an annotated tag
557 generate_delete_atag_email
()
562 git show
-s --pretty=oneline
$oldrev
566 # --------------- General references
569 # Called when any other type of reference is created (most likely a
572 generate_create_general_email
()
574 echo " at $newrev ($newrev_type)"
576 generate_general_email
580 # Called when any other type of reference is updated (most likely a
583 generate_update_general_email
()
585 echo " to $newrev ($newrev_type)"
588 generate_general_email
592 # Called for creation or update of any other type of reference
594 generate_general_email
()
596 # Unannotated tags are more about marking a point than releasing a
597 # version; therefore we don't do the shortlog summary that we do for
598 # annotated tags above - we simply show that the point has been
599 # marked, and print the log message for the marked point for
602 # Note this section also catches any other reference type (although
603 # there aren't any) and deals with them in the same way.
606 if [ "$newrev_type" = "commit" ]; then
608 git show
--no-color --root -s --pretty=medium
$newrev
611 # What can we do here? The tag marks an object that is not
612 # a commit, so there is no log for us to display. It's
613 # probably not wise to output git cat-file as it could be a
614 # binary blob. We'll just say how big it is
615 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
620 # Called for the deletion of any other type of reference
622 generate_delete_general_email
()
627 git show
-s --pretty=oneline
$oldrev
632 # --------------- Miscellaneous utilities
635 # Show new revisions as the user would like to see them in the email.
639 # This shows all log entries that are not already covered by
640 # another ref - i.e. commits that are now accessible from this
641 # ref that were previously not accessible
642 # (see generate_update_branch_email for the explanation of this
645 # Revision range passed to rev-list differs for new vs. updated
647 if [ "$change_type" = create
]
649 # Show all revisions exclusive to this (new) branch.
652 # Branch update; show revisions not part of $oldrev.
653 revspec
=$oldrev..
$newrev
656 other_branches
=$
(git for-each-ref
--format='%(refname)' refs
/heads
/ |
658 git rev-parse
--not $other_branches |
659 # if [ -z "$custom_showrev" ]
661 # git rev-list --pretty --stdin $revspec
663 git rev-list
--stdin $revspec |
666 if [ -n "$custom_showrev" ]; then
667 eval $
(printf "$custom_showrev" $onerev)
669 echo "$cfg_gitweburl/$projectname/commit/$onerev"
682 while IFS
= read line
; do
683 size
=$
((size
+${#line}))
684 if [ $size -gt $1 ]; then
685 echo "...e-mail trimmed, has been too large."
695 if ! IFS
= read header
; then
698 if [ -z "$header" ]; then
701 { echo "$header"; cat; } |
702 if [ -n "$envelopesender" ]; then
703 /usr
/sbin
/sendmail
-t -f "$envelopesender"
705 /usr
/sbin
/sendmail
-t
709 # ---------------------------- main()
712 LOGBEGIN
="- Log -----------------------------------------------------------------"
713 LOGEND
="-----------------------------------------------------------------------"
718 # Set GIT_DIR either from the working directory, or from the environment
720 GIT_DIR
=$
(git rev-parse
--git-dir 2>/dev
/null
)
721 if [ -z "$GIT_DIR" ]; then
722 echo >&2 "fatal: post-receive: GIT_DIR not set"
726 projectdesc
=$
(sed -ne '1p' "$GIT_DIR/description")
727 # Check if the description is unchanged from it's default, and shorten it to
728 # a more manageable length if it is
729 if expr "$projectdesc" : "Unnamed repository.*$" >/dev
/null
731 projectdesc
="UNNAMED PROJECT"
735 if [ -n "$projectname" ]; then
736 projectname
="$projectname.git"
737 projectboth
="$projectname (\"$projectdesc\")"
738 projectowner
="$(config_get owner)"
740 projectname
="$projectdesc"
741 projectboth
="$projectdesc"
745 emailextraheader
="$6"
747 recipients
=$
(git config hooks.mailinglist
)
748 announcerecipients
=$
(git config hooks.announcelist
)
749 envelopesender
=$
(git config hooks.envelopesender
)
750 emailprefix
=$
(git config hooks.emailprefix ||
echo "[$cfg_name] ")
751 custom_showrev
=$
(git config hooks.showrev
)
754 # Allow dual mode: run from the command line just like the update hook, or
755 # if no arguments are given then run as a hook script
756 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
757 # Output to the terminal in command line mode - if someone wanted to
758 # resend an email; they could redirect the output to sendmail
760 generate_email
$2 $3 $1 | size_limit $
((256*1024)) | send_mail
762 while read oldrev newrev refname
764 generate_email
$oldrev $newrev $refname | size_limit $
((256*1024)) | send_mail