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."
162 # Anything else (is there anything else?)
163 echo >&2 "*** Unknown type of update to $refname ($rev_type)"
164 echo >&2 "*** - no email generated"
169 # Check if we've got anyone to send to
170 if [ -z "$recipients" ]; then
171 case "$refname_type" in
173 config_name
="hooks.announcelist"
176 config_name
="hooks.mailinglist"
179 echo >&2 "*** $config_name is not set so no email will be sent"
180 echo >&2 "*** for $refname update $oldrev->$newrev"
186 # The email subject will contain the best description of the ref
187 # that we can build from the parameters
188 describe
=$
(git describe
$rev 2>/dev
/null
)
189 if [ -z "$describe" ]; then
193 generate_email_header
195 # Call the correct body generation function
197 case "$refname_type" in
198 "tracking branch"|branch
)
205 generate_
${change_type}_
${fn_name}_email
207 generate_email_footer
210 generate_email_header
()
212 # --- Email (all stdout will be the email)
214 if [ -n "$emailsender" ]; then
215 echo "From: $emailsender"
219 Subject: ${emailprefix}$projectname $refname_type $short_refname ${change_type}d: $describe
221 [ -z "$emailextraheader" ] ||
echo "$emailextraheader"
223 X-Git-Refname: $refname
224 X-Git-Reftype: $refname_type
225 X-Git-Oldrev: $oldrev
226 X-Git-Newrev: $newrev
228 This is an automated email from the git hooks/post-receive script. It was
229 generated because a ref change was pushed to the repository containing
230 the project $projectname.
232 The $refname_type, $short_refname has been ${change_type}d
236 generate_email_footer
()
242 $cfg_name automatic notification. Contact project admin $projectowner
243 if you want to unsubscribe, or site admin $cfg_admin if you receive
250 # --------------- Branches
253 # Called for the creation of a branch
255 generate_create_branch_email
()
257 # This is a new branch and so oldrev is not valid
258 echo " at $newrev ($newrev_type)"
267 # Called for the change of a pre-existing branch
269 generate_update_branch_email
()
272 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
274 # O is $oldrev for $refname
275 # N is $newrev for $refname
276 # X is a revision pointed to by some other ref, for which we may
277 # assume that an email has already been generated.
278 # In this case we want to issue an email containing only revisions
279 # 3, 4, and N. Given (almost) by
281 # git rev-list N ^O --not --all
283 # The reason for the "almost", is that the "--not --all" will take
284 # precedence over the "N", and effectively will translate to
286 # git rev-list N ^O ^X ^N
288 # So, we need to build up the list more carefully. git rev-parse
289 # will generate a list of revs that may be fed into git rev-list.
290 # We can get it to make the "--not --all" part and then filter out
293 # git rev-parse --not --all | grep -v N
295 # Then, using the --stdin switch to git rev-list we have effectively
298 # git rev-list N ^O ^X
300 # This leaves a problem when someone else updates the repository
301 # while this script is running. Their new value of the ref we're
302 # working on would be included in the "--not --all" output; and as
303 # our $newrev would be an ancestor of that commit, it would exclude
304 # all of our commits. What we really want is to exclude the current
305 # value of $refname from the --not list, rather than N itself. So:
307 # git rev-parse --not --all | grep -v $(git rev-parse $refname)
309 # Get's us to something pretty safe (apart from the small time
310 # between refname being read, and git rev-parse running - for that,
314 # Next problem, consider this:
315 # * --- B --- * --- O ($oldrev)
317 # * --- X --- * --- N ($newrev)
319 # That is to say, there is no guarantee that oldrev is a strict
320 # subset of newrev (it would have required a --force, but that's
321 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
322 # Instead we find the common base of the two revs and list from
325 # As above, we need to take into account the presence of X; if
326 # another branch is already in the repository and points at some of
327 # the revisions that we are about to output - we don't want them.
328 # The solution is as before: git rev-parse output filtered.
330 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
332 # Tags pushed into the repository generate nice shortlog emails that
333 # summarise the commits between them and the previous tag. However,
334 # those emails don't include the full commit messages that we output
335 # for a branch update. Therefore we still want to output revisions
336 # that have been output on a tag email.
338 # Luckily, git rev-parse includes just the tool. Instead of using
339 # "--all" we use "--branches"; this has the added benefit that
340 # "remotes/" will be ignored as well.
342 # List all of the revisions that were removed by this update, in a
343 # fast forward update, this list will be empty, because rev-list O
344 # ^N is empty. For a non fast forward, O ^N is the list of removed
348 for rev in $
(git rev-list
$newrev..
$oldrev)
350 revtype
=$
(git cat-file
-t "$rev")
351 echo " discards $rev ($revtype)"
353 if [ -z "$rev" ]; then
357 # List all the revisions from baserev to newrev in a kind of
358 # "table-of-contents"; note this list can include revisions that
359 # have already had notification emails and is present to show the
360 # full detail of the change from rolling back the old revision to
361 # the base revision and then forward to the new revision
362 for rev in $
(git rev-list
$oldrev..
$newrev)
364 revtype
=$
(git cat-file
-t "$rev")
365 echo " via $rev ($revtype)"
368 if [ "$fast_forward" ]; then
369 echo " from $oldrev ($oldrev_type)"
371 # 1. Existing revisions were removed. In this case newrev
372 # is a subset of oldrev - this is the reverse of a
373 # fast-forward, a rewind
374 # 2. New revisions were added on top of an old revision,
375 # this is a rewind and addition.
377 # (1) certainly happened, (2) possibly. When (2) hasn't
378 # happened, we set a flag to indicate that no log printout
383 # Find the common ancestor of the old and new revisions and
384 # compare it with newrev
385 baserev
=$
(git merge-base
$oldrev $newrev)
387 if [ "$baserev" = "$newrev" ]; then
388 echo "This update discarded existing revisions and left the branch pointing at"
389 echo "a previous point in the repository history."
391 echo " * -- * -- N ($newrev)"
393 echo " O -- O -- O ($oldrev)"
395 echo "The removed revisions are not necessarilly gone - if another reference"
396 echo "still refers to them they will stay in the repository."
399 echo "This update added new revisions after undoing existing revisions. That is"
400 echo "to say, the old revision is not a strict subset of the new revision. This"
401 echo "situation occurs when you --force push a change and generate a repository"
402 echo "containing something like this:"
404 echo " * -- * -- B -- O -- O -- O ($oldrev)"
406 echo " N -- N -- N ($newrev)"
408 echo "When this happens we assume that you've already had alert emails for all"
409 echo "of the O revisions, and so we here report only the revisions in the N"
410 echo "branch from the common base, B."
415 if [ -z "$rewind_only" ]; then
416 echo "Those revisions listed above that are new to this repository have"
417 echo "not appeared on any other notification email; so we list those"
418 echo "revisions in full, below."
424 # XXX: Need a way of detecting whether git rev-list actually
425 # outputted anything, so that we can issue a "no new
426 # revisions added by this update" message
430 echo "No new revisions were added by this update."
433 # The diffstat is shown from the old revision to the new revision.
434 # This is to show the truth of what happened in this change.
435 # There's no point showing the stat from the base to the new
436 # revision because the base is effectively a random revision at this
437 # point - the user will be interested in what this revision changed
438 # - including the undoing of previous revisions in the case of
439 # non-fast forward updates.
441 echo "Summary of changes:"
442 git diff-tree
--stat --summary --find-copies-harder $oldrev..
$newrev
446 # Called for the deletion of a branch
448 generate_delete_branch_email
()
453 git show
-s --pretty=oneline
$oldrev
457 # --------------- Annotated tags
460 # Called for the creation of an annotated tag
462 generate_create_atag_email
()
464 echo " at $newrev ($newrev_type)"
470 # Called for the update of an annotated tag (this is probably a rare event
471 # and may not even be allowed)
473 generate_update_atag_email
()
475 echo " to $newrev ($newrev_type)"
476 echo " from $oldrev (which is now obsolete)"
482 # Called when an annotated tag is created or changed
484 generate_atag_email
()
486 # Use git for-each-ref to pull out the individual fields from the
488 eval $
(git for-each-ref
--shell --format='
489 tagobject=%(*objectname)
490 tagtype=%(*objecttype)
492 tagged=%(taggerdate)' $refname
495 echo " tagging $tagobject ($tagtype)"
499 # If the tagged object is a commit, then we assume this is a
500 # release, and so we calculate which tag this tag is
502 prevtag
=$
(git describe
--abbrev=0 $newrev^
2>/dev
/null
)
504 if [ -n "$prevtag" ]; then
505 echo " replaces $prevtag"
509 echo " length $(git cat-file -s $tagobject) bytes"
512 echo " tagged by $tagger"
518 # Show the content of the tag message; this might contain a change
519 # log or release notes so is worth displaying.
520 git cat-file tag
$newrev |
sed -e '1,/^$/d'
525 # Only commit tags make sense to have rev-list operations
527 if [ -n "$prevtag" ]; then
528 # Show changes since the previous release
529 git rev-list
--pretty=short
"$prevtag..$newrev" | git shortlog
531 # No previous tag, show all the changes since time
533 git rev-list
--pretty=short
$newrev | git shortlog
537 # XXX: Is there anything useful we can do for non-commit
546 # Called for the deletion of an annotated tag
548 generate_delete_atag_email
()
553 git show
-s --pretty=oneline
$oldrev
557 # --------------- General references
560 # Called when any other type of reference is created (most likely a
563 generate_create_general_email
()
565 echo " at $newrev ($newrev_type)"
567 generate_general_email
571 # Called when any other type of reference is updated (most likely a
574 generate_update_general_email
()
576 echo " to $newrev ($newrev_type)"
579 generate_general_email
583 # Called for creation or update of any other type of reference
585 generate_general_email
()
587 # Unannotated tags are more about marking a point than releasing a
588 # version; therefore we don't do the shortlog summary that we do for
589 # annotated tags above - we simply show that the point has been
590 # marked, and print the log message for the marked point for
593 # Note this section also catches any other reference type (although
594 # there aren't any) and deals with them in the same way.
597 if [ "$newrev_type" = "commit" ]; then
599 git show
--no-color --root -s --pretty=medium
$newrev
602 # What can we do here? The tag marks an object that is not
603 # a commit, so there is no log for us to display. It's
604 # probably not wise to output git cat-file as it could be a
605 # binary blob. We'll just say how big it is
606 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
611 # Called for the deletion of any other type of reference
613 generate_delete_general_email
()
618 git show
-s --pretty=oneline
$oldrev
623 # --------------- Miscellaneous utilities
626 # Show new revisions as the user would like to see them in the email.
630 # This shows all log entries that are not already covered by
631 # another ref - i.e. commits that are now accessible from this
632 # ref that were previously not accessible
633 # (see generate_update_branch_email for the explanation of this
636 # Revision range passed to rev-list differs for new vs. updated
638 if [ "$change_type" = create
]
640 # Show all revisions exclusive to this (new) branch.
643 # Branch update; show revisions not part of $oldrev.
644 revspec
=$oldrev..
$newrev
647 other_branches
=$
(git for-each-ref
--format='%(refname)' refs
/heads
/ |
649 git rev-parse
--not $other_branches |
650 # if [ -z "$custom_showrev" ]
652 # git rev-list --pretty --stdin $revspec
654 git rev-list
--stdin $revspec |
657 if [ -n "$custom_showrev" ]; then
658 eval $
(printf "$custom_showrev" $onerev)
660 echo "$cfg_gitweburl/$projectname/commit/$onerev"
673 while IFS
= read line
; do
674 size
=$
((size
+${#line}))
675 if [ $size -gt $1 ]; then
676 echo "...e-mail trimmed, has been too large."
686 if ! IFS
= read header
; then
689 if [ -z "$header" ]; then
692 { echo "$header"; cat; } |
693 if [ -n "$envelopesender" ]; then
694 /usr
/sbin
/sendmail
-t -f "$envelopesender"
696 /usr
/sbin
/sendmail
-t
700 # ---------------------------- main()
703 LOGBEGIN
="- Log -----------------------------------------------------------------"
704 LOGEND
="-----------------------------------------------------------------------"
709 # Set GIT_DIR either from the working directory, or from the environment
711 GIT_DIR
=$
(git rev-parse
--git-dir 2>/dev
/null
)
712 if [ -z "$GIT_DIR" ]; then
713 echo >&2 "fatal: post-receive: GIT_DIR not set"
717 projectdesc
=$
(sed -ne '1p' "$GIT_DIR/description")
718 # Check if the description is unchanged from it's default, and shorten it to
719 # a more manageable length if it is
720 if expr "$projectdesc" : "Unnamed repository.*$" >/dev
/null
722 projectdesc
="UNNAMED PROJECT"
726 if [ -n "$projectname" ]; then
727 projectname
="$projectname.git"
728 projectboth
="$projectname (\"$projectdesc\")"
729 projectowner
="$(config_get owner)"
731 projectname
="$projectdesc"
732 projectboth
="$projectdesc"
736 emailextraheader
="$6"
738 recipients
=$
(git config hooks.mailinglist
)
739 announcerecipients
=$
(git config hooks.announcelist
)
740 envelopesender
=$
(git config hooks.envelopesender
)
741 emailprefix
=$
(git config hooks.emailprefix ||
echo "[$cfg_name] ")
742 custom_showrev
=$
(git config hooks.showrev
)
745 # Allow dual mode: run from the command line just like the update hook, or
746 # if no arguments are given then run as a hook script
747 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
748 # Output to the terminal in command line mode - if someone wanted to
749 # resend an email; they could redirect the output to sendmail
751 generate_email
$2 $3 $1 | size_limit $
((256*1024)) | send_mail
753 while read oldrev newrev refname
755 generate_email
$oldrev $newrev $refname | size_limit $
((256*1024)) | send_mail