Blame build-aux/do-release-commit-and-tag

Packit 33f14e
#!/bin/sh
Packit 33f14e
# In a git/autoconf/automake-enabled project with a NEWS file and a version-
Packit 33f14e
# controlled .prev-version file, automate the procedure by which we record
Packit 33f14e
# the date, release-type and version string in the NEWS file.  That commit
Packit 33f14e
# will serve to identify the release, so apply a signed tag to it as well.
Packit 33f14e
VERSION=2016-12-31.14 # UTC
Packit 33f14e
Packit 33f14e
# Note: this is a bash script (could be zsh or dash)
Packit 33f14e
Packit 33f14e
# Copyright (C) 2009-2017 Free Software Foundation, Inc.
Packit 33f14e
Packit 33f14e
# This program is free software: you can redistribute it and/or modify
Packit 33f14e
# it under the terms of the GNU General Public License as published by
Packit 33f14e
# the Free Software Foundation, either version 3 of the License, or
Packit 33f14e
# (at your option) any later version.
Packit 33f14e
Packit 33f14e
# This program is distributed in the hope that it will be useful,
Packit 33f14e
# but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 33f14e
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit 33f14e
# GNU General Public License for more details.
Packit 33f14e
Packit 33f14e
# You should have received a copy of the GNU General Public License
Packit 33f14e
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
Packit 33f14e
Packit 33f14e
# Written by Jim Meyering
Packit 33f14e
Packit 33f14e
ME=$(basename "$0")
Packit 33f14e
warn() { printf '%s: %s\n' "$ME" "$*" >&2; }
Packit 33f14e
die() { warn "$*"; exit 1; }
Packit 33f14e
Packit 33f14e
help()
Packit 33f14e
{
Packit 33f14e
  cat <
Packit 33f14e
Usage: $ME [OPTION...] VERSION RELEASE_TYPE
Packit 33f14e
Packit 33f14e
Run this script from top_srcdir to perform the final pre-release NEWS
Packit 33f14e
update in which the date, release-type and version string are
Packit 33f14e
recorded.  Commit that result with a log entry marking the release,
Packit 33f14e
and apply a signed tag.  Run it from your project's top-level
Packit 33f14e
directory.
Packit 33f14e
Packit 33f14e
Requirements:
Packit 33f14e
- you use git for version-control
Packit 33f14e
- a version-controlled .prev-version file
Packit 33f14e
- a NEWS file, with line 3 identical to this:
Packit 33f14e
$noteworthy_stub
Packit 33f14e
Packit 33f14e
Options:
Packit 33f14e
  --branch=BRANCH     set release branch (default: $branch)
Packit 33f14e
  -C, --builddir=DIR  location of (configured) Makefile (default: $builddir)
Packit 33f14e
  --help              print this help, then exit
Packit 33f14e
  --version           print version number, then exit
Packit 33f14e
Packit 33f14e
EXAMPLE:
Packit 33f14e
To update NEWS and tag the beta 8.1 release of coreutils, I would run this:
Packit 33f14e
Packit 33f14e
  $ME 8.1 beta
Packit 33f14e
Packit 33f14e
Report bugs and patches to <bug-gnulib@gnu.org>.
Packit 33f14e
EOF
Packit 33f14e
  exit
Packit 33f14e
}
Packit 33f14e
Packit 33f14e
version()
Packit 33f14e
{
Packit 33f14e
  year=$(echo "$VERSION" | sed 's/[^0-9].*//')
Packit 33f14e
  cat <
Packit 33f14e
$ME $VERSION
Packit 33f14e
Copyright (C) $year Free Software Foundation, Inc,
Packit 33f14e
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
Packit 33f14e
This is free software: you are free to change and redistribute it.
Packit 33f14e
There is NO WARRANTY, to the extent permitted by law.
Packit 33f14e
EOF
Packit 33f14e
  exit
Packit 33f14e
}
Packit 33f14e
Packit 33f14e
## ------ ##
Packit 33f14e
## Main.  ##
Packit 33f14e
## ------ ##
Packit 33f14e
Packit 33f14e
# Constants.
Packit 33f14e
noteworthy='* Noteworthy changes in release'
Packit 33f14e
noteworthy_stub="$noteworthy ?.? (????-??-??) [?]"
Packit 33f14e
Packit 33f14e
# Variables.
Packit 33f14e
branch=$(git branch | sed -ne '/^\* /{s///;p;q;}')
Packit 33f14e
builddir=.
Packit 33f14e
Packit 33f14e
while test $# != 0
Packit 33f14e
do
Packit 33f14e
  # Handle --option=value by splitting apart and putting back on argv.
Packit 33f14e
  case $1 in
Packit 33f14e
    --*=*)
Packit 33f14e
      opt=$(echo "$1" | sed -e 's/=.*//')
Packit 33f14e
      val=$(echo "$1" | sed -e 's/[^=]*=//')
