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