etc/post-receive

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