1 #!/bin/sh
2 #
3 # Copyright (c) 2007 Andy Parkins
4 #
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.
9 #
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:
15 #
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
19 #
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
24 # push.
25 #
26 # Config
27 # ------
28 # hooks.mailinglist
29 # This is the list that all pushes will go to; leave it blank to not send
30 # emails for every ref update.
31 # hooks.announcelist
32 # This is the list that all pushes of annotated tags will go to. Leave it
33 # blank to default to the mailinglist field. The announce emails lists
34 # the short log summary of the changes since the last annotated tag.
35 # hooks.envelopesender
36 # If set then the -f option is passed to sendmail to allow the envelope
37 # sender address to be set
38 # hooks.emailprefix
39 # All emails have their subjects prefixed with this prefix, or "[SCM]"
40 # if emailprefix is unset, to aid filtering
41 #
42 # Notes
43 # -----
44 # All emails include the headers "X-Git-Refname", "X-Git-Oldrev",
45 # "X-Git-Newrev", and "X-Git-Reftype" to enable fine tuned filtering and
46 # give information for debugging.
47 #
49 # ---------------------------- Functions
51 #
52 # Top level email generation function. This decides what type of update
53 # this is and calls the appropriate body-generation routine after outputting
54 # the common header
55 #
56 # Note this function doesn't actually generate any email output, that is
57 # taken care of by the functions it calls:
58 # - generate_email_header
59 # - generate_create_XXXX_email
60 # - generate_update_XXXX_email
61 # - generate_delete_XXXX_email
62 # - generate_email_footer
63 #
64 generate_email()
65 {
66 # --- Arguments
67 oldrev=$(git rev-parse $1)
68 newrev=$(git rev-parse $2)
69 refname="$3"
71 # --- Interpret
72 # 0000->1234 (create)
73 # 1234->2345 (update)
74 # 2345->0000 (delete)
75 if expr "$oldrev" : '0*$' >/dev/null
76 then
77 change_type="create"
78 else
79 if expr "$newrev" : '0*$' >/dev/null
80 then
81 change_type="delete"
82 else
83 change_type="update"
84 fi
85 fi
87 # --- Get the revision types
88 newrev_type=$(git cat-file -t $newrev 2> /dev/null)
89 oldrev_type=$(git cat-file -t "$oldrev" 2> /dev/null)
90 case "$change_type" in
91 create|update)
92 rev="$newrev"
93 rev_type="$newrev_type"
94 ;;
95 delete)
96 rev="$oldrev"
97 rev_type="$oldrev_type"
98 ;;
99 esac
101 # The revision type tells us what type the commit is, combined with
102 # the location of the ref we can decide between
103 # - working branch
104 # - tracking branch
105 # - unannoted tag
106 # - annotated tag
107 case "$refname","$rev_type" in
108 refs/tags/*,commit)
109 # un-annotated tag
110 refname_type="tag"
111 short_refname=${refname##refs/tags/}
112 ;;
113 refs/tags/*,tag)
114 # annotated tag
115 refname_type="annotated tag"
116 short_refname=${refname##refs/tags/}
117 # change recipients
118 if [ -n "$announcerecipients" ]; then
119 recipients="$announcerecipients"
120 fi
121 ;;
122 refs/heads/*,commit)
123 # branch
124 refname_type="branch"
125 short_refname=${refname##refs/heads/}
126 ;;
127 refs/remotes/*,commit)
128 # tracking branch
129 refname_type="tracking branch"
130 short_refname=${refname##refs/remotes/}
131 echo >&2 "*** Push-update of tracking branch, $refname"
132 echo >&2 "*** - no email generated."
133 exit 0
134 ;;
135 *)
136 # Anything else (is there anything else?)
137 echo >&2 "*** Unknown type of update to $refname ($rev_type)"
138 echo >&2 "*** - no email generated"
139 exit 1
140 ;;
141 esac
143 # Check if we've got anyone to send to
144 if [ -z "$recipients" ]; then
145 case "$refname_type" in
146 "annotated tag")
147 config_name="hooks.announcelist"
148 ;;
149 *)
150 config_name="hooks.mailinglist"
151 ;;
152 esac
153 echo >&2 "*** $config_name is not set so no email will be sent"
154 echo >&2 "*** for $refname update $oldrev->$newrev"
155 exit 0
156 fi
158 # Email parameters
159 # The committer will be obtained from the latest existing rev; so
160 # for a deletion it will be the oldrev, for the others, then newrev
161 committer=$(git show --pretty=full -s $rev | sed -ne "s/^Commit: //p" |
162 sed -ne 's/\(.*\) </"\1" </p')
163 # The email subject will contain the best description of the ref
164 # that we can build from the parameters
165 describe=$(git describe $rev 2>/dev/null)
166 if [ -z "$describe" ]; then
167 describe=$rev
168 fi
170 generate_email_header
172 # Call the correct body generation function
173 fn_name=general
174 case "$refname_type" in
175 "tracking branch"|branch)
176 fn_name=branch
177 ;;
178 "annotated tag")
179 fn_name=atag
180 ;;
181 esac
182 generate_${change_type}_${fn_name}_email
184 generate_email_footer
185 }
187 generate_email_header()
188 {
189 # --- Email (all stdout will be the email)
190 # Generate header
191 cat <<-EOF
192 To: $recipients
193 Subject: ${emailprefix}$projectdesc $refname_type, $short_refname, ${change_type}d. $describe
194 X-Git-Refname: $refname
195 X-Git-Reftype: $refname_type
196 X-Git-Oldrev: $oldrev
197 X-Git-Newrev: $newrev
199 This is an automated email from the git hooks/post-receive script. It was
200 generated because a ref change was pushed to the repository containing
201 the project "$projectdesc".
203 The $refname_type, $short_refname has been ${change_type}d
204 EOF
205 }
207 generate_email_footer()
208 {
209 cat <<-EOF
212 hooks/post-receive
213 --
214 $projectdesc
215 EOF
216 }
218 # --------------- Branches
220 #
221 # Called for the creation of a branch
222 #
223 generate_create_branch_email()
224 {
225 # This is a new branch and so oldrev is not valid
226 echo " at $newrev ($newrev_type)"
227 echo ""
229 echo $LOGBEGIN
230 # This shows all log entries that are not already covered by
231 # another ref - i.e. commits that are now accessible from this
232 # ref that were previously not accessible
233 # (see generate_update_branch_email for the explanation of this
234 # command)
235 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
236 git rev-list --pretty --stdin $newrev
237 echo $LOGEND
238 }
240 #
241 # Called for the change of a pre-existing branch
242 #
243 generate_update_branch_email()
244 {
245 # Consider this:
246 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
247 #
248 # O is $oldrev for $refname
249 # N is $newrev for $refname
250 # X is a revision pointed to by some other ref, for which we may
251 # assume that an email has already been generated.
252 # In this case we want to issue an email containing only revisions
253 # 3, 4, and N. Given (almost) by
254 #
255 # git-rev-list N ^O --not --all
256 #
257 # The reason for the "almost", is that the "--not --all" will take
258 # precedence over the "N", and effectively will translate to
259 #
260 # git-rev-list N ^O ^X ^N
261 #
262 # So, we need to build up the list more carefully. git-rev-parse
263 # will generate a list of revs that may be fed into git-rev-list.
264 # We can get it to make the "--not --all" part and then filter out
265 # the "^N" with:
266 #
267 # git-rev-parse --not --all | grep -v N
268 #
269 # Then, using the --stdin switch to git-rev-list we have effectively
270 # manufactured
271 #
272 # git-rev-list N ^O ^X
273 #
274 # This leaves a problem when someone else updates the repository
275 # while this script is running. Their new value of the ref we're
276 # working on would be included in the "--not --all" output; and as
277 # our $newrev would be an ancestor of that commit, it would exclude
278 # all of our commits. What we really want is to exclude the current
279 # value of $refname from the --not list, rather than N itself. So:
280 #
281 # git-rev-parse --not --all | grep -v $(git-rev-parse $refname)
282 #
283 # Get's us to something pretty safe (apart from the small time
284 # between refname being read, and git-rev-parse running - for that,
285 # I give up)
286 #
287 #
288 # Next problem, consider this:
289 # * --- B --- * --- O ($oldrev)
290 # \
291 # * --- X --- * --- N ($newrev)
292 #
293 # That is to say, there is no guarantee that oldrev is a strict
294 # subset of newrev (it would have required a --force, but that's
295 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
296 # Instead we find the common base of the two revs and list from
297 # there.
298 #
299 # As above, we need to take into account the presence of X; if
300 # another branch is already in the repository and points at some of
301 # the revisions that we are about to output - we don't want them.
302 # The solution is as before: git-rev-parse output filtered.
303 #
304 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
305 #
306 # Tags pushed into the repository generate nice shortlog emails that
307 # summarise the commits between them and the previous tag. However,
308 # those emails don't include the full commit messages that we output
309 # for a branch update. Therefore we still want to output revisions
310 # that have been output on a tag email.
311 #
312 # Luckily, git-rev-parse includes just the tool. Instead of using
313 # "--all" we use "--branches"; this has the added benefit that
314 # "remotes/" will be ignored as well.
316 # List all of the revisions that were removed by this update, in a
317 # fast forward update, this list will be empty, because rev-list O
318 # ^N is empty. For a non fast forward, O ^N is the list of removed
319 # revisions
320 fast_forward=""
321 rev=""
322 for rev in $(git rev-list $newrev..$oldrev)
323 do
324 revtype=$(git cat-file -t "$rev")
325 echo " discards $rev ($revtype)"
326 done
327 if [ -z "$rev" ]; then
328 fast_forward=1
329 fi
331 # List all the revisions from baserev to newrev in a kind of
332 # "table-of-contents"; note this list can include revisions that
333 # have already had notification emails and is present to show the
334 # full detail of the change from rolling back the old revision to
335 # the base revision and then forward to the new revision
336 for rev in $(git rev-list $oldrev..$newrev)
337 do
338 revtype=$(git cat-file -t "$rev")
339 echo " via $rev ($revtype)"
340 done
342 if [ "$fast_forward" ]; then
343 echo " from $oldrev ($oldrev_type)"
344 else
345 # 1. Existing revisions were removed. In this case newrev
346 # is a subset of oldrev - this is the reverse of a
347 # fast-forward, a rewind
348 # 2. New revisions were added on top of an old revision,
349 # this is a rewind and addition.
351 # (1) certainly happened, (2) possibly. When (2) hasn't
352 # happened, we set a flag to indicate that no log printout
353 # is required.
355 echo ""
357 # Find the common ancestor of the old and new revisions and
358 # compare it with newrev
359 baserev=$(git merge-base $oldrev $newrev)
360 rewind_only=""
361 if [ "$baserev" = "$newrev" ]; then
362 echo "This update discarded existing revisions and left the branch pointing at"
363 echo "a previous point in the repository history."
364 echo ""
365 echo " * -- * -- N ($newrev)"
366 echo " \\"
367 echo " O -- O -- O ($oldrev)"
368 echo ""
369 echo "The removed revisions are not necessarilly gone - if another reference"
370 echo "still refers to them they will stay in the repository."
371 rewind_only=1
372 else
373 echo "This update added new revisions after undoing existing revisions. That is"
374 echo "to say, the old revision is not a strict subset of the new revision. This"
375 echo "situation occurs when you --force push a change and generate a repository"
376 echo "containing something like this:"
377 echo ""
378 echo " * -- * -- B -- O -- O -- O ($oldrev)"
379 echo " \\"
380 echo " N -- N -- N ($newrev)"
381 echo ""
382 echo "When this happens we assume that you've already had alert emails for all"
383 echo "of the O revisions, and so we here report only the revisions in the N"
384 echo "branch from the common base, B."
385 fi
386 fi
388 echo ""
389 if [ -z "$rewind_only" ]; then
390 echo "Those revisions listed above that are new to this repository have"
391 echo "not appeared on any other notification email; so we list those"
392 echo "revisions in full, below."
394 echo ""
395 echo $LOGBEGIN
396 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
397 git rev-list --pretty --stdin $oldrev..$newrev
399 # XXX: Need a way of detecting whether git rev-list actually
400 # outputted anything, so that we can issue a "no new
401 # revisions added by this update" message
403 echo $LOGEND
404 else
405 echo "No new revisions were added by this update."
406 fi
408 # The diffstat is shown from the old revision to the new revision.
409 # This is to show the truth of what happened in this change.
410 # There's no point showing the stat from the base to the new
411 # revision because the base is effectively a random revision at this
412 # point - the user will be interested in what this revision changed
413 # - including the undoing of previous revisions in the case of
414 # non-fast forward updates.
415 echo ""
416 echo "Summary of changes:"
417 git diff-tree --stat --summary --find-copies-harder $oldrev..$newrev
418 }
420 #
421 # Called for the deletion of a branch
422 #
423 generate_delete_branch_email()
424 {
425 echo " was $oldrev"
426 echo ""
427 echo $LOGEND
428 git show -s --pretty=oneline $oldrev
429 echo $LOGEND
430 }
432 # --------------- Annotated tags
434 #
435 # Called for the creation of an annotated tag
436 #
437 generate_create_atag_email()
438 {
439 echo " at $newrev ($newrev_type)"
441 generate_atag_email
442 }
444 #
445 # Called for the update of an annotated tag (this is probably a rare event
446 # and may not even be allowed)
447 #
448 generate_update_atag_email()
449 {
450 echo " to $newrev ($newrev_type)"
451 echo " from $oldrev (which is now obsolete)"
453 generate_atag_email
454 }
456 #
457 # Called when an annotated tag is created or changed
458 #
459 generate_atag_email()
460 {
461 # Use git-for-each-ref to pull out the individual fields from the
462 # tag
463 eval $(git for-each-ref --shell --format='
464 tagobject=%(*objectname)
465 tagtype=%(*objecttype)
466 tagger=%(taggername)
467 tagged=%(taggerdate)' $refname
468 )
470 echo " tagging $tagobject ($tagtype)"
471 case "$tagtype" in
472 commit)
474 # If the tagged object is a commit, then we assume this is a
475 # release, and so we calculate which tag this tag is
476 # replacing
477 prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null)
479 if [ -n "$prevtag" ]; then
480 echo " replaces $prevtag"
481 fi
482 ;;
483 *)
484 echo " length $(git cat-file -s $tagobject) bytes"
485 ;;
486 esac
487 echo " tagged by $tagger"
488 echo " on $tagged"
490 echo ""
491 echo $LOGBEGIN
493 # Show the content of the tag message; this might contain a change
494 # log or release notes so is worth displaying.
495 git cat-file tag $newrev | sed -e '1,/^$/d'
497 echo ""
498 case "$tagtype" in
499 commit)
500 # Only commit tags make sense to have rev-list operations
501 # performed on them
502 if [ -n "$prevtag" ]; then
503 # Show changes since the previous release
504 git rev-list --pretty=short "$prevtag..$newrev" | git shortlog
505 else
506 # No previous tag, show all the changes since time
507 # began
508 git rev-list --pretty=short $newrev | git shortlog
509 fi
510 ;;
511 *)
512 # XXX: Is there anything useful we can do for non-commit
513 # objects?
514 ;;
515 esac
517 echo $LOGEND
518 }
520 #
521 # Called for the deletion of an annotated tag
522 #
523 generate_delete_atag_email()
524 {
525 echo " was $oldrev"
526 echo ""
527 echo $LOGEND
528 git show -s --pretty=oneline $oldrev
529 echo $LOGEND
530 }
532 # --------------- General references
534 #
535 # Called when any other type of reference is created (most likely a
536 # non-annotated tag)
537 #
538 generate_create_general_email()
539 {
540 echo " at $newrev ($newrev_type)"
542 generate_general_email
543 }
545 #
546 # Called when any other type of reference is updated (most likely a
547 # non-annotated tag)
548 #
549 generate_update_general_email()
550 {
551 echo " to $newrev ($newrev_type)"
552 echo " from $oldrev"
554 generate_general_email
555 }
557 #
558 # Called for creation or update of any other type of reference
559 #
560 generate_general_email()
561 {
562 # Unannotated tags are more about marking a point than releasing a
563 # version; therefore we don't do the shortlog summary that we do for
564 # annotated tags above - we simply show that the point has been
565 # marked, and print the log message for the marked point for
566 # reference purposes
567 #
568 # Note this section also catches any other reference type (although
569 # there aren't any) and deals with them in the same way.
571 echo ""
572 if [ "$newrev_type" = "commit" ]; then
573 echo $LOGBEGIN
574 git show --no-color --root -s $newrev
575 echo $LOGEND
576 else
577 # What can we do here? The tag marks an object that is not
578 # a commit, so there is no log for us to display. It's
579 # probably not wise to output git-cat-file as it could be a
580 # binary blob. We'll just say how big it is
581 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
582 fi
583 }
585 #
586 # Called for the deletion of any other type of reference
587 #
588 generate_delete_general_email()
589 {
590 echo " was $oldrev"
591 echo ""
592 echo $LOGEND
593 git show -s --pretty=oneline $oldrev
594 echo $LOGEND
595 }
597 send_mail()
598 {
599 if [ -n "$envelopesender" ]; then
600 /usr/sbin/sendmail -t -f "$envelopesender"
601 else
602 /usr/sbin/sendmail -t
603 fi
604 }
606 # ---------------------------- main()
608 # --- Constants
609 LOGBEGIN="- Log -----------------------------------------------------------------"
610 LOGEND="-----------------------------------------------------------------------"
612 # --- Config
613 # Set GIT_DIR either from the working directory, or from the environment
614 # variable.
615 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
616 if [ -z "$GIT_DIR" ]; then
617 echo >&2 "fatal: post-receive: GIT_DIR not set"
618 exit 1
619 fi
621 projectdesc=$(sed -ne '1p' "$GIT_DIR/description")
622 # Check if the description is unchanged from it's default, and shorten it to
623 # a more manageable length if it is
624 if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null
625 then
626 projectdesc="UNNAMED PROJECT"
627 fi
629 recipients=$(git repo-config hooks.mailinglist)
630 announcerecipients=$(git repo-config hooks.announcelist)
631 envelopesender=$(git-repo-config hooks.envelopesender)
632 emailprefix=$(git-repo-config hooks.emailprefix || echo '[SCM] ')
634 # --- Main loop
635 # Allow dual mode: run from the command line just like the update hook, or
636 # if no arguments are given then run as a hook script
637 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
638 # Output to the terminal in command line mode - if someone wanted to
639 # resend an email; they could redirect the output to sendmail
640 # themselves
641 PAGER= generate_email $2 $3 $1
642 else
643 while read oldrev newrev refname
644 do
645 generate_email $oldrev $newrev $refname | send_mail
646 done
647 fi