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/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/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 # Function to prepare for email generation. This decides what type
78 # of update this is and whether an email should even be generated.
83 oldrev
=$
(git rev-parse
$1)
84 newrev
=$
(git rev-parse
$2)
91 if expr "$oldrev" : '0*$' >/dev
/null
95 if expr "$newrev" : '0*$' >/dev
/null
103 # --- Get the revision types
104 newrev_type
=$
(git cat-file
-t $newrev 2> /dev
/null
)
105 oldrev_type
=$
(git cat-file
-t "$oldrev" 2> /dev
/null
)
106 case "$change_type" in
109 rev_type
="$newrev_type"
113 rev_type
="$oldrev_type"
117 # The revision type tells us what type the commit is, combined with
118 # the location of the ref we can decide between
123 case "$refname","$rev_type" in
127 short_refname
=${refname##refs/tags/}
131 refname_type
="annotated tag"
132 short_refname
=${refname##refs/tags/}
134 if [ -n "$announcerecipients" ]; then
135 recipients
="$announcerecipients"
140 refname_type
="branch"
141 short_refname
=${refname##refs/heads/}
143 refs
/remotes
/*,commit
)
145 refname_type
="tracking branch"
146 short_refname
=${refname##refs/remotes/}
147 echo >&2 "*** Push-update of tracking branch, $refname"
148 echo >&2 "*** - no email generated."
152 refs
/mob
/*,commit|refs
/mob
/*,tag
)
154 refname_type
="personal mob ref"
155 short_refname
=${refname##refs/mob/}
156 echo >&2 "*** Push-update of personal mob ref, $refname"
157 echo >&2 "*** - no email generated."
162 # Anything else (is there anything else?)
163 echo >&2 "*** Unknown type of update to $refname ($rev_type)"
164 echo >&2 "*** - no email generated"
170 # Check if we've got anyone to send to
171 if [ -z "$recipients" ]; then
172 case "$refname_type" in
174 config_name
="hooks.announcelist"
177 config_name
="hooks.mailinglist"
180 echo >&2 "*** $config_name is not set so no email will be sent"
181 echo >&2 "*** for $refname update $oldrev->$newrev"
190 # Top level email generation function. This calls the appropriate
191 # body-generation routine after outputting the common header.
193 # Note this function doesn't actually generate any email output, that is
194 # taken care of by the functions it calls:
195 # - generate_email_header
196 # - generate_create_XXXX_email
197 # - generate_update_XXXX_email
198 # - generate_delete_XXXX_email
199 # - generate_email_footer
201 # Note also that this function cannot 'exit' from the script; when this
202 # function is running (in hook script mode), the send_mail() function
203 # is already executing in another process, connected via a pipe, and
204 # if this function exits without, whatever has been generated to that
205 # point will be sent as an email... even if nothing has been generated.
210 # The email subject will contain the best description of the ref
211 # that we can build from the parameters
212 describe
=$
(git describe
$rev 2>/dev
/null
)
213 if [ -z "$describe" ]; then
217 generate_email_header
219 # Call the correct body generation function
221 case "$refname_type" in
222 "tracking branch"|branch
)
229 generate_
${change_type}_
${fn_name}_email
231 generate_email_footer
234 generate_email_header
()
236 # --- Email (all stdout will be the email)
238 if [ -n "$emailsender" ]; then
239 echo "From: $emailsender"
243 Subject: ${emailprefix}$projectname $refname_type $short_refname ${change_type}d: $describe
245 Content-Type: text/plain; charset=utf-8
246 Content-Transfer-Encoding: 8bit
248 [ -z "$emailextraheader" ] ||
echo "$emailextraheader"
250 X-Git-Refname: $refname
251 X-Git-Reftype: $refname_type
252 X-Git-Oldrev: $oldrev
253 X-Git-Newrev: $newrev
254 Auto-Submitted: auto-generated
256 This is an automated email from the git hooks/post-receive script. It was
257 generated because a ref change was pushed to the repository containing
258 the project $projectname.
260 The $refname_type, $short_refname has been ${change_type}d
264 generate_email_footer
()
270 $cfg_name automatic notification. Contact project admin $projectowner
271 if you want to unsubscribe, or site admin $cfg_admin if you receive
278 # --------------- Branches
281 # Called for the creation of a branch
283 generate_create_branch_email
()
285 # This is a new branch and so oldrev is not valid
286 echo " at $newrev ($newrev_type)"
295 # Called for the change of a pre-existing branch
297 generate_update_branch_email
()
300 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
302 # O is $oldrev for $refname
303 # N is $newrev for $refname
304 # X is a revision pointed to by some other ref, for which we may
305 # assume that an email has already been generated.
306 # In this case we want to issue an email containing only revisions
307 # 3, 4, and N. Given (almost) by
309 # git rev-list N ^O --not --all
311 # The reason for the "almost", is that the "--not --all" will take
312 # precedence over the "N", and effectively will translate to
314 # git rev-list N ^O ^X ^N
316 # So, we need to build up the list more carefully. git rev-parse
317 # will generate a list of revs that may be fed into git rev-list.
318 # We can get it to make the "--not --all" part and then filter out
321 # git rev-parse --not --all | grep -v N
323 # Then, using the --stdin switch to git rev-list we have effectively
326 # git rev-list N ^O ^X
328 # This leaves a problem when someone else updates the repository
329 # while this script is running. Their new value of the ref we're
330 # working on would be included in the "--not --all" output; and as
331 # our $newrev would be an ancestor of that commit, it would exclude
332 # all of our commits. What we really want is to exclude the current
333 # value of $refname from the --not list, rather than N itself. So:
335 # git rev-parse --not --all | grep -v $(git rev-parse $refname)
337 # Get's us to something pretty safe (apart from the small time
338 # between refname being read, and git rev-parse running - for that,
342 # Next problem, consider this:
343 # * --- B --- * --- O ($oldrev)
345 # * --- X --- * --- N ($newrev)
347 # That is to say, there is no guarantee that oldrev is a strict
348 # subset of newrev (it would have required a --force, but that's
349 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
350 # Instead we find the common base of the two revs and list from
353 # As above, we need to take into account the presence of X; if
354 # another branch is already in the repository and points at some of
355 # the revisions that we are about to output - we don't want them.
356 # The solution is as before: git rev-parse output filtered.
358 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
360 # Tags pushed into the repository generate nice shortlog emails that
361 # summarise the commits between them and the previous tag. However,
362 # those emails don't include the full commit messages that we output
363 # for a branch update. Therefore we still want to output revisions
364 # that have been output on a tag email.
366 # Luckily, git rev-parse includes just the tool. Instead of using
367 # "--all" we use "--branches"; this has the added benefit that
368 # "remotes/" will be ignored as well.
370 # List all of the revisions that were removed by this update, in a
371 # fast-forward update, this list will be empty, because rev-list O
372 # ^N is empty. For a non-fast-forward, O ^N is the list of removed
376 for rev in $
(git rev-list
$newrev..
$oldrev)
378 revtype
=$
(git cat-file
-t "$rev")
379 echo " discards $rev ($revtype)"
381 if [ -z "$rev" ]; then
385 # List all the revisions from baserev to newrev in a kind of
386 # "table-of-contents"; note this list can include revisions that
387 # have already had notification emails and is present to show the
388 # full detail of the change from rolling back the old revision to
389 # the base revision and then forward to the new revision
390 for rev in $
(git rev-list
$oldrev..
$newrev)
392 revtype
=$
(git cat-file
-t "$rev")
393 echo " via $rev ($revtype)"
396 if [ "$fast_forward" ]; then
397 echo " from $oldrev ($oldrev_type)"
399 # 1. Existing revisions were removed. In this case newrev
400 # is a subset of oldrev - this is the reverse of a
401 # fast-forward, a rewind
402 # 2. New revisions were added on top of an old revision,
403 # this is a rewind and addition.
405 # (1) certainly happened, (2) possibly. When (2) hasn't
406 # happened, we set a flag to indicate that no log printout
411 # Find the common ancestor of the old and new revisions and
412 # compare it with newrev
413 baserev
=$
(git merge-base
$oldrev $newrev)
415 if [ "$baserev" = "$newrev" ]; then
416 echo "This update discarded existing revisions and left the branch pointing at"
417 echo "a previous point in the repository history."
419 echo " * -- * -- N ($newrev)"
421 echo " O -- O -- O ($oldrev)"
423 echo "The removed revisions are not necessarily gone - if another reference"
424 echo "still refers to them they will stay in the repository."
427 echo "This update added new revisions after undoing existing revisions. That is"
428 echo "to say, the old revision is not a strict subset of the new revision. This"
429 echo "situation occurs when you --force push a change and generate a repository"
430 echo "containing something like this:"
432 echo " * -- * -- B -- O -- O -- O ($oldrev)"
434 echo " N -- N -- N ($newrev)"
436 echo "When this happens we assume that you've already had alert emails for all"
437 echo "of the O revisions, and so we here report only the revisions in the N"
438 echo "branch from the common base, B."
443 if [ -z "$rewind_only" ]; then
444 echo "Those revisions listed above that are new to this repository have"
445 echo "not appeared on any other notification email; so we list those"
446 echo "revisions in full, below."
452 # XXX: Need a way of detecting whether git rev-list actually
453 # outputted anything, so that we can issue a "no new
454 # revisions added by this update" message
458 echo "No new revisions were added by this update."
461 # The diffstat is shown from the old revision to the new revision.
462 # This is to show the truth of what happened in this change.
463 # There's no point showing the stat from the base to the new
464 # revision because the base is effectively a random revision at this
465 # point - the user will be interested in what this revision changed
466 # - including the undoing of previous revisions in the case of
467 # non-fast-forward updates.
469 echo "Summary of changes:"
470 git diff-tree
--no-color --stat --summary --find-copies-harder $oldrev..
$newrev
474 # Called for the deletion of a branch
476 generate_delete_branch_email
()
481 git diff-tree
--no-color -s --always --encoding=UTF-8
--pretty=oneline
$oldrev
485 # --------------- Annotated tags
488 # Called for the creation of an annotated tag
490 generate_create_atag_email
()
492 echo " at $newrev ($newrev_type)"
498 # Called for the update of an annotated tag (this is probably a rare event
499 # and may not even be allowed)
501 generate_update_atag_email
()
503 echo " to $newrev ($newrev_type)"
504 echo " from $oldrev (which is now obsolete)"
510 # Called when an annotated tag is created or changed
512 generate_atag_email
()
514 # Use git for-each-ref to pull out the individual fields from the
516 eval $
(git for-each-ref
--shell --format='
517 tagobject=%(*objectname)
518 tagtype=%(*objecttype)
520 tagged=%(taggerdate)' $refname
523 echo " tagging $tagobject ($tagtype)"
527 # If the tagged object is a commit, then we assume this is a
528 # release, and so we calculate which tag this tag is
530 prevtag
=$
(git describe
--abbrev=0 $newrev^
2>/dev
/null
)
532 if [ -n "$prevtag" ]; then
533 echo " replaces $prevtag"
537 echo " length $(git cat-file -s $tagobject) bytes"
540 echo " tagged by $tagger"
546 # Show the content of the tag message; this might contain a change
547 # log or release notes so is worth displaying.
548 git cat-file tag
$newrev |
sed -e '1,/^$/d'
553 # Only commit tags make sense to have rev-list operations
555 if [ -n "$prevtag" ]; then
556 # Show changes since the previous release
557 git shortlog
"$prevtag..$newrev"
559 # No previous tag, show all the changes since time
565 # XXX: Is there anything useful we can do for non-commit
574 # Called for the deletion of an annotated tag
576 generate_delete_atag_email
()
581 git diff-tree
--no-color -s --always --encoding=UTF-8
--pretty=oneline
$oldrev
585 # --------------- General references
588 # Called when any other type of reference is created (most likely a
591 generate_create_general_email
()
593 echo " at $newrev ($newrev_type)"
595 generate_general_email
599 # Called when any other type of reference is updated (most likely a
602 generate_update_general_email
()
604 echo " to $newrev ($newrev_type)"
607 generate_general_email
611 # Called for creation or update of any other type of reference
613 generate_general_email
()
615 # Unannotated tags are more about marking a point than releasing a
616 # version; therefore we don't do the shortlog summary that we do for
617 # annotated tags above - we simply show that the point has been
618 # marked, and print the log message for the marked point for
621 # Note this section also catches any other reference type (although
622 # there aren't any) and deals with them in the same way.
625 if [ "$newrev_type" = "commit" ]; then
627 git diff-tree
--no-color --root -s --always --encoding=UTF-8
--pretty=medium
$newrev
630 # What can we do here? The tag marks an object that is not
631 # a commit, so there is no log for us to display. It's
632 # probably not wise to output git cat-file as it could be a
633 # binary blob. We'll just say how big it is
634 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
639 # Called for the deletion of any other type of reference
641 generate_delete_general_email
()
646 git diff-tree
--no-color -s --always --encoding=UTF-8
--pretty=oneline
$oldrev
651 # --------------- Miscellaneous utilities
654 # Show new revisions as the user would like to see them in the email.
658 # This shows all log entries that are not already covered by
659 # another ref - i.e. commits that are now accessible from this
660 # ref that were previously not accessible
661 # (see generate_update_branch_email for the explanation of this
664 # Revision range passed to rev-list differs for new vs. updated
666 if [ "$change_type" = create
]
668 # Show all revisions exclusive to this (new) branch.
671 # Branch update; show revisions not part of $oldrev.
672 revspec
=$oldrev..
$newrev
675 other_branches
=$
(git for-each-ref
--format='%(refname)' refs
/heads
/ |
677 git rev-parse
--not $other_branches |
678 # if [ -z "$custom_showrev" ]
680 # git rev-list --pretty --stdin $revspec
682 git rev-list
--stdin $revspec |
685 if [ -n "$custom_showrev" ]; then
686 eval $
(printf "$custom_showrev" $onerev)
688 echo "$cfg_gitweburl/$projectname/commit/$onerev"
690 git diff-tree
--no-color -p --always --encoding=UTF-8
--pretty=medium
-C $onerev
701 while IFS
= read line
; do
702 size
=$
((size
+${#line}))
703 if [ $size -gt $1 ]; then
704 echo "...e-mail trimmed, has been too large."
714 if [ -n "$envelopesender" ]; then
715 /usr
/sbin
/sendmail
-i -t -f "$envelopesender"
717 /usr
/sbin
/sendmail
-i -t
721 # ---------------------------- main()
724 LOGBEGIN
="- Log -----------------------------------------------------------------"
725 LOGEND
="-----------------------------------------------------------------------"
730 # Set GIT_DIR either from the working directory, or from the environment
732 GIT_DIR
=$
(git rev-parse
--git-dir 2>/dev
/null
)
733 if [ -z "$GIT_DIR" ]; then
734 echo >&2 "fatal: post-receive: GIT_DIR not set"
738 projectdesc
=$
(sed -ne '1p' "$GIT_DIR/description")
739 # Check if the description is unchanged from it's default, and shorten it to
740 # a more manageable length if it is
741 if expr "$projectdesc" : "Unnamed repository.*$" >/dev
/null
743 projectdesc
="UNNAMED PROJECT"
747 if [ -n "$projectname" ]; then
748 projectname
="$projectname.git"
749 projectboth
="$projectname (\"$projectdesc\")"
750 projectowner
="$(config_get owner)"
752 projectname
="$projectdesc"
753 projectboth
="$projectdesc"
757 emailextraheader
="$6"
759 recipients
=$
(git config hooks.mailinglist
)
760 announcerecipients
=$
(git config hooks.announcelist
)
761 envelopesender
=$
(git config hooks.envelopesender
)
762 emailprefix
=$
(git config hooks.emailprefix ||
echo "[$cfg_name] ")
763 custom_showrev
=$
(git config hooks.showrev
)
766 # Allow dual mode: run from the command line just like the update hook, or
767 # if no arguments are given then run as a hook script
768 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
769 # Output to the terminal in command line mode - if someone wanted to
770 # resend an email; they could redirect the output to sendmail
772 if prep_for_email
$2 $3 $1; then
773 PAGER
= generate_email | size_limit $
((256*1024)) | send_mail
776 while read oldrev newrev refname
778 prep_for_email
$oldrev $newrev $refname ||
continue
779 PAGER
= generate_email | size_limit $
((256*1024)) | send_mail