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