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.
10 # This hook is stored in the contrib/hooks directory. Your distribution
11 # will have put this somewhere standard. You should make this script
12 # executable then link to it in the repository you would like to use it in.
13 # For example, on debian the hook is stored in
14 # /usr/share/doc/git-core/contrib/hooks/post-receive-email:
16 # chmod a+x post-receive-email
17 # cd /path/to/your/repository.git
18 # ln -sf /usr/share/doc/git-core/contrib/hooks/post-receive-email hooks/post-receive
20 # This hook script assumes it is enabled on the central repository of a
21 # project, with all users pushing only to it and not between each other. It
22 # will still work if you don't operate in that style, but it would become
23 # possible for the email to be from someone other than the person doing the
26 # To help with debugging and use on pre-v1.5.1 git servers, this script will
27 # also obey the interface of hooks/update, taking its arguments on the
28 # command line. Unfortunately, hooks/update is called once for each ref.
29 # To avoid firing one email per ref, this script just prints its output to
30 # the screen when used in this mode. The output can then be redirected if
36 # This is the list that all pushes will go to; leave it blank to not send
37 # emails for every ref update.
39 # This is the list that all pushes of annotated tags will go to. Leave it
40 # blank to default to the mailinglist field. The announce emails lists
41 # the short log summary of the changes since the last annotated tag.
42 # hooks.envelopesender
43 # If set then the -f option is passed to sendmail to allow the envelope
44 # sender address to be set
46 # All emails have their subjects prefixed with this prefix, or "[SCM]"
47 # if emailprefix is unset, to aid filtering
49 # The shell command used to format each revision in the email, with
50 # "%s" replaced with the commit id. Defaults to "git rev-list -1
51 # --pretty %s", displaying the commit id, author, date and log
52 # message. To list full patches separated by a blank line, you
53 # could set this to "git show -C %s; echo".
54 # To list a gitweb/cgit URL *and* a full patch for each change set, use this:
55 # "t=%s; printf 'http://.../?id=%%s' \$t; echo;echo; git show -C \$t; echo"
56 # Be careful if "..." contains things that will be expanded by shell "eval"
59 # The maximum number of lines that should be included in the generated
60 # email body. If not specified, there is no limit.
61 # Lines beyond the limit are suppressed and counted, and a final
62 # line is added indicating the number of suppressed lines.
66 # All emails include the headers "X-Git-Refname", "X-Git-Oldrev",
67 # "X-Git-Newrev", and "X-Git-Reftype" to enable fine tuned filtering and
68 # give information for debugging.
71 # ---------------------------- Functions
74 # Top level email generation function. This decides what type of update
75 # this is and calls the appropriate body-generation routine after outputting
78 # Note this function doesn't actually generate any email output, that is
79 # taken care of by the functions it calls:
80 # - generate_email_header
81 # - generate_create_XXXX_email
82 # - generate_update_XXXX_email
83 # - generate_delete_XXXX_email
84 # - generate_email_footer
89 oldrev
=$
(git rev-parse
$1)
90 newrev
=$
(git rev-parse
$2)
98 if expr "$oldrev" : '0*$' >/dev
/null
102 if expr "$newrev" : '0*$' >/dev
/null
110 # --- Get the revision types
111 newrev_type
=$
(git cat-file
-t $newrev 2> /dev
/null
)
112 oldrev_type
=$
(git cat-file
-t "$oldrev" 2> /dev
/null
)
113 case "$change_type" in
116 rev_type
="$newrev_type"
120 rev_type
="$oldrev_type"
124 # The revision type tells us what type the commit is, combined with
125 # the location of the ref we can decide between
130 case "$refname","$rev_type" in
134 short_refname
=${refname##refs/tags/}
138 refname_type
="annotated tag"
139 short_refname
=${refname##refs/tags/}
141 if [ -n "$announcerecipients" ]; then
142 recipients
="$announcerecipients"
147 refname_type
="branch"
148 short_refname
=${refname##refs/heads/}
150 refs
/remotes
/*,commit
)
152 refname_type
="tracking branch"
153 short_refname
=${refname##refs/remotes/}
154 echo >&2 "*** Push-update of tracking branch, $refname"
155 echo >&2 "*** - no email generated."
159 # Anything else (is there anything else?)
160 echo >&2 "*** Unknown type of update to $refname ($rev_type)"
161 echo >&2 "*** - no email generated"
166 # Check if we've got anyone to send to
167 if [ -z "$recipients" ]; then
168 case "$refname_type" in
170 config_name
="hooks.announcelist"
173 config_name
="hooks.mailinglist"
176 echo >&2 "*** $config_name is not set so no email will be sent"
177 echo >&2 "*** for $refname update $oldrev->$newrev"
182 # The email subject will contain the best description of the ref
183 # that we can build from the parameters
184 describe
=$
(git describe
$rev 2>/dev
/null
)
185 if [ -z "$describe" ]; then
189 generate_email_header
191 # Call the correct body generation function
193 case "$refname_type" in
194 "tracking branch"|branch
)
202 if [ -z "$maxlines" ]; then
203 generate_
${change_type}_
${fn_name}_email
205 generate_
${change_type}_
${fn_name}_email | limit_lines
$maxlines
208 generate_email_footer
211 generate_email_header
()
213 # --- Email (all stdout will be the email)
217 Subject: ${emailprefix}$projectdesc $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 "$projectdesc".
227 The $refname_type, $short_refname has been ${change_type}d
231 generate_email_footer
()
243 # --------------- Branches
246 # Called for the creation of a branch
248 generate_create_branch_email
()
250 # This is a new branch and so oldrev is not valid
251 echo " at $newrev ($newrev_type)"
260 # Called for the change of a pre-existing branch
262 generate_update_branch_email
()
265 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
267 # O is $oldrev for $refname
268 # N is $newrev for $refname
269 # X is a revision pointed to by some other ref, for which we may
270 # assume that an email has already been generated.
271 # In this case we want to issue an email containing only revisions
272 # 3, 4, and N. Given (almost) by
274 # git rev-list N ^O --not --all
276 # The reason for the "almost", is that the "--not --all" will take
277 # precedence over the "N", and effectively will translate to
279 # git rev-list N ^O ^X ^N
281 # So, we need to build up the list more carefully. git rev-parse
282 # will generate a list of revs that may be fed into git rev-list.
283 # We can get it to make the "--not --all" part and then filter out
286 # git rev-parse --not --all | grep -v N
288 # Then, using the --stdin switch to git rev-list we have effectively
291 # git rev-list N ^O ^X
293 # This leaves a problem when someone else updates the repository
294 # while this script is running. Their new value of the ref we're
295 # working on would be included in the "--not --all" output; and as
296 # our $newrev would be an ancestor of that commit, it would exclude
297 # all of our commits. What we really want is to exclude the current
298 # value of $refname from the --not list, rather than N itself. So:
300 # git rev-parse --not --all | grep -v $(git rev-parse $refname)
302 # Get's us to something pretty safe (apart from the small time
303 # between refname being read, and git rev-parse running - for that,
307 # Next problem, consider this:
308 # * --- B --- * --- O ($oldrev)
310 # * --- X --- * --- N ($newrev)
312 # That is to say, there is no guarantee that oldrev is a strict
313 # subset of newrev (it would have required a --force, but that's
314 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
315 # Instead we find the common base of the two revs and list from
318 # As above, we need to take into account the presence of X; if
319 # another branch is already in the repository and points at some of
320 # the revisions that we are about to output - we don't want them.
321 # The solution is as before: git rev-parse output filtered.
323 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
325 # Tags pushed into the repository generate nice shortlog emails that
326 # summarise the commits between them and the previous tag. However,
327 # those emails don't include the full commit messages that we output
328 # for a branch update. Therefore we still want to output revisions
329 # that have been output on a tag email.
331 # Luckily, git rev-parse includes just the tool. Instead of using
332 # "--all" we use "--branches"; this has the added benefit that
333 # "remotes/" will be ignored as well.
335 # List all of the revisions that were removed by this update, in a
336 # fast-forward update, this list will be empty, because rev-list O
337 # ^N is empty. For a non-fast-forward, O ^N is the list of removed
341 for rev in $
(git rev-list
$newrev..
$oldrev)
343 revtype
=$
(git cat-file
-t "$rev")
344 echo " discards $rev ($revtype)"
346 if [ -z "$rev" ]; then
350 # List all the revisions from baserev to newrev in a kind of
351 # "table-of-contents"; note this list can include revisions that
352 # have already had notification emails and is present to show the
353 # full detail of the change from rolling back the old revision to
354 # the base revision and then forward to the new revision
355 for rev in $
(git rev-list
$oldrev..
$newrev)
357 revtype
=$
(git cat-file
-t "$rev")
358 echo " via $rev ($revtype)"
361 if [ "$fast_forward" ]; then
362 echo " from $oldrev ($oldrev_type)"
364 # 1. Existing revisions were removed. In this case newrev
365 # is a subset of oldrev - this is the reverse of a
366 # fast-forward, a rewind
367 # 2. New revisions were added on top of an old revision,
368 # this is a rewind and addition.
370 # (1) certainly happened, (2) possibly. When (2) hasn't
371 # happened, we set a flag to indicate that no log printout
376 # Find the common ancestor of the old and new revisions and
377 # compare it with newrev
378 baserev
=$
(git merge-base
$oldrev $newrev)
380 if [ "$baserev" = "$newrev" ]; then
381 echo "This update discarded existing revisions and left the branch pointing at"
382 echo "a previous point in the repository history."
384 echo " * -- * -- N ($newrev)"
386 echo " O -- O -- O ($oldrev)"
388 echo "The removed revisions are not necessarilly gone - if another reference"
389 echo "still refers to them they will stay in the repository."
392 echo "This update added new revisions after undoing existing revisions. That is"
393 echo "to say, the old revision is not a strict subset of the new revision. This"
394 echo "situation occurs when you --force push a change and generate a repository"
395 echo "containing something like this:"
397 echo " * -- * -- B -- O -- O -- O ($oldrev)"
399 echo " N -- N -- N ($newrev)"
401 echo "When this happens we assume that you've already had alert emails for all"
402 echo "of the O revisions, and so we here report only the revisions in the N"
403 echo "branch from the common base, B."
408 if [ -z "$rewind_only" ]; then
409 echo "Those revisions listed above that are new to this repository have"
410 echo "not appeared on any other notification email; so we list those"
411 echo "revisions in full, below."
417 # XXX: Need a way of detecting whether git rev-list actually
418 # outputted anything, so that we can issue a "no new
419 # revisions added by this update" message
423 echo "No new revisions were added by this update."
426 # The diffstat is shown from the old revision to the new revision.
427 # This is to show the truth of what happened in this change.
428 # There's no point showing the stat from the base to the new
429 # revision because the base is effectively a random revision at this
430 # point - the user will be interested in what this revision changed
431 # - including the undoing of previous revisions in the case of
432 # non-fast-forward updates.
434 echo "Summary of changes:"
435 git diff-tree
--stat --summary --find-copies-harder $oldrev..
$newrev
439 # Called for the deletion of a branch
441 generate_delete_branch_email
()
446 git show
-s --pretty=oneline
$oldrev
450 # --------------- Annotated tags
453 # Called for the creation of an annotated tag
455 generate_create_atag_email
()
457 echo " at $newrev ($newrev_type)"
463 # Called for the update of an annotated tag (this is probably a rare event
464 # and may not even be allowed)
466 generate_update_atag_email
()
468 echo " to $newrev ($newrev_type)"
469 echo " from $oldrev (which is now obsolete)"
475 # Called when an annotated tag is created or changed
477 generate_atag_email
()
479 # Use git for-each-ref to pull out the individual fields from the
481 eval $
(git for-each-ref
--shell --format='
482 tagobject=%(*objectname)
483 tagtype=%(*objecttype)
485 tagged=%(taggerdate)' $refname
488 echo " tagging $tagobject ($tagtype)"
492 # If the tagged object is a commit, then we assume this is a
493 # release, and so we calculate which tag this tag is
495 prevtag
=$
(git describe
--abbrev=0 $newrev^
2>/dev
/null
)
497 if [ -n "$prevtag" ]; then
498 echo " replaces $prevtag"
502 echo " length $(git cat-file -s $tagobject) bytes"
505 echo " tagged by $tagger"
511 # Show the content of the tag message; this might contain a change
512 # log or release notes so is worth displaying.
513 git cat-file tag
$newrev |
sed -e '1,/^$/d'
518 # Only commit tags make sense to have rev-list operations
520 if [ -n "$prevtag" ]; then
521 # Show changes since the previous release
522 git rev-list
--pretty=short
"$prevtag..$newrev" | git shortlog
524 # No previous tag, show all the changes since time
526 git rev-list
--pretty=short
$newrev | git shortlog
530 # XXX: Is there anything useful we can do for non-commit
539 # Called for the deletion of an annotated tag
541 generate_delete_atag_email
()
546 git show
-s --pretty=oneline
$oldrev
550 # --------------- General references
553 # Called when any other type of reference is created (most likely a
556 generate_create_general_email
()
558 echo " at $newrev ($newrev_type)"
560 generate_general_email
564 # Called when any other type of reference is updated (most likely a
567 generate_update_general_email
()
569 echo " to $newrev ($newrev_type)"
572 generate_general_email
576 # Called for creation or update of any other type of reference
578 generate_general_email
()
580 # Unannotated tags are more about marking a point than releasing a
581 # version; therefore we don't do the shortlog summary that we do for
582 # annotated tags above - we simply show that the point has been
583 # marked, and print the log message for the marked point for
586 # Note this section also catches any other reference type (although
587 # there aren't any) and deals with them in the same way.
590 if [ "$newrev_type" = "commit" ]; then
592 git show
--no-color --root -s --pretty=medium
$newrev
595 # What can we do here? The tag marks an object that is not
596 # a commit, so there is no log for us to display. It's
597 # probably not wise to output git cat-file as it could be a
598 # binary blob. We'll just say how big it is
599 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
604 # Called for the deletion of any other type of reference
606 generate_delete_general_email
()
611 git show
-s --pretty=oneline
$oldrev
616 # --------------- Miscellaneous utilities
619 # Show new revisions as the user would like to see them in the email.
623 # This shows all log entries that are not already covered by
624 # another ref - i.e. commits that are now accessible from this
625 # ref that were previously not accessible
626 # (see generate_update_branch_email for the explanation of this
629 # Revision range passed to rev-list differs for new vs. updated
631 if [ "$change_type" = create
]
633 # Show all revisions exclusive to this (new) branch.
636 # Branch update; show revisions not part of $oldrev.
637 revspec
=$oldrev..
$newrev
640 other_branches
=$
(git for-each-ref
--format='%(refname)' refs
/heads
/ |
642 git rev-parse
--not $other_branches |
643 if [ -z "$custom_showrev" ]
645 git rev-list
--pretty --stdin $revspec
647 git rev-list
--stdin $revspec |
650 eval $
(printf "$custom_showrev" $onerev)
660 while IFS
="" read -r line
; do
662 if [ $lines -gt $1 ]; then
663 skipped
=$
((skipped
+ 1))
665 printf "%s\n" "$line"
668 if [ $skipped -ne 0 ]; then
669 echo "... $skipped lines suppressed ..."
676 if [ -n "$envelopesender" ]; then
677 /usr
/sbin
/sendmail
-t -f "$envelopesender"
679 /usr
/sbin
/sendmail
-t
683 # ---------------------------- main()
686 LOGBEGIN
="- Log -----------------------------------------------------------------"
687 LOGEND
="-----------------------------------------------------------------------"
690 # Set GIT_DIR either from the working directory, or from the environment
692 GIT_DIR
=$
(git rev-parse
--git-dir 2>/dev
/null
)
693 if [ -z "$GIT_DIR" ]; then
694 echo >&2 "fatal: post-receive: GIT_DIR not set"
698 projectdesc
=$
(sed -ne '1p' "$GIT_DIR/description")
699 # Check if the description is unchanged from it's default, and shorten it to
700 # a more manageable length if it is
701 if expr "$projectdesc" : "Unnamed repository.*$" >/dev
/null
703 projectdesc
="UNNAMED PROJECT"
706 recipients
=$
(git config hooks.mailinglist
)
707 announcerecipients
=$
(git config hooks.announcelist
)
708 envelopesender
=$
(git config hooks.envelopesender
)
709 emailprefix
=$
(git config hooks.emailprefix ||
echo '[SCM] ')
710 custom_showrev
=$
(git config hooks.showrev
)
711 maxlines
=$
(git config hooks.emailmaxlines
)
714 # Allow dual mode: run from the command line just like the update hook, or
715 # if no arguments are given then run as a hook script
716 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
717 # Output to the terminal in command line mode - if someone wanted to
718 # resend an email; they could redirect the output to sendmail
720 PAGER
= generate_email
$2 $3 $1
722 while read oldrev newrev refname
724 generate_email
$oldrev $newrev $refname $maxlines | send_mail