release.sh

   1 #!/bin/bash
   2 #
   3 #               Creates and upload a git module tarball
   4 #
   5 # Note on portability:
   6 # This script is intended to run on any platform supported by X.Org.
   7 # Basically, it should be able to run in a Bourne shell.
   8 #
   9 #
  10
  11 export LC_ALL=C
  12
  13 #------------------------------------------------------------------------------
  14 #                       Function: check_local_changes
  15 #------------------------------------------------------------------------------
  16 #
  17 check_local_changes() {
  18     git diff --quiet HEAD > /dev/null 2>&1
  19     if [ $? -ne 0 ]; then
  20         echo ""
  21         echo "Uncommitted changes found. Did you forget to commit? Aborting."
  22         echo ""
  23         echo "You can perform a 'git stash' to save your local changes and"
  24         echo "a 'git stash apply' to recover them after the tarball release."
  25         echo "Make sure to rebuild and run 'make distcheck' again."
  26         echo ""
  27         echo "Alternatively, you can clone the module in another directory"
  28         echo "and run ./configure. No need to build if testing was finished."
  29         echo ""
  30         return 1
  31     fi
  32     return 0
  33 }
  34
  35 #------------------------------------------------------------------------------
  36 #                       Function: check_option_args
  37 #------------------------------------------------------------------------------
  38 #
  39 # perform sanity checks on cmdline args which require arguments
  40 # arguments:
  41 #   $1 - the option being examined
  42 #   $2 - the argument to the option
  43 # returns:
  44 #   if it returns, everything is good
  45 #   otherwise it exit's
  46 check_option_args() {
  47     option=$1
  48     arg=$2
  49
  50     # check for an argument
  51     if [ x"$arg" = x ]; then
  52         echo ""
  53         echo "Error: the '$option' option is missing its required argument."
  54         echo ""
  55         usage
  56         exit 1
  57     fi
  58
  59     # does the argument look like an option?
  60     echo $arg | $GREP "^-" > /dev/null
  61     if [ $? -eq 0 ]; then
  62         echo ""
  63         echo "Error: the argument '$arg' of option '$option' looks like an option itself."
  64         echo ""
  65         usage
  66         exit 1
  67     fi
  68 }
  69
  70 #------------------------------------------------------------------------------
  71 #                       Function: check_modules_specification
  72 #------------------------------------------------------------------------------
  73 #
  74 check_modules_specification() {
  75
  76 if [ x"$MODFILE" = x ]; then
  77     if [ x"${INPUT_MODULES}" = x ]; then
  78         echo ""
  79         echo "Error: no modules specified (blank command line)."
  80         usage
  81         exit 1
  82     fi
  83 fi
  84
  85 }
  86
  87 #------------------------------------------------------------------------------
  88 #                       Function: generate_announce
  89 #------------------------------------------------------------------------------
  90 #
  91 generate_announce()
  92 {
  93     cat <<RELEASE
  94 Subject: [ANNOUNCE] $pkg_name $pkg_version
  95 To: $list_to
  96 Cc: $list_cc
  97
  98 `git log --no-merges "$tag_range" | git shortlog`
  99
 100 git tag: $tag_name
 101
 102 RELEASE
 103
 104     for tarball in $tarbz2 $targz $tarxz; do
 105         cat <<RELEASE
 106 http://$host_current/$section_path/$tarball
 107 MD5:  `$MD5SUM $tarball`
 108 SHA1: `$SHA1SUM $tarball`
 109 SHA256: `$SHA256SUM $tarball`
 110 PGP:  http://${host_current}/${section_path}/${tarball}.sig
 111
 112 RELEASE
 113     done
 114 }
 115
 116 #------------------------------------------------------------------------------
 117 #                       Function: read_modfile
 118 #------------------------------------------------------------------------------
 119 #
 120 # Read the module names from the file and set a variable to hold them
 121 # This will be the same interface as cmd line supplied modules
 122 #
 123 read_modfile() {
 124
 125     if [ x"$MODFILE" != x ]; then
 126         # Make sure the file is sane
 127         if [ ! -r "$MODFILE" ]; then
 128             echo "Error: module file '$MODFILE' is not readable or does not exist."
 129             exit 1
 130         fi
 131         # read from input file, skipping blank and comment lines
 132         while read line; do
 133             # skip blank lines
 134             if [ x"$line" = x ]; then
 135                 continue
 136             fi
 137             # skip comment lines
 138             if echo "$line" | $GREP -q "^#" ; then
 139                 continue;
 140             fi
 141             INPUT_MODULES="$INPUT_MODULES $line"
 142         done <"$MODFILE"
 143     fi
 144     return 0
 145 }
 146
 147 #------------------------------------------------------------------------------
 148 #                       Function: print_epilog
 149 #------------------------------------------------------------------------------
 150 #
 151 print_epilog() {
 152
 153     epilog="========  Successful Completion"
 154     if [ x"$NO_QUIT" != x ]; then
 155         if [ x"$failed_modules" != x ]; then
 156             epilog="========  Partial Completion"
 157         fi
 158     elif [ x"$failed_modules" != x ]; then
 159         epilog="========  Stopped on Error"
 160     fi
 161
 162     echo ""
 163     echo "$epilog `date`"
 164
 165     # Report about modules that failed for one reason or another
 166     if [ x"$failed_modules" != x ]; then
 167         echo "  List of failed modules:"
 168         for mod in $failed_modules; do
 169             echo "      $mod"
 170         done
 171         echo "========"
 172         echo ""
 173     fi
 174 }
 175
 176 #------------------------------------------------------------------------------
 177 #                       Function: process_modules
 178 #------------------------------------------------------------------------------
 179 #
 180 # Loop through each module to release
 181 # Exit on error if --no-quit was not specified
 182 #
 183 process_modules() {
 184     for MODULE_RPATH in ${INPUT_MODULES}; do
 185         if ! process_module ; then
 186             echo "Error: processing module \"$MODULE_RPATH\" failed."
 187             failed_modules="$failed_modules $MODULE_RPATH"
 188             if [ x"$NO_QUIT" = x ]; then
 189                 print_epilog
 190                 exit 1
 191             fi
 192         fi
 193     done
 194 }
 195
 196 #------------------------------------------------------------------------------
 197 #                       Function: get_section
 198 #------------------------------------------------------------------------------
 199 # Code 'return 0' on success
 200 # Code 'return 1' on error
 201 # Sets global variable $section
 202 get_section() {
 203     local module_url
 204     local full_module_url
 205
 206     # Obtain the git url in order to find the section to which this module belongs
 207     full_module_url=`git config --get remote.$remote_name.url | sed 's:\.git$::'`
 208     if [ $? -ne 0 ]; then
 209         echo "Error: unable to obtain git url for remote \"$remote_name\"."
 210         return 1
 211     fi
 212
 213     # The last part of the git url will tell us the section. Look for xorg first
 214     echo "$full_module_url"
 215     module_url=`echo "$full_module_url" | $GREP -o "/xorg/.*"`
 216     if [ $? -eq 0 ]; then
 217         module_url=`echo $module_url | cut -d'/' -f3,4`
 218     else
 219         # The look for mesa, xcb, etc...
 220         module_url=`echo "$full_module_url" | $GREP -o -e "/mesa/.*" -e "/xcb/.*" -e "/xkeyboard-config" -e "/nouveau/xf86-video-nouveau" -e "/libevdev" -e "/wayland/.*" -e "/evemu"`
 221         if [ $? -eq 0 ]; then
 222              module_url=`echo $module_url | cut -d'/' -f2,3`
 223         else
 224             echo "Error: unable to locate a valid project url from \"$full_module_url\"."
 225             echo "Cannot establish url as one of xorg, mesa, xcb, xf86-video-nouveau, xkeyboard-config or wayland"
 226             cd $top_src
 227             return 1
 228         fi
 229     fi
 230
 231     # Find the section (subdirs) where the tarballs are to be uploaded
 232     # The module relative path can be app/xfs, xserver, or mesa/drm for example
 233     section=`echo $module_url | cut -d'/' -f1`
 234     if [ $? -ne 0 ]; then
 235         echo "Error: unable to extract section from $module_url first field."
 236         return 1
 237     fi
 238
 239     if [ x"$section" = xmesa ]; then
 240         section=`echo $module_url | cut -d'/' -f2`
 241         if [ $? -ne 0 ]; then
 242             echo "Error: unable to extract section from $module_url second field."
 243             return 1
 244         elif [ x"$section" != xdrm ]; then
 245             echo "Error: section $section is not supported, only libdrm is."
 246             return 1
 247         fi
 248     fi
 249
 250     if [ x"$section" = xwayland ]; then
 251         section=`echo $module_url | cut -d'/' -f2`
 252         if [ $? -ne 0 ]; then
 253             echo "Error: unable to extract section from $module_url second field."
 254             return 1
 255         fi
 256     fi
 257
 258     return 0
 259 }
 260
 261 #                       Function: sign_or_fail
 262 #------------------------------------------------------------------------------
 263 #
 264 # Sign the given file, if any
 265 # Output the name of the signature generated to stdout (all other output to
 266 # stderr)
 267 # Return 0 on success, 1 on fail
 268 #
 269 sign_or_fail() {
 270     if [ -n "$1" ]; then
 271         sig=$1.sig
 272         rm -f $sig
 273         $GPG -b $1 1>&2
 274         if [ $? -ne 0 ]; then
 275             echo "Error: failed to sign $1." >&2
 276             return 1
 277         fi
 278         echo $sig
 279     fi
 280     return 0
 281 }
 282
 283 #------------------------------------------------------------------------------
 284 #                       Function: process_module
 285 #------------------------------------------------------------------------------
 286 # Code 'return 0' on success to process the next module
 287 # Code 'return 1' on error to process next module if invoked with --no-quit
 288 #
 289 process_module() {
 290
 291     top_src=`pwd`
 292     echo ""
 293     echo "========  Processing \"$top_src/$MODULE_RPATH\""
 294
 295     # This is the location where the script has been invoked
 296     if [ ! -d $MODULE_RPATH ] ; then
 297         echo "Error: $MODULE_RPATH cannot be found under $top_src."
 298         return 1
 299     fi
 300
 301     # Change directory to be in the git module
 302     cd $MODULE_RPATH
 303     if [ $? -ne 0 ]; then
 304         echo "Error: failed to cd to $MODULE_RPATH."
 305         return 1
 306     fi
 307
 308     # ----- Now in the git module *root* directory ----- #
 309
 310     # Check that this is indeed a git module
 311     if [ ! -d .git ]; then
 312         echo "Error: there is no git module here: `pwd`"
 313         return 1
 314     fi
 315
 316     # Change directory to be in the git build directory (could be out-of-source)
 317     # More than one can be found when distcheck has run and failed
 318     configNum=`find . -name config.status -type f | wc -l | sed 's:^ *::'`
 319     if [ $? -ne 0 ]; then
 320         echo "Error: failed to locate config.status."
 321         echo "Has the module been configured?"
 322         return 1
 323     fi
 324     if [ x"$configNum" = x0 ]; then
 325         echo "Error: failed to locate config.status, has the module been configured?"
 326         return 1
 327     fi
 328     if [ x"$configNum" != x1 ]; then
 329         echo "Error: more than one config.status file was found,"
 330         echo "       clean-up previously failed attempts at distcheck"
 331         return 1
 332     fi
 333     status_file=`find . -name config.status -type f`
 334     if [ $? -ne 0 ]; then
 335         echo "Error: failed to locate config.status."
 336         echo "Has the module been configured?"
 337         return 1
 338     fi
 339     build_dir=`dirname $status_file`
 340     cd $build_dir
 341     if [ $? -ne 0 ]; then
 342         echo "Error: failed to cd to $MODULE_RPATH/$build_dir."
 343         cd $top_src
 344         return 1
 345     fi
 346
 347     # ----- Now in the git module *build* directory ----- #
 348
 349     # Check for uncommitted/queued changes.
 350     check_local_changes
 351     if [ $? -ne 0 ]; then
 352         cd $top_src
 353         return 1
 354     fi
 355
 356     # Determine what is the current branch and the remote name
 357     current_branch=`git branch | $GREP "\*" | sed -e "s/\* //"`
 358     remote_name=`git config --get branch.$current_branch.remote`
 359     remote_branch=`git config --get branch.$current_branch.merge | cut -d'/' -f3,4`
 360     echo "Info: working off the \"$current_branch\" branch tracking the remote \"$remote_name/$remote_branch\"."
 361
 362     # Obtain the section
 363     get_section
 364     if [ $? -ne 0 ]; then
 365         cd $top_src
 366         return 1
 367     fi
 368
 369     # Run 'make dist/distcheck' to ensure the tarball matches the git module content
 370     # Important to run make dist/distcheck before looking in Makefile, may need to reconfigure
 371     echo "Info: running \"make $MAKE_DIST_CMD\" to create tarballs:"
 372     ${MAKE} $MAKEFLAGS $MAKE_DIST_CMD > /dev/null
 373     if [ $? -ne 0 ]; then
 374         echo "Error: \"$MAKE $MAKEFLAGS $MAKE_DIST_CMD\" failed."
 375         cd $top_src
 376         return 1
 377     fi
 378
 379     # Find out the tarname from the makefile
 380     pkg_name=`$GREP '^PACKAGE = ' Makefile | sed 's|PACKAGE = ||'`
 381     pkg_version=`$GREP '^VERSION = ' Makefile | sed 's|VERSION = ||'`
 382     tar_name="$pkg_name-$pkg_version"
 383     targz=$tar_name.tar.gz
 384     tarbz2=$tar_name.tar.bz2
 385     tarxz=$tar_name.tar.xz
 386
 387     [ -e $targz ] && ls -l $targz || unset targz
 388     [ -e $tarbz2 ] && ls -l $tarbz2 || unset tarbz2
 389     [ -e $tarxz ] && ls -l $tarxz || unset tarxz
 390
 391     if [ -z "$targz" -a -z "$tarbz2" -a -z "$tarxz" ]; then
 392         echo "Error: no compatible tarballs found."
 393         cd $top_src
 394         return 1
 395     fi
 396
 397     # wayland/weston/libinput tag with the version number only
 398     tag_name="$tar_name"
 399     if [ x"$section" = xwayland ] ||
 400        [ x"$section" = xweston ] ||
 401        [ x"$section" = xlibinput ]; then
 402         tag_name="$pkg_version"
 403     fi
 404
 405     # evemu tag with the version number prefixed by 'v'
 406     if [ x"$section" = xevemu ]; then
 407         tag_name="v$pkg_version"
 408     fi
 409
 410     gpgsignerr=0
 411     siggz="$(sign_or_fail ${targz})"
 412     gpgsignerr=$((${gpgsignerr} + $?))
 413     sigbz2="$(sign_or_fail ${tarbz2})"
 414     gpgsignerr=$((${gpgsignerr} + $?))
 415     sigxz="$(sign_or_fail ${tarxz})"
 416     gpgsignerr=$((${gpgsignerr} + $?))
 417     if [ ${gpgsignerr} -ne 0 ]; then
 418         echo "Error: unable to sign at least one of the tarballs."
 419         cd $top_src
 420         return 1
 421     fi
 422
 423     # Obtain the top commit SHA which should be the version bump
 424     # It should not have been tagged yet (the script will do it later)
 425     local_top_commit_sha=`git  rev-list --max-count=1 HEAD`
 426     if [ $? -ne 0 ]; then
 427         echo "Error: unable to obtain the local top commit id."
 428         cd $top_src
 429         return 1
 430     fi
 431
 432     # Check that the top commit looks like a version bump
 433     git diff --unified=0 HEAD^ | $GREP -F $pkg_version >/dev/null 2>&1
 434     if [ $? -ne 0 ]; then
 435         # Wayland repos use  m4_define([wayland_major_version], [0])
 436         git diff --unified=0 HEAD^ | $GREP -E "(major|minor|micro)_version" >/dev/null 2>&1
 437         if [ $? -ne 0 ]; then
 438             echo "Error: the local top commit does not look like a version bump."
 439             echo "       the diff does not contain the string \"$pkg_version\"."
 440             local_top_commit_descr=`git log --oneline --max-count=1 $local_top_commit_sha`
 441             echo "       the local top commit is: \"$local_top_commit_descr\""
 442             cd $top_src
 443             return 1
 444         fi
 445     fi
 446
 447     # Check that the top commit has been pushed to remote
 448     remote_top_commit_sha=`git  rev-list --max-count=1 $remote_name/$remote_branch`
 449     if [ $? -ne 0 ]; then
 450         echo "Error: unable to obtain top commit from the remote repository."
 451         cd $top_src
 452         return 1
 453     fi
 454     if [ x"$remote_top_commit_sha" != x"$local_top_commit_sha" ]; then
 455         echo "Error: the local top commit has not been pushed to the remote."
 456         local_top_commit_descr=`git log --oneline --max-count=1 $local_top_commit_sha`
 457         echo "       the local top commit is: \"$local_top_commit_descr\""
 458         cd $top_src
 459         return 1
 460     fi
 461
 462     # If a tag exists with the the tar name, ensure it is tagging the top commit
 463     # It may happen if the version set in configure.ac has been previously released
 464     tagged_commit_sha=`git  rev-list --max-count=1 $tag_name 2>/dev/null`
 465     if [ $? -eq 0 ]; then
 466         # Check if the tag is pointing to the top commit
 467         if [ x"$tagged_commit_sha" != x"$remote_top_commit_sha" ]; then
 468             echo "Error: the \"$tag_name\" already exists."
 469             echo "       this tag is not tagging the top commit."
 470             remote_top_commit_descr=`git log --oneline --max-count=1 $remote_top_commit_sha`
 471             echo "       the top commit is: \"$remote_top_commit_descr\""
 472             local_tag_commit_descr=`git log --oneline --max-count=1 $tagged_commit_sha`
 473             echo "       tag \"$tag_name\" is tagging some other commit: \"$local_tag_commit_descr\""
 474             cd $top_src
 475             return 1
 476         else
 477             echo "Info: module already tagged with \"$tag_name\"."
 478         fi
 479     else
 480         # Tag the top commit with the tar name
 481         if [ x"$DRY_RUN" = x ]; then
 482             git tag -s -m $tag_name $tag_name
 483             if [ $? -ne 0 ]; then
 484                 echo "Error:  unable to tag module with \"$tag_name\"."
 485                 cd $top_src
 486                 return 1
 487             else
 488                 echo "Info: module tagged with \"$tag_name\"."
 489             fi
 490         else
 491             echo "Info: skipping the commit tagging in dry-run mode."
 492         fi
 493     fi
 494
 495     # --------- Now the tarballs are ready to upload ----------
 496
 497     # The hostname which is used to connect to the development resources
 498     hostname="annarchy.freedesktop.org"
 499
 500     # Some hostnames are also used as /srv subdirs
 501     host_fdo="www.freedesktop.org"
 502     host_xorg="xorg.freedesktop.org"
 503     host_dri="dri.freedesktop.org"
 504     host_wayland="wayland.freedesktop.org"
 505
 506     # Mailing lists where to post the all [Announce] e-mails
 507     list_to="xorg-announce@lists.freedesktop.org"
 508
 509     # Mailing lists to be CC according to the project (xorg|dri|xkb)
 510     list_xorg_user="xorg@lists.freedesktop.org"
 511     list_dri_devel="dri-devel@lists.freedesktop.org"
 512     list_xkb="xkb@listserv.bat.ru"
 513     list_xcb="xcb@lists.freedesktop.org"
 514     list_nouveau="nouveau@lists.freedesktop.org"
 515     list_wayland="wayland-devel@lists.freedesktop.org"
 516
 517     # nouveau is very special.. sigh
 518     if [ x"$section" = xnouveau ]; then
 519             section=driver
 520             list_cc=$list_nouveau
 521     else
 522             list_cc=$list_xorg_user
 523     fi
 524
 525     host_current=$host_xorg
 526     section_path=archive/individual/$section
 527     srv_path="/srv/$host_current/$section_path"
 528
 529     # Handle special cases such as non xorg projects or migrated xorg projects
 530     # Xcb has a separate mailing list
 531     if [ x"$section" = xxcb ]; then
 532         list_cc=$list_xcb
 533     fi
 534
 535     # Module mesa/drm goes in the dri "libdrm" section
 536     if [ x"$section" = xdrm ]; then
 537         host_current=$host_dri
 538         section_path=libdrm
 539         srv_path="/srv/$host_current/www/$section_path"
 540         list_cc=$list_dri_devel
 541     fi
 542
 543     # Module xkeyboard-config goes in a subdir of the xorg "data" section
 544     if [ x"$section" = xxkeyboard-config ]; then
 545         host_current=$host_xorg
 546         section_path=archive/individual/data/$section
 547         srv_path="/srv/$host_current/$section_path"
 548         list_cc=$list_xkb
 549     fi
 550
 551     if [ x"$section" = xlibevdev ]; then
 552         host_current=$host_fdo
 553         section_path="software/$section"
 554         srv_path="/srv/$host_current/www/$section_path"
 555         list_to=input-tools@lists.freedesktop.org
 556         unset list_cc
 557     fi
 558
 559     if [ x"$section" = xwayland ] ||
 560        [ x"$section" = xweston ]; then
 561         host_current=$host_wayland
 562         section_path="releases"
 563         srv_path="/srv/$host_current/www/releases"
 564         list_to=$list_wayland
 565         unset list_cc
 566     elif [ x"$section" = xlibinput ]; then
 567         host_current=$host_fdo
 568         section_path="software/libinput"
 569         srv_path="/srv/$host_current/www/$section_path"
 570         list_to=$list_wayland
 571         unset list_cc
 572     elif [ x"$section" = xevemu ]; then
 573         host_current=$host_fdo
 574         section_path="software/evemu"
 575         srv_path="/srv/$host_current/www/$section_path"
 576         list_to=input-tools@lists.freedesktop.org
 577         unset list_cc
 578     fi
 579
 580     # Use personal web space on the host for unit testing (leave commented out)
 581     # srv_path="~/public_html$srv_path"
 582
 583     # Check that the server path actually does exist
 584     ssh $USER_NAME$hostname ls $srv_path >/dev/null 2>&1 ||
 585     if [ $? -ne 0 ]; then
 586         echo "Error: the path \"$srv_path\" on the web server does not exist."
 587         cd $top_src
 588         return 1
 589     fi
 590
 591     # Check for already existing tarballs
 592     for tarball in $targz $tarbz2 $tarxz; do
 593         ssh $USER_NAME$hostname ls $srv_path/$tarball  >/dev/null 2>&1
 594         if [ $? -eq 0 ]; then
 595             if [ "x$FORCE" = "xyes" ]; then
 596                 echo "Warning: overwriting released tarballs due to --force option."
 597             else
 598                 echo "Error: tarball $tar_name already exists. Use --force to overwrite."
 599                 cd $top_src
 600                 return 1
 601             fi
 602         fi
 603     done
 604
 605     # Upload to host using the 'scp' remote file copy program
 606     if [ x"$DRY_RUN" = x ]; then
 607         echo "Info: uploading tarballs to web server:"
 608         scp $targz $tarbz2 $tarxz $siggz $sigbz2 $sigxz $USER_NAME$hostname:$srv_path
 609         if [ $? -ne 0 ]; then
 610             echo "Error: the tarballs uploading failed."
 611             cd $top_src
 612             return 1
 613         fi
 614     else
 615         echo "Info: skipping tarballs uploading in dry-run mode."
 616         echo "      \"$srv_path\"."
 617     fi
 618
 619     # Pushing the top commit tag to the remote repository
 620     if [ x$DRY_RUN = x ]; then
 621         echo "Info: pushing tag \"$tag_name\" to remote \"$remote_name\":"
 622         git push $remote_name $tag_name
 623         if [ $? -ne 0 ]; then
 624             echo "Error: unable to push tag \"$tag_name\" to the remote repository."
 625             echo "       it is recommended you fix this manually and not run the script again"
 626             cd $top_src
 627             return 1
 628         fi
 629     else
 630         echo "Info: skipped pushing tag \"$tag_name\" to the remote repository in dry-run mode."
 631     fi
 632
 633     MD5SUM=`which md5sum || which gmd5sum`
 634     SHA1SUM=`which sha1sum || which gsha1sum`
 635     SHA256SUM=`which sha256sum || which gsha256sum`
 636
 637     # --------- Generate the announce e-mail ------------------
 638     # Failing to generate the announce is not considered a fatal error
 639
 640     # Git-describe returns only "the most recent tag", it may not be the expected one
 641     # However, we only use it for the commit history which will be the same anyway.
 642     tag_previous=`git describe --abbrev=0 HEAD^ 2>/dev/null`
 643     # Git fails with rc=128 if no tags can be found prior to HEAD^
 644     if [ $? -ne 0 ]; then
 645         if [ $? -ne 0 ]; then
 646             echo "Warning: unable to find a previous tag."
 647             echo "         perhaps a first release on this branch."
 648             echo "         Please check the commit history in the announce."
 649         fi
 650     fi
 651     if [ x"$tag_previous" != x ]; then
 652         # The top commit may not have been tagged in dry-run mode. Use commit.
 653         tag_range=$tag_previous..$local_top_commit_sha
 654     else
 655         tag_range=$tag_name
 656     fi
 657     generate_announce > "$tar_name.announce"
 658     echo "Info: [ANNOUNCE] template generated in \"$tar_name.announce\" file."
 659     echo "      Please pgp sign and send it."
 660
 661     # --------- Update the JH Build moduleset -----------------
 662     # Failing to update the jh moduleset is not considered a fatal error
 663     if [ x"$JH_MODULESET" != x ]; then
 664         for tarball in $targz $tarbz2 $tarxz; do
 665             if [ x$DRY_RUN = x ]; then
 666                 sha1sum=`$SHA1SUM $tarball | cut -d' ' -f1`
 667                 $top_src/util/modular/update-moduleset.sh $JH_MODULESET $sha1sum $tarball
 668                 echo "Info: updated jh moduleset: \"$JH_MODULESET\""
 669             else
 670                 echo "Info: skipping jh moduleset \"$JH_MODULESET\" update in dry-run mode."
 671             fi
 672
 673             # $tar* may be unset, so simply loop through all of them and the
 674             # first one that is set updates the module file
 675             break
 676         done
 677     fi
 678
 679
 680     # --------- Successful completion --------------------------
 681     cd $top_src
 682     return 0
 683
 684 }
 685
 686 #------------------------------------------------------------------------------
 687 #                       Function: usage
 688 #------------------------------------------------------------------------------
 689 # Displays the script usage and exits successfully
 690 #
 691 usage() {
 692     basename="`expr "//$0" : '.*/\([^/]*\)'`"
 693     cat <<HELP
 694
 695 Usage: $basename [options] path...
 696
 697 Where "path" is a relative path to a git module, including '.'.
 698
 699 Options:
 700   --dist              make 'dist' instead of 'distcheck'; use with caution
 701   --distcheck         Default, ignored for compatibility
 702   --dry-run           Does everything except tagging and uploading tarballs
 703   --force             Force overwriting an existing release
 704   --help              Display this help and exit successfully
 705   --modfile <file>    Release the git modules specified in <file>
 706   --moduleset <file>  The jhbuild moduleset full pathname to be updated
 707   --no-quit           Do not quit after error; just print error message
 708   --user <name>@      Username of your fdo account if not configured in ssh
 709
 710 Environment variables defined by the "make" program and used by release.sh:
 711   MAKE        The name of the make command [make]
 712   MAKEFLAGS:  Options to pass to all \$(MAKE) invocations
 713
 714 HELP
 715 }
 716
 717 #------------------------------------------------------------------------------
 718 #                       Script main line
 719 #------------------------------------------------------------------------------
 720 #
 721
 722 # Choose which make program to use (could be gmake)
 723 MAKE=${MAKE:="make"}
 724
 725 # Choose which grep program to use (on Solaris, must be gnu grep)
 726 if [ "x$GREP" = "x" ] ; then
 727     if [ -x /usr/gnu/bin/grep ] ; then
 728         GREP=/usr/gnu/bin/grep
 729     else
 730         GREP=grep
 731     fi
 732 fi
 733
 734 # Find path for GnuPG v2
 735 if [ "x$GPG" = "x" ] ; then
 736     if [ -x /usr/bin/gpg2 ] ; then
 737         GPG=/usr/bin/gpg2
 738     else
 739         GPG=gpg
 740     fi
 741 fi
 742
 743 # Set the default make tarball creation command
 744 MAKE_DIST_CMD=distcheck
 745
 746 # Process command line args
 747 while [ $# != 0 ]
 748 do
 749     case $1 in
 750     # Use 'dist' rather than 'distcheck' to create tarballs
 751     # You really only want to do this if you're releasing a module you can't
 752     # possibly build-test.  Please consider carefully the wisdom of doing so.
 753     --dist)
 754         MAKE_DIST_CMD=dist
 755         ;;
 756     # Use 'distcheck' to create tarballs
 757     --distcheck)
 758         MAKE_DIST_CMD=distcheck
 759         ;;
 760     # Does everything except uploading tarball
 761     --dry-run)
 762         DRY_RUN=yes
 763         ;;
 764     # Force overwriting an existing release
 765     # Use only if nothing changed in the git repo
 766     --force)
 767         FORCE=yes
 768         ;;
 769     # Display this help and exit successfully
 770     --help)
 771         usage
 772         exit 0
 773         ;;
 774     # Release the git modules specified in <file>
 775     --modfile)
 776         check_option_args $1 $2
 777         shift
 778         MODFILE=$1
 779         ;;
 780     # The jhbuild moduleset to update with relase info
 781     --moduleset)
 782         check_option_args $1 $2
 783         shift
 784         JH_MODULESET=$1
 785         ;;
 786     # Do not quit after error; just print error message
 787     --no-quit)
 788         NO_QUIT=yes
 789         ;;
 790     # Username of your fdo account if not configured in ssh
 791     --user)
 792         check_option_args $1 $2
 793         shift
 794         USER_NAME=$1
 795         ;;
 796     --*)
 797         echo ""
 798         echo "Error: unknown option: $1"
 799         echo ""
 800         usage
 801         exit 1
 802         ;;
 803     -*)
 804         echo ""
 805         echo "Error: unknown option: $1"
 806         echo ""
 807         usage
 808         exit 1
 809         ;;
 810     *)
 811         if [ x"${MODFILE}" != x ]; then
 812             echo ""
 813             echo "Error: specifying both modules and --modfile is not permitted"
 814             echo ""
 815             usage
 816             exit 1
 817         fi
 818         INPUT_MODULES="${INPUT_MODULES} $1"
 819         ;;
 820     esac
 821
 822     shift
 823 done
 824
 825 # If no modules specified (blank cmd line) display help
 826 check_modules_specification
 827
 828 # Read the module file and normalize input in INPUT_MODULES
 829 read_modfile
 830
 831 # Loop through each module to release
 832 # Exit on error if --no-quit no specified
 833 process_modules
 834
 835 # Print the epilog with final status
 836 print_epilog