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 # Anything else (is there anything else?)
162 echo >&2 "*** Unknown type of update to $refname ($rev_type)"
163 echo >&2 "*** - no email generated"
168 # Check if we've got anyone to send to
169 if [ -z "$recipients" ]; then
170 case "$refname_type" in
172 config_name
="hooks.announcelist"
175 config_name
="hooks.mailinglist"
178 echo >&2 "*** $config_name is not set so no email will be sent"
179 echo >&2 "*** for $refname update $oldrev->$newrev"
184 # The email subject will contain the best description of the ref
185 # that we can build from the parameters
186 describe
=$
(git describe
$rev 2>/dev
/null
)
187 if [ -z "$describe" ]; then
191 generate_email_header
193 # Call the correct body generation function
195 case "$refname_type" in
196 "tracking branch"|branch
)
203 generate_
${change_type}_
${fn_name}_email
205 generate_email_footer
208 generate_email_header
()
210 # --- Email (all stdout will be the email)
212 if [ -n "$emailsender" ]; then
213 echo "From: $emailsender"
217 Subject: ${emailprefix}$projectname $refname_type $short_refname ${change_type}d: $describe
218 X-Git-Refname: $refname
219 X-Git-Reftype: $refname_type
220 X-Git-Oldrev: $oldrev
221 X-Git-Newrev: $newrev
223 This is an automated email from the git hooks/post-receive script. It was
224 generated because a ref change was pushed to the repository containing
225 the project $projectname.
227 The $refname_type, $short_refname has been ${change_type}d
231 generate_email_footer
()
237 $cfg_name automatic notification. Contact project admin $projectowner
238 if you want to unsubscribe, or site admin $cfg_admin if you receive
245 # --------------- Branches
248 # Called for the creation of a branch
250 generate_create_branch_email
()
252 # This is a new branch and so oldrev is not valid
253 echo " at $newrev ($newrev_type)"
262 # Called for the change of a pre-existing branch
264 generate_update_branch_email
()
267 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
269 # O is $oldrev for $refname
270 # N is $newrev for $refname
271 # X is a revision pointed to by some other ref, for which we may
272 # assume that an email has already been generated.
273 # In this case we want to issue an email containing only revisions
274 # 3, 4, and N. Given (almost) by
276 # git rev-list N ^O --not --all
278 # The reason for the "almost", is that the "--not --all" will take
279 # precedence over the "N", and effectively will translate to
281 # git rev-list N ^O ^X ^N
283 # So, we need to build up the list more carefully. git rev-parse
284 # will generate a list of revs that may be fed into git rev-list.
285 # We can get it to make the "--not --all" part and then filter out
288 # git rev-parse --not --all | grep -v N
290 # Then, using the --stdin switch to git rev-list we have effectively
293 # git rev-list N ^O ^X
295 # This leaves a problem when someone else updates the repository
296 # while this script is running. Their new value of the ref we're
297 # working on would be included in the "--not --all" output; and as
298 # our $newrev would be an ancestor of that commit, it would exclude
299 # all of our commits. What we really want is to exclude the current
300 # value of $refname from the --not list, rather than N itself. So:
302 # git rev-parse --not --all | grep -v $(git rev-parse $refname)
304 # Get's us to something pretty safe (apart from the small time
305 # between refname being read, and git rev-parse running - for that,
309 # Next problem, consider this:
310 # * --- B --- * --- O ($oldrev)
312 # * --- X --- * --- N ($newrev)
314 # That is to say, there is no guarantee that oldrev is a strict
315 # subset of newrev (it would have required a --force, but that's
316 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
317 # Instead we find the common base of the two revs and list from
320 # As above, we need to take into account the presence of X; if
321 # another branch is already in the repository and points at some of
322 # the revisions that we are about to output - we don't want them.
323 # The solution is as before: git rev-parse output filtered.
325 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
327 # Tags pushed into the repository generate nice shortlog emails that
328 # summarise the commits between them and the previous tag. However,
329 # those emails don't include the full commit messages that we output
330 # for a branch update. Therefore we still want to output revisions
331 # that have been output on a tag email.
333 # Luckily, git rev-parse includes just the tool. Instead of using
334 # "--all" we use "--branches"; this has the added benefit that
335 # "remotes/" will be ignored as well.
337 # List all of the revisions that were removed by this update, in a
338 # fast forward update, this list will be empty, because rev-list O
339 # ^N is empty. For a non fast forward, O ^N is the list of removed
343 for rev in $
(git rev-list
$newrev..
$oldrev)
345 revtype
=$
(git cat-file
-t "$rev")
346 echo " discards $rev ($revtype)"
348 if [ -z "$rev" ]; then
352 # List all the revisions from baserev to newrev in a kind of
353 # "table-of-contents"; note this list can include revisions that
354 # have already had notification emails and is present to show the
355 # full detail of the change from rolling back the old revision to
356 # the base revision and then forward to the new revision
357 for rev in $
(git rev-list
$oldrev..
$newrev)
359 revtype
=$
(git cat-file
-t "$rev")
360 echo " via $rev ($revtype)"
363 if [ "$fast_forward" ]; then
364 echo " from $oldrev ($oldrev_type)"
366 # 1. Existing revisions were removed. In this case newrev
367 # is a subset of oldrev - this is the reverse of a
368 # fast-forward, a rewind
369 # 2. New revisions were added on top of an old revision,
370 # this is a rewind and addition.
372 # (1) certainly happened, (2) possibly. When (2) hasn't
373 # happened, we set a flag to indicate that no log printout
378 # Find the common ancestor of the old and new revisions and
379 # compare it with newrev
380 baserev
=$
(git merge-base
$oldrev $newrev)
382 if [ "$baserev" = "$newrev" ]; then
383 echo "This update discarded existing revisions and left the branch pointing at"
384 echo "a previous point in the repository history."
386 echo " * -- * -- N ($newrev)"
388 echo " O -- O -- O ($oldrev)"
390 echo "The removed revisions are not necessarilly gone - if another reference"
391 echo "still refers to them they will stay in the repository."
394 echo "This update added new revisions after undoing existing revisions. That is"
395 echo "to say, the old revision is not a strict subset of the new revision. This"
396 echo "situation occurs when you --force push a change and generate a repository"
397 echo "containing something like this:"
399 echo " * -- * -- B -- O -- O -- O ($oldrev)"
401 echo " N -- N -- N ($newrev)"
403 echo "When this happens we assume that you've already had alert emails for all"
404 echo "of the O revisions, and so we here report only the revisions in the N"
405 echo "branch from the common base, B."
410 if [ -z "$rewind_only" ]; then
411 echo "Those revisions listed above that are new to this repository have"
412 echo "not appeared on any other notification email; so we list those"
413 echo "revisions in full, below."
419 # XXX: Need a way of detecting whether git rev-list actually
420 # outputted anything, so that we can issue a "no new
421 # revisions added by this update" message
425 echo "No new revisions were added by this update."
428 # The diffstat is shown from the old revision to the new revision.
429 # This is to show the truth of what happened in this change.
430 # There's no point showing the stat from the base to the new
431 # revision because the base is effectively a random revision at this
432 # point - the user will be interested in what this revision changed
433 # - including the undoing of previous revisions in the case of
434 # non-fast forward updates.
436 echo "Summary of changes:"
437 git diff-tree
--stat --summary --find-copies-harder $oldrev..
$newrev
441 # Called for the deletion of a branch
443 generate_delete_branch_email
()
448 git show
-s --pretty=oneline
$oldrev
452 # --------------- Annotated tags
455 # Called for the creation of an annotated tag
457 generate_create_atag_email
()
459 echo " at $newrev ($newrev_type)"
465 # Called for the update of an annotated tag (this is probably a rare event
466 # and may not even be allowed)
468 generate_update_atag_email
()
470 echo " to $newrev ($newrev_type)"
471 echo " from $oldrev (which is now obsolete)"
477 # Called when an annotated tag is created or changed
479 generate_atag_email
()
481 # Use git for-each-ref to pull out the individual fields from the
483 eval $
(git for-each-ref
--shell --format='
484 tagobject=%(*objectname)
485 tagtype=%(*objecttype)
487 tagged=%(taggerdate)' $refname
490 echo " tagging $tagobject ($tagtype)"
494 # If the tagged object is a commit, then we assume this is a
495 # release, and so we calculate which tag this tag is
497 prevtag
=$
(git describe
--abbrev=0 $newrev^
2>/dev
/null
)
499 if [ -n "$prevtag" ]; then
500 echo " replaces $prevtag"
504 echo " length $(git cat-file -s $tagobject) bytes"
507 echo " tagged by $tagger"
513 # Show the content of the tag message; this might contain a change
514 # log or release notes so is worth displaying.
515 git cat-file tag
$newrev |
sed -e '1,/^$/d'
520 # Only commit tags make sense to have rev-list operations
522 if [ -n "$prevtag" ]; then
523 # Show changes since the previous release
524 git rev-list
--pretty=short
"$prevtag..$newrev" | git shortlog
526 # No previous tag, show all the changes since time
528 git rev-list
--pretty=short
$newrev | git shortlog
532 # XXX: Is there anything useful we can do for non-commit
541 # Called for the deletion of an annotated tag
543 generate_delete_atag_email
()
548 git show
-s --pretty=oneline
$oldrev
552 # --------------- General references
555 # Called when any other type of reference is created (most likely a
558 generate_create_general_email
()
560 echo " at $newrev ($newrev_type)"
562 generate_general_email
566 # Called when any other type of reference is updated (most likely a
569 generate_update_general_email
()
571 echo " to $newrev ($newrev_type)"
574 generate_general_email
578 # Called for creation or update of any other type of reference
580 generate_general_email
()
582 # Unannotated tags are more about marking a point than releasing a
583 # version; therefore we don't do the shortlog summary that we do for
584 # annotated tags above - we simply show that the point has been
585 # marked, and print the log message for the marked point for
588 # Note this section also catches any other reference type (although
589 # there aren't any) and deals with them in the same way.
592 if [ "$newrev_type" = "commit" ]; then
594 git show
--no-color --root -s --pretty=medium
$newrev
597 # What can we do here? The tag marks an object that is not
598 # a commit, so there is no log for us to display. It's
599 # probably not wise to output git cat-file as it could be a
600 # binary blob. We'll just say how big it is
601 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
606 # Called for the deletion of any other type of reference
608 generate_delete_general_email
()
613 git show
-s --pretty=oneline
$oldrev
618 # --------------- Miscellaneous utilities
621 # Show new revisions as the user would like to see them in the email.
625 # This shows all log entries that are not already covered by
626 # another ref - i.e. commits that are now accessible from this
627 # ref that were previously not accessible
628 # (see generate_update_branch_email for the explanation of this
631 # Revision range passed to rev-list differs for new vs. updated
633 if [ "$change_type" = create
]
635 # Show all revisions exclusive to this (new) branch.
638 # Branch update; show revisions not part of $oldrev.
639 revspec
=$oldrev..
$newrev
642 other_branches
=$
(git for-each-ref
--format='%(refname)' refs
/heads
/ |
644 git rev-parse
--not $other_branches |
645 # if [ -z "$custom_showrev" ]
647 # git rev-list --pretty --stdin $revspec
649 git rev-list
--stdin $revspec |
652 if [ -n "$custom_showrev" ]; then
653 eval $
(printf "$custom_showrev" $onerev)
655 echo "$cfg_gitweburl/$projectname/commit/$onerev"
668 while IFS
= read line
; do
669 size
=$
((size
+${#line}))
670 if [ $size -gt $1 ]; then
671 echo "...e-mail trimmed, has been too large."
681 if [ -n "$envelopesender" ]; then
682 /usr
/sbin
/sendmail
-t -f "$envelopesender"
684 /usr
/sbin
/sendmail
-t
688 # ---------------------------- main()
691 LOGBEGIN
="- Log -----------------------------------------------------------------"
692 LOGEND
="-----------------------------------------------------------------------"
697 # Set GIT_DIR either from the working directory, or from the environment
699 GIT_DIR
=$
(git rev-parse
--git-dir 2>/dev
/null
)
700 if [ -z "$GIT_DIR" ]; then
701 echo >&2 "fatal: post-receive: GIT_DIR not set"
705 projectdesc
=$
(sed -ne '1p' "$GIT_DIR/description")
706 # Check if the description is unchanged from it's default, and shorten it to
707 # a more manageable length if it is
708 if expr "$projectdesc" : "Unnamed repository.*$" >/dev
/null
710 projectdesc
="UNNAMED PROJECT"
714 if [ -n "$projectname" ]; then
715 projectname
="$projectname.git"
716 projectboth
="$projectname (\"$projectdesc\")"
717 projectowner
="$(config_get owner)"
719 projectname
="$projectdesc"
720 projectboth
="$projectdesc"
725 recipients
=$
(git config hooks.mailinglist
)
726 announcerecipients
=$
(git config hooks.announcelist
)
727 envelopesender
=$
(git config hooks.envelopesender
)
728 emailprefix
=$
(git config hooks.emailprefix ||
echo "[$cfg_name] ")
729 custom_showrev
=$
(git config hooks.showrev
)
732 # Allow dual mode: run from the command line just like the update hook, or
733 # if no arguments are given then run as a hook script
734 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
735 # Output to the terminal in command line mode - if someone wanted to
736 # resend an email; they could redirect the output to sendmail
738 generate_email
$2 $3 $1 | size_limit $
((256*1024)) | send_mail
740 while read oldrev newrev refname
742 generate_email
$oldrev $newrev $refname | size_limit $
((256*1024)) | send_mail