id-new-project/post-receive-email-id

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