scripts/post-receive-email-with-diffs

   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 #
  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 #
  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"
  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)     # un-annotated tag
 109             refname_type="tag"
 110             short_refname=${refname##refs/tags/}
 111             ;;
 112         refs/tags/*,tag)        # annotated tag
 113             refname_type="annotated tag"
 114             short_refname=${refname##refs/tags/}
 115             # change recipients
 116             if [ -n "$announcerecipients" ]; then
 117                 recipients="$announcerecipients"
 118             fi
 119             ;;
 120         refs/heads/*,commit)    # branch
 121             refname_type="branch"
 122             short_refname=${refname##refs/heads/}
 123             ;;
 124         refs/remotes/*,commit)  # tracking branch
 125             refname_type="tracking branch"
 126             short_refname=${refname##refs/remotes/}
 127             echo >&2 "*** Push-update of tracking branch, $refname"
 128             echo >&2 "***  - no email generated."
 129             exit 0
 130             ;;
 131         *)                      # Anything else (is there anything else?)
 132             echo >&2 "*** Unknown type of update to $refname ($rev_type)"
 133             echo >&2 "***  - no email generated"
 134             exit 1
 135             ;;
 136     esac
 137
 138     # Check if we've got anyone to send to
 139     if [ -z "$recipients" ]; then
 140         case "$refname_type" in
 141             "annotated tag")
 142                 config_name="hooks.announcelist"
 143                 ;;
 144             *)
 145                 config_name="hooks.mailinglist"
 146                 ;;
 147         esac
 148         echo >&2 "*** $config_name is not set so no email will be sent"
 149         echo >&2 "*** for $refname update $oldrev->$newrev"
 150         exit 0
 151     fi
 152
 153     # Email parameters
 154     # The email subject will contain the best description of the ref
 155     # that we can build from the parameters
 156     describe=$(git describe $rev 2>/dev/null)
 157     if [ -z "$describe" ]; then
 158         describe=$rev
 159     fi
 160
 161     generate_email_header
 162
 163     # Call the correct body generation function
 164     fn_name=general
 165     case "$refname_type" in
 166         "tracking branch"|branch)
 167             fn_name=branch
 168             ;;
 169         "annotated tag")
 170             fn_name=atag
 171             ;;
 172     esac
 173     generate_${change_type}_${fn_name}_email
 174
 175     generate_email_footer
 176 }
 177
 178 generate_email_header()
 179 {
 180     # --- Email (all stdout will be the email)
 181     # optimize output for branch, master
 182     local details
 183     if [ "$refname_type" == branch -a "$short_refname" == master ] ; then
 184         details=""
 185     else
 186         details="$refname_type, $short_refname,"
 187     fi
 188     local shortrev
 189     shortrev=$(echo $describe | cut -b1-8)
 190     # Generate header
 191     cat <<-EOF
 192         To: $recipients
 193         Subject: ${emailprefix}$projectdesc ${details}${change_type}d. ${shortrev}
 194         X-Git-Refname: $refname
 195         X-Git-Reftype: $refname_type
 196         X-Git-Oldrev: $oldrev
 197         X-Git-Newrev: $newrev
 198
 199 On $projectdesc, the $refname_type, $short_refname has been ${change_type}d
 200         EOF
 201 }
 202
 203 generate_email_footer()
 204 {
 205     cat <<-EOF
 206
 207
 208         hooks/post-receive
 209         --
 210         $projectdesc
 211         EOF
 212 }
 213
 214 # --------------- Branches
 215
 216 #
 217 # Called for the creation of a branch
 218 #
 219 generate_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
 228     # ref that were previously not accessible
 229     # (see generate_update_branch_email for the explanation of this
 230     # command)
 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 #
 239 generate_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     #
 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:
 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
 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:
 276     #
 277     #  git rev-parse --not --all | grep -v $(git rev-parse $refname)
 278     #
 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)
 282     #
 283     #
 284     # Next problem, consider this:
 285     #   * --- B --- * --- O ($oldrev)
 286     #          \
 287     #           * --- X --- * --- N ($newrev)
 288     #
 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.
 294     #
 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.
 299     #
 300     # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
 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     #
 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
 316     fast_forward=""
 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
 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
 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
 338     if [ "$fast_forward" ]; then
 339         echo "      from  $oldrev ($oldrev_type)"
 340     else
 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.
 346         # (1) certainly happened, (2) possibly.  When (2) hasn't
 347         # happened, we set a flag to indicate that no log printout
 348         # is required.
 349
 350         echo ""
 351
 352         # Find the common ancestor of the old and new revisions and
 353         # compare it with newrev
 354         baserev=$(git merge-base $oldrev $newrev)
 355         rewind_only=""
 356         if [ "$baserev" = "$newrev" ]; then
 357             echo "This update discarded existing revisions and left the branch pointing at"
 358             echo "a previous point in the repository history."
 359             echo ""
 360             echo " * -- * -- N ($newrev)"
 361             echo "            \\"
 362             echo "             O -- O -- O ($oldrev)"
 363             echo ""
 364             echo "The removed revisions are not necessarilly gone - if another reference"
 365             echo "still refers to them they will stay in the repository."
 366             rewind_only=1
 367         else
 368             echo "This update added new revisions after undoing existing revisions.  That is"
 369             echo "to say, the old revision is not a strict subset of the new revision.  This"
 370             echo "situation occurs when you --force push a change and generate a repository"
 371             echo "containing something like this:"
 372             echo ""
 373             echo " * -- * -- B -- O -- O -- O ($oldrev)"
 374             echo "            \\"
 375             echo "             N -- N -- N ($newrev)"
 376             echo ""
 377             echo "When this happens we assume that you've already had alert emails for all"
 378             echo "of the O revisions, and so we here report only the revisions in the N"
 379             echo "branch from the common base, B."
 380         fi
 381     fi
 382
 383     echo ""
 384     if [ -z "$rewind_only" ]; then
 385         echo ""
 386         echo $LOGBEGIN
 387         git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
 388         git rev-list --pretty --stdin $oldrev..$newrev
 389
 390         # XXX: Need a way of detecting whether git rev-list actually
 391         # outputted anything, so that we can issue a "no new
 392         # revisions added by this update" message
 393
 394         echo $LOGEND
 395     else
 396         echo "No new revisions were added by this update."
 397     fi
 398
 399     # The diffstat is shown from the old revision to the new revision.
 400     # This is to show the truth of what happened in this change.
 401     # There's no point showing the stat from the base to the new
 402     # revision because the base is effectively a random revision at this
 403     # point - the user will be interested in what this revision changed
 404     # - including the undoing of previous revisions in the case of
 405     # non-fast forward updates.
 406     echo ""
 407     echo "Summary of changes:"
 408     git diff-tree --stat --summary --find-copies-harder $oldrev..$newrev
 409     echo
 410     echo
 411     echo "Changes between commits $(cut -b1-8 <<< $oldrev)..$(cut -b1-8 <<< $newrev)"
 412     git diff $oldrev..$newrev
 413 }
 414
 415 #
 416 # Called for the deletion of a branch
 417 #
 418 generate_delete_branch_email()
 419 {
 420     echo "       was  $oldrev"
 421     echo ""
 422     echo $LOGEND
 423     git show -s --pretty=oneline $oldrev
 424     echo $LOGEND
 425 }
 426
 427 # --------------- Annotated tags
 428
 429 #
 430 # Called for the creation of an annotated tag
 431 #
 432 generate_create_atag_email()
 433 {
 434     echo "        at  $newrev ($newrev_type)"
 435
 436     generate_atag_email
 437 }
 438
 439 #
 440 # Called for the update of an annotated tag (this is probably a rare event
 441 # and may not even be allowed)
 442 #
 443 generate_update_atag_email()
 444 {
 445     echo "        to  $newrev ($newrev_type)"
 446     echo "      from  $oldrev (which is now obsolete)"
 447
 448     generate_atag_email
 449 }
 450
 451 #
 452 # Called when an annotated tag is created or changed
 453 #
 454 generate_atag_email()
 455 {
 456     # Use git for-each-ref to pull out the individual fields from the tag
 457     eval $(git for-each-ref --shell --format='
 458         tagobject=%(*objectname)
 459         tagtype=%(*objecttype)
 460         tagger=%(taggername)
 461         tagged=%(taggerdate)' $refname
 462     )
 463
 464     echo "   tagging  $tagobject ($tagtype)"
 465     case "$tagtype" in
 466         commit)
 467
 468             # If the tagged object is a commit, then we assume this is a
 469             # release, and so we calculate which tag this tag is
 470             # replacing
 471             prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null)
 472
 473             if [ -n "$prevtag" ]; then
 474                 echo "  replaces  $prevtag"
 475             fi
 476             ;;
 477         *)
 478             echo "    length  $(git cat-file -s $tagobject) bytes"
 479             ;;
 480     esac
 481     echo " tagged by  $tagger"
 482     echo "        on  $tagged"
 483
 484     echo ""
 485     echo $LOGBEGIN
 486
 487     # Show the content of the tag message; this might contain a change
 488     # log or release notes so is worth displaying.
 489     git cat-file tag $newrev | sed -e '1,/^$/d'
 490
 491     echo ""
 492     case "$tagtype" in
 493         commit)
 494             # Only commit tags make sense to have rev-list operations
 495             # performed on them
 496             if [ -n "$prevtag" ]; then
 497                 # Show changes since the previous release
 498                 git rev-list --pretty=short "$prevtag..$newrev" | git shortlog
 499             else
 500                 # No previous tag, show all the changes since time began
 501                 git rev-list --pretty=short $newrev | git shortlog
 502             fi
 503             ;;
 504         *)
 505             # XXX: Is there anything useful we can do for non-commit objects?
 506             ;;
 507     esac
 508
 509     echo $LOGEND
 510 }
 511
 512 #
 513 # Called for the deletion of an annotated tag
 514 #
 515 generate_delete_atag_email()
 516 {
 517     echo "       was  $oldrev"
 518     echo ""
 519     echo $LOGEND
 520     git show -s --pretty=oneline $oldrev
 521     echo $LOGEND
 522 }
 523
 524 # --------------- General references
 525
 526 #
 527 # Called when any other type of reference is created (most likely a
 528 # non-annotated tag)
 529 #
 530 generate_create_general_email()
 531 {
 532     echo "        at  $newrev ($newrev_type)"
 533
 534     generate_general_email
 535 }
 536
 537 #
 538 # Called when any other type of reference is updated (most likely a
 539 # non-annotated tag)
 540 #
 541 generate_update_general_email()
 542 {
 543     echo "        to  $newrev ($newrev_type)"
 544     echo "      from  $oldrev"
 545
 546     generate_general_email
 547 }
 548
 549 #
 550 # Called for creation or update of any other type of reference
 551 #
 552 generate_general_email()
 553 {
 554     # Unannotated tags are more about marking a point than releasing a
 555     # version; therefore we don't do the shortlog summary that we do for
 556     # annotated tags above - we simply show that the point has been
 557     # marked, and print the log message for the marked point for
 558     # reference purposes
 559     #
 560     # Note this section also catches any other reference type (although
 561     # there aren't any) and deals with them in the same way.
 562
 563     echo ""
 564     if [ "$newrev_type" = "commit" ]; then
 565         echo $LOGBEGIN
 566         git show --no-color --root -s $newrev
 567         echo $LOGEND
 568     else
 569         # What can we do here?  The tag marks an object that is not
 570         # a commit, so there is no log for us to display.  It's
 571         # probably not wise to output git cat-file as it could be a
 572         # binary blob.  We'll just say how big it is
 573         echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
 574     fi
 575 }
 576
 577 #
 578 # Called for the deletion of any other type of reference
 579 #
 580 generate_delete_general_email()
 581 {
 582     echo "       was  $oldrev"
 583     echo ""
 584     echo $LOGEND
 585     git show -s --pretty=oneline $oldrev
 586     echo $LOGEND
 587 }
 588
 589 send_mail()
 590 {
 591     COMMITTER=$(git-for-each-ref --format='%(committer)' --sort=-committerdate count=1 refs/heads)
 592     COMMITTERNAME=$(cut -d'<' -f1 <<< $COMMITTER)
 593     if [ -n "$envelopesender" ] ; then
 594         COMMITTERMAIL=$envelopesender
 595     else
 596         COMMITTERMAIL=$(cut -d'<' -f2 <<< $COMMITTER |cut -d'>' -f1)
 597     fi
 598     /usr/sbin/sendmail -t -f "$COMMITTERMAIL" -F "$COMMITTERNAME"
 599 }
 600
 601 # ---------------------------- main()
 602
 603 # --- Constants
 604 LOGBEGIN="-----------------------------------------------------------------------"
 605 LOGEND="-----------------------------------------------------------------------"
 606
 607 # --- Config
 608 # Set GIT_DIR either from the working directory, or from the environment
 609 # variable.
 610 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
 611 if [ -z "$GIT_DIR" ]; then
 612     echo >&2 "fatal: post-receive: GIT_DIR not set"
 613     exit 1
 614 fi
 615
 616 if [ -f "$GIT_DIR/description" ]; then
 617     projectdesc=$(sed -ne '1p' "$GIT_DIR/description")
 618 else
 619     projectdesc=$(git-config gitweb.description)
 620 fi
 621 # Check if the description is unchanged from it's default, and shorten it to
 622 # a more manageable length if it is
 623 if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null
 624 then
 625     projectdesc="UNNAMED PROJECT"
 626 fi
 627
 628 recipients=$(git config hooks.mailinglist)
 629 announcerecipients=$(git config hooks.announcelist)
 630 envelopesender=$(git config hooks.envelopesender)
 631 emailprefix=$(git config hooks.emailprefix || echo '[SCM] ')
 632
 633 # --- Main loop
 634 # Allow dual mode: run from the command line just like the update hook, or
 635 # if no arguments are given then run as a hook script
 636 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
 637     # Output to the terminal in command line mode - if someone wanted to
 638     # resend an email; they could redirect the output to sendmail
 639     # themselves
 640     PAGER= generate_email $2 $3 $1
 641 else
 642     while read oldrev newrev refname
 643     do
 644         generate_email $oldrev $newrev $refname | send_mail
 645     done
 646 fi