2 # release.sh: openocd release process automation
3 # Copyright (C) 2009 by Zachary T Welch <zw@superlucidity.net>
4 # Release under the GNU GPL v2 (or later versions).
6 ## set these to control the build process
10 ## DO NOT PERFORM LIVE RELEASES UNLESS YOU ARE THE RELEASE MANAGER!!!
12 ## set this to perform individual steps on past releases
21 svn info | grep "$1" | cut -d':' -f2- | cut -c2-
25 SVN_ROOT="$(svn_info_get 'Repository Root')"
26 SVN_URL="$(svn_info_get 'URL')"
28 SVN_TRUNK="${SVN_ROOT}/trunk"
30 SVN_BRANCHES="${SVN_ROOT}/branches"
31 PACKAGE_BRANCH="${SVN_BRANCHES}/${PACKAGE_RELEASE}"
33 SVN_TAGS="${SVN_ROOT}/tags"
34 PACKAGE_TAG="${SVN_TAGS}/${PACKAGE_RELEASE}"
36 if [ "${SVN_URL}" = "${SVN_TRUNK}" ]; then
38 elif [ "${SVN_URL/${SVN_BRANCHES}/}" != "${SVN_URL}" ]; then
41 echo "error: bad URL: ${SVN_URL}" >&2
42 die "unable to branch from the current location"
47 Release Type: ${RELEASE_TYPE}
48 Branch URL: ${PACKAGE_BRANCH}
49 Tag URL: ${PACKAGE_TAG}
53 do_svn_echo_msg() { echo "svn: $1: $3"; }
59 [ "$*" ] && echo "Files: $@"
69 echo "svn: ${ACTION}: $@"
75 [ "${RELEASE_DRY_RUN}" ] || svn "$@"
83 package_info_load_name() {
84 grep AC_INIT configure.in | perl -ne 's/^.+\(\[([-\w]*)\],.+$/$1/ and print'
86 package_info_load_version() {
87 grep AC_INIT configure.in | perl -ne 's/^.+\[([-\w\.]*)\],$/$1/ and print'
91 [ -f "configure.in" ] || \
92 die "package_info_load: configure.in is missing"
94 PACKAGE_NAME="$(package_info_load_name)"
96 PACKAGE_TARNAME="${PACKAGE_NAME}"
98 PACKAGE_VERSION="$(package_info_load_version)"
99 [ "${RELEASE_VERSION}" ] || \
100 RELEASE_VERSION=${PACKAGE_VERSION/-in-development/}
102 [ "${PACKAGE_NAME}" -a "${PACKAGE_VERSION}" ] || \
103 die "package information is missing from configure script"
105 PACKAGE_VERSION_TAGS=
106 [ "${PACKAGE_VERSION/-/}" = "${PACKAGE_VERSION}" ] || \
107 PACKAGE_VERSION_TAGS="-${PACKAGE_VERSION#*-}"
108 PACKAGE_VERSION_BASE="${PACKAGE_VERSION%%-*}"
109 PACKAGE_MICRO="${PACKAGE_VERSION_BASE##*.}"
110 PACKAGE_MAJOR_AND_MINOR="${PACKAGE_VERSION_BASE%.*}"
111 PACKAGE_MAJOR="${PACKAGE_MAJOR_AND_MINOR%.*}"
112 PACKAGE_MINOR="${PACKAGE_MAJOR_AND_MINOR#*.}"
114 PACKAGE_STRING="${PACKAGE_NAME} ${PACKAGE_VERSION}"
115 if [ "${RELEASE_DRY_RUN}" ]; then
116 PACKAGE_RELEASE="${PACKAGE_TARNAME}-${PACKAGE_VERSION}"
118 PACKAGE_RELEASE="${PACKAGE_TARNAME}-${RELEASE_VERSION}"
122 package_info_show() {
124 Name: ${PACKAGE_TARNAME}
125 Release: ${RELEASE_VERSION}
126 Version: ${PACKAGE_VERSION}
127 Number: ${PACKAGE_VERSION_BASE}
128 Series: ${PACKAGE_MAJOR_AND_MINOR}
129 Major: ${PACKAGE_MAJOR}
130 Minor: ${PACKAGE_MINOR}
131 Micro: ${PACKAGE_MICRO}
132 Tags: ${PACKAGE_VERSION_TAGS}
133 Branch: ${PACKAGE_RELEASE}
134 Release: ${PACKAGE_TARNAME}-${PACKAGE_VERSION_BASE}${PACKAGE_VERSION_TAGS}
143 info Show a summary of the next pending release.
144 release Release the current tree as an archive.
145 upload Upload archives to berliOS project site
148 bootstrap Prepare the working copy for configuration and building.
149 configure Configures the package; runs bootstrap, if needed.
150 build Compiles the project; runs configure, if needed.
153 changelog Generate a new ChangeLog using svn2cl.
154 package Produce new distributable source archives.
155 stage Move archives to staging area for upload.
158 commit Perform branch and tag, as appropriate for the version.
159 branch Create a release branch from the project trunk.
160 tag Create a tag for the current release branch.
163 version ... Perform version number and tag manipulations.
164 maryslamb Mary had a little lamb, but no one noticed.
165 clean Forces regeneration of results.
166 clean_all Removes all traces of the release process.
167 help Provides this list of commands.
169 For more information about this script, see the Release Processes page
170 in the OpenOCD Developer's Manual (doc/manual/release.txt).
172 WARNING: This script should be used by the Release Manager ONLY.
176 do_usage() { usage; }
180 echo "Current Release Analysis:"
192 echo -n "Bootstrapping..."
193 ./bootstrap 2>&1 | perl tools/logger.pl > "release-bootstrap.log"
195 maybe_bootstrap() { [ -f "configure" ] || do_bootstrap; }
199 echo -n "Configuring..."
200 ./configure ${CONFIG_OPTS} 2>&1 | perl tools/logger.pl > "release-config.log"
202 maybe_configure() { [ -f "Makefile" ] || do_configure; }
206 echo -n "Compiling OpenOCD ${PACKAGE_VERSION}"
207 make ${MAKE_OPTS} -C doc stamp-vti 2>&1 \
208 | perl tools/logger.pl > "release-version.log"
209 make ${MAKE_OPTS} 2>&1 \
210 | perl tools/logger.pl > "release-make.log"
212 maybe_build() { [ -f "src/openocd" ] || do_build; }
213 do_build_clean() { [ -f Makefile ] && make maintainer-clean >/dev/null; }
216 if [ -f "configure" ]; then
217 echo "Re-running autoconf..."
219 echo "Re-running automake..."
222 if [ -f "Makefile" ]; then
229 echo "Updating working copy to HEAD..."
231 echo "Creating ChangeLog..."
232 svn2cl -i --authors AUTHORS.ChangeLog
235 if [ -z "${RELEASE_DRY_RUN}" ] \
236 || [ ! -f ChangeLog ] \
237 || [ "$(cat ChangeLog | wc -l)" -lt 2 ]
242 do_changelog_clean() {
243 do_svn revert ChangeLog
250 echo "Building distribution packages..."
251 make ${MAKE_OPTS} distcheck 2>&1 | perl tools/logger.pl > "release-pkg.log"
253 maybe_package() { [ -f "${PACKAGE_RELEASE}.zip" ] || do_package; }
255 for EXT in tar.gz tar.bz2 zip; do
262 echo "Staging package archives:"
264 for EXT in tar.gz tar.bz2 zip; do
265 mv -v "${PACKAGE_RELEASE}.${EXT}" archives/
268 cp -a ChangeLog archives/
270 do_stage_clean() { rm -v -f -r archives; }
277 svn revert configure.in
278 rm -v -f release-*.log
288 usage: $0 version <command>
290 tag {add|remove} <label> Add or remove the specified tag.
291 bump {major|minor|micro|rc} Bump the specified version number;
292 resets less-significant numbers to zero.
293 All but 'rc' releases drop that tag.
298 local OLD_VERSION="${PACKAGE_VERSION}"
299 local NEW_VERSION="$1"
302 sed -i -e "/AC_INIT/ s|${OLD_VERSION}|${NEW_VERSION}|" configure.in
304 echo "${MSG}: ${OLD_VERSION} -> ${NEW_VERSION}"
306 do_version_bump_sed() {
307 local NEW_VERSION="$1"
308 [ -z "${PACKAGE_VERSION_TAGS}" ] || \
309 NEW_VERSION="${NEW_VERSION}${PACKAGE_VERSION_TAGS}"
311 do_version_sed "${NEW_VERSION}" \
312 "Bump ${CMD} package version number"
314 do_version_bump_major() {
315 has_version_tag 'rc\d' do_version_
316 do_version_bump_sed "$((PACKAGE_MAJOR + 1)).0.0"
318 do_version_bump_minor() {
319 do_version_bump_sed "${PACKAGE_MAJOR}.$((PACKAGE_MINOR + 1)).0"
321 do_version_bump_micro() {
322 do_version_bump_sed "${PACKAGE_MAJOR_AND_MINOR}.$((PACKAGE_MICRO + 1))"
324 do_version_bump_rc() {
325 die "patch missing: -rc support is not implemented"
331 major|minor|micro|rc)
332 eval "do_version_bump_${CMD}"
341 test "${PACKAGE_VERSION/-${TAG}/}" != "${PACKAGE_VERSION}"
344 do_version_tag_add() {
346 has_version_tag && die "error: tag '-${TAG}' exists in '${PACKAGE_VERSION}'"
347 do_version_sed "${PACKAGE_VERSION}-${TAG}" \
348 "Add '-${TAG}' version tag"
350 do_version_tag_remove() {
352 has_version_tag || die "error: tag '-${TAG}' missing from '${PACKAGE_VERSION}'"
353 do_version_sed "${PACKAGE_VERSION/-${TAG}/}" \
354 "Remove '-${TAG}' version tag"
363 eval "do_version_tag_${CMD}" "${i}"
372 do_version_commit() {
373 [ "$(svn diff configure.in | wc -l)" -gt 0 ] || \
374 die "error: no version changes to commit"
375 do_svn commit -m "$1" configure.in
384 do_version_commit "$(eval "do_version_${CMD}" "$@")"
389 [ "${MSG}" ] || die "usage: $0 version commit <message>"
390 do_version_commit "${MSG}"
403 do_svn copy -m "Branching version ${PACKAGE_VERSION}" \
404 "${SVN_TRUNK}" "${PACKAGE_BRANCH}"
409 do_svn copy -m "Tagging version ${PACKAGE_VERSION}" \
410 "${PACKAGE_BRANCH}" "${PACKAGE_TAG}"
416 [ "${PACKAGE_VERSION/in-development/}" = "${PACKAGE_VERSION}" ] || \
417 die "'${PACKAGE_NAME}-${PACKAGE_VERSION}' cannot be released"
419 [ "${PACKAGE_VERSION%.0}" = "${PACKAGE_VERSION}" ] || \
425 do_release_step_prep() {
426 do_version tag remove in-development
427 # reset RELEASE_VERSION now to allow release version to be detected
428 export RELEASE_VERSION=
430 do_release_step_commit() { do_commit; }
432 do_release_step_branch_bump() {
434 echo "Bump ${TYPE} version and add tag:"
435 do_version_bump ${TYPE}
436 do_version_tag_add in-development
438 do_release_step_branch() {
439 do_svn_switch "${PACKAGE_BRANCH}"
440 do_version_commit "$(do_release_step_branch_bump micro)"
441 do_svn_switch "${SVN_URL}"
443 do_release_step_news_msg() {
445 Archive released NEWS file: NEWS -> NEWS-${RELEASE_VERSION}
446 Create new NEWS file from relesse script template.
449 do_release_step_news() {
450 # archive NEWS and create new one from template
451 do_svn move "NEWS" "NEWS-${RELEASE_VERSION}"
453 [ "${RELEASE_DRY_RUN}" ] || cat >NEWS <<NEWS
454 This file should include items worth mentioning in the
455 OpenOCD ${PACKAGE_RELEASE} source archive release.
457 The following areas of OpenOCD functionality changed in this release:
462 Board, Target, and Interface Configuration Scripts:
466 For more details about what has changed since the last release,
467 see the ChangeLog associated with this source archive. For older NEWS,
468 see the NEWS files associated with each release (i.e. NEWS-<version>).
470 For more information about contributing test reports, bug fixes, or new
471 features and device support, please read the new Developer Manual (or
472 the BUGS and PATCHES files in the source archive).
476 local MSG="$(do_release_step_news_msg)"
477 do_svn commit -m "${MSG}" NEWS NEWS-${RELEASE_VERSION}
479 do_release_step_bump() {
480 # major and minor releases require branch version update too
481 [ "${RELEASE_TYPE}" = "micro" ] || do_release_step_branch
482 # bump the current tree version as required.
483 do_version_commit "$(do_release_step_branch_bump "${RELEASE_TYPE}")"
485 [ "${RELEASE_TYPE}" = "micro" ] || do_release_step_news
487 do_release_step_package() {
488 local A=${PACKAGE_TAG}
489 local B=${A/https/http}
490 local PACKAGE_BUILD=${B/${USER}@/}
491 do_svn_switch "${PACKAGE_TAG}"
492 do_svn_switch --relocate "${PACKAGE_TAG}" "${PACKAGE_BUILD}"
495 do_svn_switch --relocate "${PACKAGE_BUILD}" "${PACKAGE_TAG}"
496 do_svn_switch "${SVN_URL}"
499 do_release_step_1() { do_release_step_prep; }
500 do_release_step_2() { do_release_step_commit; }
501 do_release_step_3() { do_release_step_bump; }
502 do_release_step_4() { do_release_step_package; }
505 echo -n "Are you sure you want to release '${PACKAGE_RELEASE}'?"
507 if [ "${ANSWER}" != 'y' ]; then
508 echo "Live release aborted!"
514 for i in $(seq 5 -1 1); do
524 if [ -z "${RELEASE_DRY_RUN}" ]; then
526 do_countdown "Starting live release"
530 for i in $(seq 1 4); do
531 eval "do_release_step_${i}"
534 do_all() { do_release "$@"; }
540 svn revert configure.in
543 OPTIONS=$(getopt -o V --long live -n $0 -- "$@")
544 if [ $? != 0 ] ; then echo "Terminating..." >&2 ; exit 1 ; fi
545 eval set -- "${OPTIONS}"
549 export RELEASE_DRY_RUN=
560 echo "Internal error"
567 [ "${CMD}" ] || usage
570 ACTION_CMDS="bootstrap|configure|build|changelog|package|stage|clean"
571 MISC_CMDS="all|info|version|tag|branch|commit|release|reset|help|usage"
572 CLEAN_CMDS="build_clean|changelog_clean|package_clean|stage_clean|clean_all"
573 CMDS="|${ACTION_CMDS}|${CLEAN_CMDS}|${MISC_CMDS}|"
574 is_command() { echo "${CMDS}" | grep "|$1|" >/dev/null; }
576 if is_command "${CMD}"; then
577 eval "do_${CMD}" "$@"
579 echo "error: unknown command: '${CMD}'"