2 # In a git/autoconf/automake-enabled project with a NEWS file and a version-
3 # controlled .prev-version file, automate the procedure by which we record
4 # the date, release-type and version string in the NEWS file. That commit
5 # will serve to identify the release, so apply a signed tag to it as well.
6 VERSION=2012-06-07.15 # UTC
8 # Note: this is a bash script (could be zsh or dash)
10 # Copyright (C) 2009-2012 Free Software Foundation, Inc.
12 # This program is free software: you can redistribute it and/or modify
13 # it under the terms of the GNU General Public License as published by
14 # the Free Software Foundation, either version 3 of the License, or
15 # (at your option) any later version.
17 # This program is distributed in the hope that it will be useful,
18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 # GNU General Public License for more details.
22 # You should have received a copy of the GNU General Public License
23 # along with this program. If not, see <http://www.gnu.org/licenses/>.
25 # Written by Jim Meyering
28 warn() { printf '%s: %s\n' "$ME" "$*" >&2; }
29 die() { warn "$*"; exit 1; }
31 noteworthy='* Noteworthy changes in release'
32 noteworthy_stub="$noteworthy ?.? (????-??-??) [?]"
37 Usage: $ME [OPTION...] VERSION RELEASE_TYPE
39 Run this script from top_srcdir to perform the final pre-release NEWS
40 update in which the date, release-type and version string are
41 recorded. Commit that result with a log entry marking the release,
42 and apply a signed tag. Run it from your project's top-level
46 - you use git for version-control
47 - a version-controlled .prev-version file
48 - a NEWS file, with line 3 identical to this:
52 --branch=BRANCH set release branch (default: master)
53 -C, --builddir=DIR location of (configured) Makefile (default: .)
54 --help print this help, then exit
55 --version print version number, then exit
58 To update NEWS and tag the beta 8.1 release of coreutils, I would run this:
62 Report bugs and patches to <bug-gnulib@gnu.org>.
69 year=$(echo "$VERSION" | sed 's/[^0-9].*//')
72 Copyright (C) $year Free Software Foundation, Inc,
73 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
74 This is free software: you are free to change and redistribute it.
75 There is NO WARRANTY, to the extent permitted by law.
85 # Handle --option=value by splitting apart and putting back on argv.
88 opt=$(echo "$1" | sed -e 's/=.*//')
89 val=$(echo "$1" | sed -e 's/[^=]*=//')
91 set dummy "$opt" "$val" ${1+"$@"}; shift
96 --help|--version) ${1#--};;
97 --branch) shift; branch=$1; shift ;;
98 -C|--builddir) shift; builddir=$1; shift ;;
99 --*) die "unrecognized option: $1";;
105 || die "Usage: $ME [OPTION...] VERSION TYPE"
110 # Verify that $ver looks like a version number, and...
111 echo "$ver"|grep -E '^[0-9][0-9.]*[0-9]$' > /dev/null \
112 || die "invalid version: $ver"
113 prev_ver=$(cat .prev-version) \
114 || die 'failed to determine previous version number from .prev-version'
116 # Verify that $ver is sensible (> .prev-version).
117 case $(printf "$prev_ver\n$ver\n"|sort -V -u|tr '\n' ':') in
118 "$prev_ver:$ver:") ;;
119 *) die "invalid version: $ver (<= $prev_ver)";;
123 alpha|beta|stable) ;;
124 *) die "invalid release type: $type";;
127 # Extract package name from Makefile.
128 Makefile=$builddir/Makefile
129 pkg=$(sed -n 's/^PACKAGE = \(.*\)/\1/p' "$Makefile") \
130 || die "failed to determine package name from $Makefile"
132 # simple check: no question marks on line 3 of NEWS
133 test "$(sed -n 3p NEWS)" = "$noteworthy_stub" \
134 || die 'line 3 of NEWS looks fishy!'
137 case $(git diff-index --name-only HEAD) in
139 *) die 'this tree is dirty; commit your changes first';;
142 # update NEWS to have today's date, plus desired version number and $type
143 perl -MPOSIX -ni -e 'my $today = strftime "%F", localtime time;' \
144 -e 'my ($type, $ver) = qw('"$type $ver"');' \
145 -e 'my $pfx = "'"$noteworthy"'";' \
146 -e 'print $.==3 ? "$pfx $ver ($today) [$type]\n" : $_' \
147 NEWS || die 'failed to update NEWS'
149 # Ensure the current branch name is correct:
150 curr_br=$(git rev-parse --symbolic-full-name HEAD)
151 test "$curr_br" = refs/heads/$branch || die not on branch $branch
153 printf "version $ver\n\n* NEWS: Record release date.\n" \
154 | git commit -F - -a || die 'git commit failed'
155 git tag -s -m "$pkg $ver" v$ver HEAD || die 'git tag failed'
158 # indent-tabs-mode: nil
159 # eval: (add-hook 'write-file-hooks 'time-stamp)
160 # time-stamp-start: "VERSION="
161 # time-stamp-format: "%:y-%02m-%02d.%02H"
162 # time-stamp-time-zone: "UTC"
163 # time-stamp-end: " # UTC"