contrib/hooks/post-receive-email

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