Packit 33f14e
      shift
Packit 33f14e
      set dummy "$opt" "$val" "$@"; shift
Packit 33f14e
      ;;
Packit 33f14e
  esac
Packit 33f14e
Packit 33f14e
  case $1 in
Packit 33f14e
    --help|--version) ${1#--};;
Packit 33f14e
    --branch) shift; branch=$1; shift ;;
Packit 33f14e
    -C|--builddir) shift; builddir=$1; shift ;;
Packit 33f14e
    --*) die "unrecognized option: $1";;
Packit 33f14e
    *) break;;
Packit 33f14e
  esac
Packit 33f14e
done
Packit 33f14e
Packit 33f14e
test $# = 2 \
Packit 33f14e
  || die "Usage: $ME [OPTION...] VERSION TYPE"
Packit 33f14e
Packit 33f14e
ver=$1
Packit 33f14e
type=$2
Packit 33f14e
Packit 33f14e
Packit 33f14e
## ---------------------- ##
Packit 33f14e
## First, sanity checks.  ##
Packit 33f14e
## ---------------------- ##
Packit 33f14e
Packit 33f14e
# Verify that $ver looks like a version number, and...
Packit 33f14e
echo "$ver"|grep -E '^[0-9][0-9.]*[0-9]$' > /dev/null \
Packit 33f14e
  || die "invalid version: $ver"
Packit 33f14e
prev_ver=$(cat .prev-version) \
Packit 33f14e
  || die 'failed to determine previous version number from .prev-version'
Packit 33f14e
Packit 33f14e
# Verify that $ver is sensible (> .prev-version).
Packit 33f14e
case $(printf "$prev_ver\n$ver\n"|sort -V -u|tr '\n' ':') in
Packit 33f14e
  "$prev_ver:$ver:") ;;
Packit 33f14e
  *) die "invalid version: $ver (<= $prev_ver)";;
Packit 33f14e
esac
Packit 33f14e
Packit 33f14e
case $type in
Packit 33f14e
  alpha|beta|stable) ;;
Packit 33f14e
  *) die "invalid release type: $type";;
Packit 33f14e
esac
Packit 33f14e
Packit 33f14e
# No local modifications allowed.
Packit 33f14e
case $(git diff-index --name-only HEAD) in
Packit 33f14e
  '') ;;
Packit 33f14e
  *) die 'this tree is dirty; commit your changes first';;
Packit 33f14e
esac
Packit 33f14e
Packit 33f14e
# Ensure the current branch name is correct:
Packit 33f14e
curr_br=$(git rev-parse --symbolic-full-name HEAD)
Packit 33f14e
test "$curr_br" = "refs/heads/$branch" || die not on branch $branch
Packit 33f14e
Packit 33f14e
# Extract package name from Makefile.
Packit 33f14e
Makefile=$builddir/Makefile
Packit 33f14e
pkg=$(sed -n 's/^PACKAGE = \(.*\)/\1/p' "$Makefile") \
Packit 33f14e
  || die "failed to determine package name from $Makefile"
Packit 33f14e
Packit 33f14e
# Check that line 3 of NEWS is the stub line about to be replaced.
Packit 33f14e
test "$(sed -n 3p NEWS)" = "$noteworthy_stub" \
Packit 33f14e
  || die "line 3 of NEWS must be exactly '$noteworthy_stub'"
Packit 33f14e
Packit 33f14e
## --------------- ##
Packit 33f14e
## Then, changes.  ##
Packit 33f14e
## --------------- ##
Packit 33f14e
Packit 33f14e
# Update NEWS to have today's date, plus desired version number and $type.
Packit 33f14e
perl -MPOSIX -ni -e 'my $today = strftime "%F", localtime time;' \
Packit 33f14e
 -e 'my ($type, $ver) = qw('"$type $ver"');' \
Packit 33f14e
 -e 'my $pfx = "'"$noteworthy"'";' \
Packit 33f14e
 -e 'print $.==3 ? "$pfx $ver ($today) [$type]\n" : $_' \
Packit 33f14e
     NEWS || die 'failed to update NEWS'
Packit 33f14e
Packit 33f14e
printf "version $ver\n\n* NEWS: Record release date.\n" \
Packit 33f14e
    | git commit -F -  -a || die 'git commit failed'
Packit 33f14e
git tag -s -m "$pkg $ver" v$ver HEAD || die 'git tag failed'
Packit 33f14e
Packit 33f14e
# Local variables:
Packit 33f14e
# indent-tabs-mode: nil
Packit 33f14e
# eval: (add-hook 'write-file-hooks 'time-stamp)
Packit 33f14e
# time-stamp-start: "VERSION="
Packit 33f14e
# time-stamp-format: "%:y-%02m-%02d.%02H"
Packit 33f14e
# time-stamp-time-zone: "UTC0"
Packit 33f14e
# time-stamp-end: " # UTC"
Packit 33f14e
# End: