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
17 # * Default subject prefix is site name.
18 # * Unsubscribe instructions in email footer.
21 # This hook is stored in the contrib/hooks directory. Your distribution
22 # will have put this somewhere standard. You should make this script
23 # executable then link to it in the repository you would like to use it in.
24 # For example, on debian the hook is stored in
25 # /usr/share/doc/git-core/contrib/hooks/post-receive-email:
27 # chmod a+x post-receive-email
28 # cd /path/to/your/repository.git
29 # ln -sf /usr/share/doc/git-core/contrib/hooks/post-receive-email hooks/post-receive
31 # This hook script assumes it is enabled on the central repository of a
32 # project, with all users pushing only to it and not between each other. It
33 # will still work if you don't operate in that style, but it would become
34 # possible for the email to be from someone other than the person doing the
40 # This is the list that all pushes will go to; leave it blank to not send
41 # emails for every ref update.
43 # This is the list that all pushes of annotated tags will go to. Leave it
44 # blank to default to the mailinglist field. The announce emails lists
45 # the short log summary of the changes since the last annotated tag.
46 # hooks.envelopesender
47 # If set then the -f option is passed to sendmail to allow the envelope
48 # sender address to be set
50 # All emails have their subjects prefixed with this prefix, or "[SCM]"
51 # if emailprefix is unset, to aid filtering
53 # The shell command used to format each revision in the email, with
54 # "%s" replaced with the commit id. Defaults to "git rev-list -1
55 # --pretty %s", displaying the commit id, author, date and log
56 # message. To list full patches separated by a blank line, you
57 # could set this to "git show -C %s; echo".
58 # To list a gitweb/cgit URL *and* a full patch for each change set, use this:
59 # "t=%s; printf 'http://.../?id=%%s' \$t; echo;echo; git show -C \$t; echo"
60 # Be careful if "..." contains things that will be expanded by shell "eval"
65 # All emails include the headers "X-Git-Refname", "X-Git-Oldrev",
66 # "X-Git-Newrev", and "X-Git-Reftype" to enable fine tuned filtering and
67 # give information for debugging.
70 # ---------------------------- Functions
73 # Top level email generation function. This decides what type of update
74 # this is and calls the appropriate body-generation routine after outputting
77 # Note this function doesn't actually generate any email output, that is
78 # taken care of by the functions it calls:
79 # - generate_email_header
80 # - generate_create_XXXX_email
81 # - generate_update_XXXX_email
82 # - generate_delete_XXXX_email
83 # - generate_email_footer
88 oldrev
=$
(git rev-parse
$1)
89 newrev
=$
(git rev-parse
$2)
96 if expr "$oldrev" : '0*$' >/dev
/null
100 if expr "$newrev" : '0*$' >/dev
/null
108 # --- Get the revision types
109 newrev_type
=$
(git cat-file
-t $newrev 2> /dev
/null
)
110 oldrev_type
=$
(git cat-file
-t "$oldrev" 2> /dev
/null
)
111 case "$change_type" in
114 rev_type
="$newrev_type"
118 rev_type
="$oldrev_type"
122 # The revision type tells us what type the commit is, combined with
123 # the location of the ref we can decide between
128 case "$refname","$rev_type" in
132 short_refname
=${refname##refs/tags/}
136 refname_type
="annotated tag"
137 short_refname
=${refname##refs/tags/}
139 if [ -n "$announcerecipients" ]; then
140 recipients
="$announcerecipients"
145 refname_type
="branch"
146 short_refname
=${refname##refs/heads/}
148 refs
/remotes
/*,commit
)
150 refname_type
="tracking branch"
151 short_refname
=${refname##refs/remotes/}
152 echo >&2 "*** Push-update of tracking branch, $refname"
153 echo >&2 "*** - no email generated."
157 # Anything else (is there anything else?)
158 echo >&2 "*** Unknown type of update to $refname ($rev_type)"
159 echo >&2 "*** - no email generated"
164 # Check if we've got anyone to send to
165 if [ -z "$recipients" ]; then
166 case "$refname_type" in
168 config_name
="hooks.announcelist"
171 config_name
="hooks.mailinglist"
174 echo >&2 "*** $config_name is not set so no email will be sent"
175 echo >&2 "*** for $refname update $oldrev->$newrev"
180 # The email subject will contain the best description of the ref
181 # that we can build from the parameters
182 describe
=$
(git describe
$rev 2>/dev
/null
)
183 if [ -z "$describe" ]; then
187 generate_email_header
189 # Call the correct body generation function
191 case "$refname_type" in
192 "tracking branch"|branch
)
199 generate_
${change_type}_
${fn_name}_email
201 generate_email_footer
204 generate_email_header
()
206 # --- Email (all stdout will be the email)
210 Subject: ${emailprefix}$projectname $refname_type, $short_refname, ${change_type}d. $describe
211 X-Git-Refname: $refname
212 X-Git-Reftype: $refname_type
213 X-Git-Oldrev: $oldrev
214 X-Git-Newrev: $newrev
216 This is an automated email from the git hooks/post-receive script. It was
217 generated because a ref change was pushed to the repository containing
218 the project $projectname.
220 The $refname_type, $short_refname has been ${change_type}d
224 generate_email_footer
()
230 $cfg_name automatic notification. Contact project admin $projectowner if you want
231 to unsubscribe, or site admin $cfg_admin if you receive no reply.
237 # --------------- Branches
240 # Called for the creation of a branch
242 generate_create_branch_email
()
244 # This is a new branch and so oldrev is not valid
245 echo " at $newrev ($newrev_type)"
254 # Called for the change of a pre-existing branch
256 generate_update_branch_email
()
259 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
261 # O is $oldrev for $refname
262 # N is $newrev for $refname
263 # X is a revision pointed to by some other ref, for which we may
264 # assume that an email has already been generated.
265 # In this case we want to issue an email containing only revisions
266 # 3, 4, and N. Given (almost) by
268 # git rev-list N ^O --not --all
270 # The reason for the "almost", is that the "--not --all" will take
271 # precedence over the "N", and effectively will translate to
273 # git rev-list N ^O ^X ^N
275 # So, we need to build up the list more carefully. git rev-parse
276 # will generate a list of revs that may be fed into git rev-list.
277 # We can get it to make the "--not --all" part and then filter out
280 # git rev-parse --not --all | grep -v N
282 # Then, using the --stdin switch to git rev-list we have effectively
285 # git rev-list N ^O ^X
287 # This leaves a problem when someone else updates the repository
288 # while this script is running. Their new value of the ref we're
289 # working on would be included in the "--not --all" output; and as
290 # our $newrev would be an ancestor of that commit, it would exclude
291 # all of our commits. What we really want is to exclude the current
292 # value of $refname from the --not list, rather than N itself. So:
294 # git rev-parse --not --all | grep -v $(git rev-parse $refname)
296 # Get's us to something pretty safe (apart from the small time
297 # between refname being read, and git rev-parse running - for that,
301 # Next problem, consider this:
302 # * --- B --- * --- O ($oldrev)
304 # * --- X --- * --- N ($newrev)
306 # That is to say, there is no guarantee that oldrev is a strict
307 # subset of newrev (it would have required a --force, but that's
308 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
309 # Instead we find the common base of the two revs and list from
312 # As above, we need to take into account the presence of X; if
313 # another branch is already in the repository and points at some of
314 # the revisions that we are about to output - we don't want them.
315 # The solution is as before: git rev-parse output filtered.
317 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
319 # Tags pushed into the repository generate nice shortlog emails that
320 # summarise the commits between them and the previous tag. However,
321 # those emails don't include the full commit messages that we output
322 # for a branch update. Therefore we still want to output revisions
323 # that have been output on a tag email.
325 # Luckily, git rev-parse includes just the tool. Instead of using
326 # "--all" we use "--branches"; this has the added benefit that
327 # "remotes/" will be ignored as well.
329 # List all of the revisions that were removed by this update, in a
330 # fast forward update, this list will be empty, because rev-list O
331 # ^N is empty. For a non fast forward, O ^N is the list of removed
335 for rev in $
(git rev-list
$newrev..
$oldrev)
337 revtype
=$
(git cat-file
-t "$rev")
338 echo " discards $rev ($revtype)"
340 if [ -z "$rev" ]; then
344 # List all the revisions from baserev to newrev in a kind of
345 # "table-of-contents"; note this list can include revisions that
346 # have already had notification emails and is present to show the
347 # full detail of the change from rolling back the old revision to
348 # the base revision and then forward to the new revision
349 for rev in $
(git rev-list
$oldrev..
$newrev)
351 revtype
=$
(git cat-file
-t "$rev")
352 echo " via $rev ($revtype)"
355 if [ "$fast_forward" ]; then
356 echo " from $oldrev ($oldrev_type)"
358 # 1. Existing revisions were removed. In this case newrev
359 # is a subset of oldrev - this is the reverse of a
360 # fast-forward, a rewind
361 # 2. New revisions were added on top of an old revision,
362 # this is a rewind and addition.
364 # (1) certainly happened, (2) possibly. When (2) hasn't
365 # happened, we set a flag to indicate that no log printout
370 # Find the common ancestor of the old and new revisions and
371 # compare it with newrev
372 baserev
=$
(git merge-base
$oldrev $newrev)
374 if [ "$baserev" = "$newrev" ]; then
375 echo "This update discarded existing revisions and left the branch pointing at"
376 echo "a previous point in the repository history."
378 echo " * -- * -- N ($newrev)"
380 echo " O -- O -- O ($oldrev)"
382 echo "The removed revisions are not necessarilly gone - if another reference"
383 echo "still refers to them they will stay in the repository."
386 echo "This update added new revisions after undoing existing revisions. That is"
387 echo "to say, the old revision is not a strict subset of the new revision. This"
388 echo "situation occurs when you --force push a change and generate a repository"
389 echo "containing something like this:"
391 echo " * -- * -- B -- O -- O -- O ($oldrev)"
393 echo " N -- N -- N ($newrev)"
395 echo "When this happens we assume that you've already had alert emails for all"
396 echo "of the O revisions, and so we here report only the revisions in the N"
397 echo "branch from the common base, B."
402 if [ -z "$rewind_only" ]; then
403 echo "Those revisions listed above that are new to this repository have"
404 echo "not appeared on any other notification email; so we list those"
405 echo "revisions in full, below."
411 # XXX: Need a way of detecting whether git rev-list actually
412 # outputted anything, so that we can issue a "no new
413 # revisions added by this update" message
417 echo "No new revisions were added by this update."
420 # The diffstat is shown from the old revision to the new revision.
421 # This is to show the truth of what happened in this change.
422 # There's no point showing the stat from the base to the new
423 # revision because the base is effectively a random revision at this
424 # point - the user will be interested in what this revision changed
425 # - including the undoing of previous revisions in the case of
426 # non-fast forward updates.
428 echo "Summary of changes:"
429 git diff-tree
--stat --summary --find-copies-harder $oldrev..
$newrev
433 # Called for the deletion of a branch
435 generate_delete_branch_email
()
440 git show
-s --pretty=oneline
$oldrev
444 # --------------- Annotated tags
447 # Called for the creation of an annotated tag
449 generate_create_atag_email
()
451 echo " at $newrev ($newrev_type)"
457 # Called for the update of an annotated tag (this is probably a rare event
458 # and may not even be allowed)
460 generate_update_atag_email
()
462 echo " to $newrev ($newrev_type)"
463 echo " from $oldrev (which is now obsolete)"
469 # Called when an annotated tag is created or changed
471 generate_atag_email
()
473 # Use git for-each-ref to pull out the individual fields from the
475 eval $
(git for-each-ref
--shell --format='
476 tagobject=%(*objectname)
477 tagtype=%(*objecttype)
479 tagged=%(taggerdate)' $refname
482 echo " tagging $tagobject ($tagtype)"
486 # If the tagged object is a commit, then we assume this is a
487 # release, and so we calculate which tag this tag is
489 prevtag
=$
(git describe
--abbrev=0 $newrev^
2>/dev
/null
)
491 if [ -n "$prevtag" ]; then
492 echo " replaces $prevtag"
496 echo " length $(git cat-file -s $tagobject) bytes"
499 echo " tagged by $tagger"
505 # Show the content of the tag message; this might contain a change
506 # log or release notes so is worth displaying.
507 git cat-file tag
$newrev |
sed -e '1,/^$/d'
512 # Only commit tags make sense to have rev-list operations
514 if [ -n "$prevtag" ]; then
515 # Show changes since the previous release
516 git rev-list
--pretty=short
"$prevtag..$newrev" | git shortlog
518 # No previous tag, show all the changes since time
520 git rev-list
--pretty=short
$newrev | git shortlog
524 # XXX: Is there anything useful we can do for non-commit
533 # Called for the deletion of an annotated tag
535 generate_delete_atag_email
()
540 git show
-s --pretty=oneline
$oldrev
544 # --------------- General references
547 # Called when any other type of reference is created (most likely a
550 generate_create_general_email
()
552 echo " at $newrev ($newrev_type)"
554 generate_general_email
558 # Called when any other type of reference is updated (most likely a
561 generate_update_general_email
()
563 echo " to $newrev ($newrev_type)"
566 generate_general_email
570 # Called for creation or update of any other type of reference
572 generate_general_email
()
574 # Unannotated tags are more about marking a point than releasing a
575 # version; therefore we don't do the shortlog summary that we do for
576 # annotated tags above - we simply show that the point has been
577 # marked, and print the log message for the marked point for
580 # Note this section also catches any other reference type (although
581 # there aren't any) and deals with them in the same way.
584 if [ "$newrev_type" = "commit" ]; then
586 git show
--no-color --root -s --pretty=medium
$newrev
589 # What can we do here? The tag marks an object that is not
590 # a commit, so there is no log for us to display. It's
591 # probably not wise to output git cat-file as it could be a
592 # binary blob. We'll just say how big it is
593 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
598 # Called for the deletion of any other type of reference
600 generate_delete_general_email
()
605 git show
-s --pretty=oneline
$oldrev
610 # --------------- Miscellaneous utilities
613 # Show new revisions as the user would like to see them in the email.
617 # This shows all log entries that are not already covered by
618 # another ref - i.e. commits that are now accessible from this
619 # ref that were previously not accessible
620 # (see generate_update_branch_email for the explanation of this
623 # Revision range passed to rev-list differs for new vs. updated
625 if [ "$change_type" = create
]
627 # Show all revisions exclusive to this (new) branch.
630 # Branch update; show revisions not part of $oldrev.
631 revspec
=$oldrev..
$newrev
634 other_branches
=$
(git for-each-ref
--format='%(refname)' refs
/heads
/ |
636 git rev-parse
--not $other_branches |
637 if [ -z "$custom_showrev" ]
639 git rev-list
--pretty --stdin $revspec
641 git rev-list
--stdin $revspec |
644 eval $
(printf "$custom_showrev" $onerev)
652 if [ -n "$envelopesender" ]; then
653 /usr
/sbin
/sendmail
-t -f "$envelopesender"
655 /usr
/sbin
/sendmail
-t
659 # ---------------------------- main()
662 LOGBEGIN
="- Log -----------------------------------------------------------------"
663 LOGEND
="-----------------------------------------------------------------------"
668 # Set GIT_DIR either from the working directory, or from the environment
670 GIT_DIR
=$
(git rev-parse
--git-dir 2>/dev
/null
)
671 if [ -z "$GIT_DIR" ]; then
672 echo >&2 "fatal: post-receive: GIT_DIR not set"
676 projectdesc
=$
(sed -ne '1p' "$GIT_DIR/description")
677 # Check if the description is unchanged from it's default, and shorten it to
678 # a more manageable length if it is
679 if expr "$projectdesc" : "Unnamed repository.*$" >/dev
/null
681 projectdesc
="UNNAMED PROJECT"
685 if [ -n "$projectname" ]; then
686 projectname
="$projectname.git"
687 projectboth
="$projectname (\"$projectdesc\")"
688 projectowner
="$(config_get owner)"
690 projectname
="$projectdesc"
691 projectboth
="$projectdesc"
694 recipients
=$
(git config hooks.mailinglist
)
695 announcerecipients
=$
(git config hooks.announcelist
)
696 envelopesender
=$
(git config hooks.envelopesender
)
697 emailprefix
=$
(git config hooks.emailprefix ||
echo "[$cfg_name] ")
698 custom_showrev
=$
(git config hooks.showrev
)
701 # Allow dual mode: run from the command line just like the update hook, or
702 # if no arguments are given then run as a hook script
703 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
704 # Output to the terminal in command line mode - if someone wanted to
705 # resend an email; they could redirect the output to sendmail
707 generate_email
$2 $3 $1 | send_mail
709 while read oldrev newrev refname
711 generate_email
$oldrev $newrev $refname | send_mail