diff options
author | Stefan Metzmacher <metze@samba.org> | 2015-08-04 11:33:26 +0200 |
---|---|---|
committer | Andrew Bartlett <abartlet@samba.org> | 2015-08-06 00:43:24 +0200 |
commit | 71128e0a3ceaec43824bc72e0c64d5ce415869a2 (patch) | |
tree | 730f7410dac2a506e649aff093faf5e45315c610 /script | |
parent | 9d9a767ef24a684ffe6e95bb95ecb80b8fbe11a9 (diff) | |
download | samba-71128e0a3ceaec43824bc72e0c64d5ce415869a2.tar.gz |
script/release.sh: This is a new script to do releases
This will replace script/librelease.sh and is more flexible
and powerful.
Usage: release.sh <PRODUCT> <COMMAND>
PRODUCT: ldb, talloc, tevent, tdb, samba-rc
COMMAND: fullrelease, create, push, upload, announce
GNUPGHOME=/path/to/private/gpg script/librelease.sh tdb
becomes
GNUPGHOME=/path/to/private/gpg script/release.sh tdb fullrelease
GNUPGHOME=/path/to/private/gpg script/librelease.sh samba
becomes
GNUPGHOME=/path/to/private/gpg script/release.sh samba-rc create
or later
GNUPGHOME=/path/to/private/gpg script/release.sh samba-stable create
Signed-off-by: Stefan Metzmacher <metze@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
Diffstat (limited to 'script')
-rwxr-xr-x | script/release.sh | 615 |
1 files changed, 615 insertions, 0 deletions
diff --git a/script/release.sh b/script/release.sh new file mode 100755 index 00000000000..9f7379ede23 --- /dev/null +++ b/script/release.sh @@ -0,0 +1,615 @@ +#!/bin/bash +# make a release of Samba or a library + +LC_ALL=C +export LC_ALL +LANG=C +export LANG +LANGUAGE=C +export LANGUAGE + +set -u +set -e +umask 0022 + +CONF_REPO_URL="ssh://git.samba.org/data/git/samba.git" +CONF_UPLOAD_URL="samba-bugs@download-master.samba.org:/home/data/ftp/pub" +CONF_DOWNLOAD_URL="https://download.samba.org/pub" + +test -d ".git" || { + echo "Run this script from the top-level directory in the" + echo "repository" + exit 1 +} + +usage() { + echo "Usage: release.sh <PRODUCT> <COMMAND>" + echo "" + echo "PRODUCT: ldb, talloc, tevent, tdb, samba-rc" + echo "COMMAND: fullrelease, create, push, upload, announce" + echo "" + return 0 +} + +check_args() { + local cmd="$1" + local got_args="$2" + local take_args="$3" + + test x"${got_args}" = x"${take_args}" || { + usage + echo "cmd[${cmd}] takes ${take_args} instead of ${got_args}" + return 1 + } + + return 0 +} + +min_args() { + local cmd="$1" + local got_args="$2" + local min_args="$3" + + test "${got_args}" -ge "${min_args}" || { + usage + echo "cmd[${cmd}] takes at least ${min_args} instead of ${got_args}" + return 1 + } + + return 0 +} + +min_args "$0" "$#" "2" + +product="$1" +globalcmd="$2" +shift 2 +tagname="" +cmds="" +next_cmd="" + +require_tagname() { + min_args "${FUNCNAME}" "$#" "1" || return 1 + local cmd="$1" + + test -n "${tagname}" || { + echo "cmd[${cmd}] requires '\${tagname}' variable to be set" + return 1 + } + + local name=$(echo "${tagname}" | cut -d '-' -f1) + test x"${name}" = x"${productbase}" || { + echo "Invalid tagname[${tgzname}]" + return 1 + } + + return 0 +} + +cmd_allowed() { + min_args "${FUNCNAME}" "$#" "2" || return 1 + local cmd="$1" + shift 1 + + echo "$@" | grep -q "\<${cmd}\>" || { + return 1 + } + + return 0 +} + +verify_samba_rc() { + check_args "${FUNCNAME}" "$#" "0" || return 1 + + test -f VERSION || { + echo "VERSION doesn't exist" + return 1 + } + + grep -q 'SAMBA_VERSION_IS_GIT_SNAPSHOT=no' VERSION || { + echo "SAMBA_VERSION_IS_GIT_SNAPSHOT is not 'no'" + return 1 + } + + grep -q '^SAMBA_VERSION_RC_RELEASE=' VERSION || { + echo "SAMBA_VERSION_RC_RELEASE= missing" + return 1 + } + + grep -q '^SAMBA_VERSION_RC_RELEASE=$' VERSION && { + echo "SAMBA_VERSION_RC_RELEASE= missing the rc version" + return 1 + } + + return 0 +} + +verify_release() { + check_args "${FUNCNAME}" "$#" "0" || return 1 + + test -n "${verify_fn}" || { + echo "verify_fn variable empty" + return 1 + } + + echo "Running ${verify_fn}" + ${verify_fn} +} + +create_release() { + check_args "${FUNCNAME}" "$#" "0" || return 1 + + echo "Releasing product ${product}" + + echo "Building release tarball" + local tgzname=$(make dist 2>&1 | grep ^Created | cut -d' ' -f2) + test -f "${tgzname}" || { + echo "Failed to create tarball" + return 1 + } + CLEANUP_FILES="${CLEANUP_FILES} ${tgzname}" + + local name=$(echo "${tgzname}" | cut -d '-' -f1) + test x"${name}" = x"${productbase}" || { + echo "Invalid tgzname[${tgzname}]" + return 1 + } + + local tarname=$(basename ${tgzname} .gz) + echo "Tarball: ${tarname}" + gunzip -f ${tgzname} || exit 1 + test -f "${tarname}" || { + echo "Failed to decompress tarball ${tarname}" + return 1 + } + CLEANUP_FILES="${CLEANUP_FILES} ${tarname}" + + # tagname is global + tagname=$(basename ${tarname} .tar) + echo "Tagging as ${tagname}" + git tag -u ${GPG_KEYID} -s "${tagname}" -m "${productbase}: tag release ${tagname}" || { + return 1 + } + CLEANUP_TAGS="${CLEANUP_TAGS} ${tagname}" + + echo "signing" + rm -f "${tarname}.asc" + gpg -u "${GPG_USER}" --detach-sign --armor ${tarname} || { + return 1 + } + test -f "${tarname}.asc" || { + echo "Failed to create signature ${tarname}.asc" + return 1 + } + CLEANUP_FILES="${CLEANUP_FILES} ${tarname}.asc" + echo "compressing" + gzip -f -9 ${tarname} + test -f "${tgzname}" || { + echo "Failed to compress ${tgzname}" + return 1 + } + + return 0 +} + +whatsnew_release() { + check_args "${FUNCNAME}" "$#" "0" || return 1 + require_tagname "${FUNCNAME}" + + echo "extract ${tagname}.WHATSNEW.txt" + tar xf ${tagname}.tar.gz --to-stdout ${tagname}/WHATSNEW.txt > ${tagname}.WHATSNEW.txt + CLEANUP_FILES="${CLEANUP_FILES} ${tagname}.WHATSNEW.txt" + + return 0 +} + +check_nopatch() { + check_args "${FUNCNAME}" "$#" "0" || return 1 + require_tagname "${FUNCNAME}" + + git tag -v "${tagname}" || { + echo "failed to verify tag[${tagname}]" + return 1 + } + + test -f "${tagname}.tar.gz" || { + echo "${tagname}.tar.gz does not exist" + return 1 + } + + test -f "${tagname}.tar.asc" || { + echo "${tagname}.tar.asc does not exist" + return 1 + } + + ls -la ${tagname}.* + + return 0 +} + +check_release() { + check_args "${FUNCNAME}" "$#" "0" || return 1 + + test -n "${check_fn}" || { + echo "check_fn variable empty" + return 1 + } + + echo "Running ${check_fn}" + ${check_fn} +} + +push_release() { + check_args "${FUNCNAME}" "$#" "0" || return 1 + require_tagname "${FUNCNAME}" + + echo "Push git tag ${tagname} to '${repo_url}'" + git push "${repo_url}" "refs/tags/${tagname}:refs/tags/${tagname}" || { + return 1 + } + + return 0 +} + +upload_release() { + check_args "${FUNCNAME}" "$#" "0" || return 1 + require_tagname "${FUNCNAME}" + + echo "Upload ${tagname}.* to '${upload_url}'" + rsync -Pav ${tagname}.* "${upload_url}/" || { + return 1 + } + rsync ${upload_url}/${tagname}.* + + return 0 +} + +announce_samba_rc() { + check_args "${FUNCNAME}" "$#" "0" || return 1 + require_tagname "${FUNCNAME}" + + test -f "${tagname}.WHATSNEW.txt" || { + echo "${tagname}.WHATSNEW.txt does not exist" + return 1 + } + + local t="" + local utcdate=$(date --utc +"%d %B %Y") + local utctime=$(date --utc +"%Y%m%d-%H%M%S") + local version=$(echo "${tagname}" | sed -e 's!^samba-!!') + local href="#${version}" + local series=$(echo "${version}" | cut -d '.' -f1-2) + local rc=$(echo "${version}" | sed -e 's!.*rc\([0-9][0-9]*\)!\1!') + local rcname="${rc}th" + case "${rc}" in + 1) + rcname="first" + ;; + 2) + rcname="second" + ;; + 3) + rcname="third" + ;; + 4) + rcname="fourth" + ;; + 5) + rcname="fifth" + ;; + esac + + { + echo "samba-announce@lists.samba.org, samba@lists.samba.org, samba-technical@lists.samba.org" + } > announce.${tagname}.to.txt + CLEANUP_FILES="${CLEANUP_FILES} announce.${tagname}.to.txt" + + { + echo "[Announce] Samba ${version} Available for Download" + } > announce.${tagname}.subject.txt + CLEANUP_FILES="${CLEANUP_FILES} announce.${tagname}.subject.txt" + + { + cat ${tagname}.WHATSNEW.txt + echo "" + echo "================" + echo "Download Details" + echo "================" + echo "" + echo "The uncompressed tarballs and patch files have been signed" + echo "using GnuPG (ID 6568B7EA). The source code can be downloaded" + echo "from:" + echo "" + echo " ${download_url}" + echo "" + echo "The release notes are available online at:" + echo "" + echo " ${download_url}${tagname}.WHATSNEW.txt" + echo "" + echo "Our Code, Our Bugs, Our Responsibility." + echo "(https://bugzilla.samba.org/)" + echo "" + echo " --Enjoy" + echo " The Samba Team" + } > announce.${tagname}.mail.txt + CLEANUP_FILES="${CLEANUP_FILES} announce.${tagname}.mail.txt" + + { + echo -n "-i announce.${tagname}.mail.txt " + echo -n "-s \"$(cat announce.${tagname}.subject.txt | xargs)\" " + echo -n "$(cat announce.${tagname}.to.txt | xargs)" + } > announce.${tagname}.mutt-arguments.txt + CLEANUP_FILES="${CLEANUP_FILES} announce.${tagname}.mutt-arguments.txt" + + local headlinefile="${utctime}.${version}.headline.html" + { + echo "<!-- BEGIN: posted_news/${headlinefile} -->" + echo "<li> ${utcdate} <a href=\"${href}\">Samba ${version} Available for Download</a></li>" + echo "<!-- END: posted_news/${headlinefile} -->" + } > ${headlinefile} + CLEANUP_FILES="${CLEANUP_FILES} ${headlinefile}" + + local bodyfile="${utctime}.${version}.body.html" + { + echo "<!-- BEGIN: posted_news/${bodyfile} -->" + echo "<h5><a name=\"${version}\">${utcdate}</a></h5>" + echo "<p class="headline">Samba ${version} Available for Download</p>" + echo "<p>" + echo "This is the ${rcname} release candidate of the upcoming Samba ${series} release series." + echo "</p>" + echo "<p>" + echo "The uncompressed tarball has been signed using GnuPG (ID ${GPG_KEYID})." + echo "The source code can be <a href=\"${download_url}${tagname}.tar.gz\">downloaded now</a>." + echo "See <a href=\"${download_url}${tagname}.WHATSNEW.txt\">the release notes for more info</a>." + echo "</p>" + echo "<!-- END: posted_news/${bodyfile} -->" + echo "" + } > ${bodyfile} + CLEANUP_FILES="${CLEANUP_FILES} ${bodyfile}" + + { + ls -lart announce.${tagname}.* ${headlinefile} ${bodyfile} + echo "" + echo "NOTICE:" + echo "You need to do the following manual steps in order" + echo "to finish the announcement of ${tagname}!" + echo "" + echo "Copy the following files into the posted_news/" + echo "subdirectory of the samba-web.git repository and commit them:" + echo " ${headlinefile}" + echo " ${bodyfile}" + echo "" + echo " cp -a ${utctime}.${version}.*.html /path/to/samba-web/posted_news/" + echo " pushd /path/to/samba-web" + echo " git add posted_news/${utctime}.${version}.*.html" + echo " git commit --signoff --message \"NEWS[${version}]: Samba ${version} Available for Download\"" + echo " git show -p --stat HEAD" + echo " git push ..." + echo " popd" + echo "" + echo "Once the resulting commit is pushed a cron job will update " + echo "the content exported by the webserver every 5mins." + echo "" + echo "If the web content is updated, you need to send the announce mail (gpg signed)." + echo "- announce.${tagname}.to.txt contains the mail's recipients for the To: header." + echo "- announce.${tagname}.subject.txt contains the mail's subject line." + echo "- announce.${tagname}.mail.txt contains the content of the mail body." + echo "In case your're using mutt, you can use the following shortcut:" + echo " eval mutt \$(cat announce.${tagname}.mutt-arguments.txt)" + echo "" + echo "NOTICE: you're not done yet! Read the above instructions carefully!" + echo "See: announce.${tagname}.todo.txt" + echo "" + } > announce.${tagname}.todo.txt + CLEANUP_FILES="${CLEANUP_FILES} announce.${tagname}.todo.txt" + + cat announce.${tagname}.todo.txt + + return 0 +} + +announce_release() { + check_args "${FUNCNAME}" "$#" "0" || return 1 + + test -n "${announce_fn}" || { + echo "announce_fn variable empty" + return 1 + } + + echo "Running ${announce_fn}" + ${announce_fn} +} + +case "${product}" in +talloc | tdb | tevent | ldb) + test -z "${GPG_USER-}" && { + GPG_USER='Samba Library Distribution Key <samba-bugs@samba.org>' + } + + test -z "${GPG_KEYID-}" && { + GPG_KEYID='13084025' + } + + productbase="${product}" + srcdir="lib/${product}" + repo_url="${CONF_REPO_URL}" + upload_url="${CONF_UPLOAD_URL}/${product}/" + download_url="${CONF_DOWNLOAD_URL}/${product}/" + + check_fn="check_nopatch" + fullcmds="create check push upload" + ;; +samba-rc) + test -z "${GPG_USER-}" && { + GPG_USER='Samba Distribution Verification Key <samba-bugs@samba.org>' + } + + test -z "${GPG_KEYID-}" && { + GPG_KEYID='6568B7EA' + } + + productbase="samba" + srcdir="." + repo_url="${CONF_REPO_URL}" + upload_url="${CONF_UPLOAD_URL}/samba/rc/" + download_url="${CONF_DOWNLOAD_URL}/samba/rc/" + + verify_fn="verify_samba_rc" + check_fn="check_nopatch" + announce_fn="announce_samba_rc" + fullcmds="verify create check whatsnew push upload announce" + ;; +TODO-samba-stable) + test -z "${GPG_USER-}" && { + GPG_USER='Samba Distribution Verification Key <samba-bugs@samba.org>' + } + + test -z "${GPG_KEYID-}" && { + GPG_KEYID='6568B7EA' + } + + productbase="samba" + srcdir="." + repo_url="${CONF_REPO_URL}" + upload_url="${CONF_UPLOAD_URL}/samba/stable/" + download_url="${CONF_DOWNLOAD_URL}/samba/stable/" + + verify_fn="verify_samba_stable" + check_fn="check_withpatch" + announce_fn="announce_samba_stable" + fullcmds="verify create patch check push upload announce" + ;; +TODO-samba-security) + test -z "${GPG_USER-}" && { + GPG_USER='Samba Distribution Verification Key <samba-bugs@samba.org>' + } + + test -z "${GPG_KEYID-}" && { + GPG_KEYID='6568B7EA' + } + + productbase="samba" + srcdir="." + repo_url="${CONF_REPO_URL}" + upload_url="${CONF_UPLOAD_URL}/samba/stable/" + download_url="${CONF_DOWNLOAD_URL}/samba/stable/" + + verify_fn="verify_samba_stable" + check_fn="check_samba_stable" + announce_fn="announce_samba_security" + fullcmds="verify create patch check" + next_cmd="push" + ;; +*) + usage + echo "Unknown product ${product}" + exit 1 +esac + +pushd ${srcdir} || { + echo "srcdir[${srcdir}] does not exist" + exit 1 +} + +trap_handler() { + echo "" + echo "ERROR: cleaning up" + echo "" + + for t in ${CLEANUP_TAGS}; do + echo "Removing tag[${t}]" + git tag -v "${t}" && { + git tag -d "${t}" || { + echo "failed to remove tag ${t}" + } + } + done + + for f in ${CLEANUP_FILES}; do + echo "Removing file[${f}]" + test -f "${f}" && { + rm "${f}" || { + echo "failed to remove ${f}" + } + } + done +} + +CLEANUP_TAGS="" +CLEANUP_FILES="" +trap trap_handler INT QUIT TERM EXIT + +cmd_allowed "${globalcmd}" fullrelease ${fullcmds} || { + usage + echo "command[${globalcmd}] not supported for product[${product}]" + exit 1 +} + +case "${globalcmd}" in +fullrelease) + check_args "${globalcmd}" "$#" "0" || exit 1 + cmds="${fullcmds}" + ;; +create) + check_args "${globalcmd}" "$#" "0" || exit 1 + check_args "create" "$#" "0" || exit 1 + + cmds="" + cmd_allowed "verify" ${fullcmds} && { + cmds="${cmds} verify" + } + cmds="${cmds} create" + cmd_allowed "whatsnew" ${fullcmds} && { + cmds="${cmds} whatsnew" + } + cmd_allowed "patch" ${fullcmds} && { + cmds="${cmds} patch" + } + cmds="${cmds} check" + next_cmd="push" + ;; +push) + check_args "${globalcmd}" "$#" "1" || exit 1 + tagname="$1" + cmds="check push" + next_cmd="upload" + ;; +upload) + check_args "${globalcmd}" "$#" "1" || exit 1 + tagname="$1" + cmds="check upload" + cmd_allowed "symlinks" ${fullcmds} && { + cmds="${cmds} symlinks" + } + cmd_allowed "announce" ${fullcmds} && { + next_cmd="announce" + } + ;; +announce) + check_args "${globalcmd}" "$#" "1" || exit 1 + tagname="$1" + cmds="check announce" + ;; +*) + usage + echo "Unknown command ${globalcmd}" + exit 1 + ;; +esac + +for cmd in ${cmds}; do + echo "Starting subcommand[${cmd}]" + ${cmd}_release || { + echo "Failed subcommand[${cmd}]" + exit 1 + } + echo "Finished subcommand[${cmd}]" +done + +test -n "${next_cmd}" && { + echo "Continue with '$0 ${product} ${next_cmd} ${tagname}'." +} + +trap - INT QUIT TERM EXIT + +exit 0 |