2025-02-16 12:16:19 +01:00
|
|
|
#!/bin/bash
|
|
|
|
|
|
|
|
usage() {
|
2025-02-16 12:16:55 +01:00
|
|
|
echo "Usage: release.sh [-d] VERSION"
|
2025-02-16 12:16:19 +01:00
|
|
|
echo ""
|
|
|
|
echo "The script does all necessary steps to create a new release."
|
|
|
|
echo ""
|
2025-02-16 12:16:55 +01:00
|
|
|
echo " -d: no documentation update"
|
2025-02-16 12:27:38 +01:00
|
|
|
echo " -f: disable all sanity checks and just do the release"
|
|
|
|
echo " -l: do not update library dependency"
|
2025-02-16 12:16:55 +01:00
|
|
|
echo ""
|
2025-02-16 12:16:19 +01:00
|
|
|
echo "Note: The version number needs to be exactly"
|
2025-02-16 12:16:55 +01:00
|
|
|
echo " '^v[\d]+.[\d]+(.[\d\]+(-rc[0-9]+)?$'"
|
2025-02-16 12:16:19 +01:00
|
|
|
echo ""
|
|
|
|
echo "example:"
|
2025-02-16 12:16:55 +01:00
|
|
|
echo " release.sh v2.1-rc0 # v2.1 release candidate 0"
|
|
|
|
echo " release.sh v2.1 # v2.1 release"
|
2025-02-16 12:16:19 +01:00
|
|
|
}
|
|
|
|
|
2025-02-16 12:16:55 +01:00
|
|
|
build_doc=true
|
2025-02-16 12:27:38 +01:00
|
|
|
update_lib_dep=true
|
|
|
|
force=false
|
2025-02-16 12:16:55 +01:00
|
|
|
|
2025-02-16 12:27:38 +01:00
|
|
|
while getopts "dfl" o; do
|
2025-02-16 12:16:55 +01:00
|
|
|
case "${o}" in
|
|
|
|
d)
|
|
|
|
build_doc=false
|
|
|
|
;;
|
2025-02-16 12:27:38 +01:00
|
|
|
f)
|
|
|
|
force=true
|
|
|
|
;;
|
|
|
|
l)
|
|
|
|
update_lib_dep=false
|
2025-02-16 12:20:48 +01:00
|
|
|
;;
|
2025-02-16 12:16:55 +01:00
|
|
|
*)
|
|
|
|
usage
|
|
|
|
;;
|
|
|
|
esac
|
|
|
|
done
|
|
|
|
shift $((OPTIND-1))
|
|
|
|
|
|
|
|
VERSION=${1:-}
|
2025-02-16 12:16:19 +01:00
|
|
|
|
|
|
|
if [ -z "$VERSION" ] ; then
|
|
|
|
usage
|
|
|
|
exit 1
|
|
|
|
fi
|
|
|
|
|
2025-02-16 12:27:38 +01:00
|
|
|
cleanup() {
|
|
|
|
if [ -z "${OLD_HEAD}" ] ; then
|
|
|
|
exit
|
|
|
|
fi
|
|
|
|
git tag -d "Release $VERSION" "$VERSION"
|
|
|
|
git reset --hard "${OLD_HEAD}"
|
|
|
|
}
|
|
|
|
|
|
|
|
register_cleanup() {
|
|
|
|
OLD_HEAD="$(git rev-parse HEAD)"
|
|
|
|
}
|
|
|
|
|
|
|
|
unregister_cleanup() {
|
|
|
|
OLD_HEAD=""
|
|
|
|
}
|
|
|
|
|
|
|
|
trap cleanup EXIT
|
|
|
|
|
|
|
|
register_cleanup
|
|
|
|
|
2025-02-16 12:20:48 +01:00
|
|
|
# expected version regex
|
2025-02-16 12:16:55 +01:00
|
|
|
re='^v([0-9]+\.[0-9]+(\.[0-9]+)?)(-rc[0-9]+)?$'
|
2025-02-16 12:20:48 +01:00
|
|
|
|
2025-02-16 12:24:13 +01:00
|
|
|
# use the version string provided from the command line
|
2025-02-16 12:20:48 +01:00
|
|
|
if [[ "$VERSION" =~ ${re} ]]; then
|
2025-02-16 12:24:13 +01:00
|
|
|
echo "valid version $VERSION string"
|
2025-02-16 12:20:48 +01:00
|
|
|
|
2025-02-16 12:16:55 +01:00
|
|
|
# remove the leading 'v'
|
2025-02-16 12:20:48 +01:00
|
|
|
ver="${VERSION#v}"
|
2025-02-16 12:16:19 +01:00
|
|
|
else
|
2025-02-16 12:24:13 +01:00
|
|
|
echo "invalid version string $VERSION"
|
2025-02-16 12:16:19 +01:00
|
|
|
exit 1
|
|
|
|
fi
|
|
|
|
|
2025-02-16 12:24:13 +01:00
|
|
|
cd "$(git rev-parse --show-toplevel)" || exit 1
|
2025-02-16 12:20:48 +01:00
|
|
|
|
2025-02-16 12:27:38 +01:00
|
|
|
if [ "$update_lib_dep" = true ] && [[ -f subprojects/libnvme.wrap ]]; then
|
2025-02-16 12:24:13 +01:00
|
|
|
git -C subprojects/libnvme fetch --all
|
|
|
|
|
2025-02-16 12:25:41 +01:00
|
|
|
# extract the version string from libnvme by using the ref
|
2025-02-16 12:24:13 +01:00
|
|
|
# defined in libnvme.wrap.
|
|
|
|
libnvme_ref=$(sed -n "s/revision = \([0-9a-z]\+\)/\1/p" subprojects/libnvme.wrap)
|
|
|
|
libnvme_VERSION=$(git -C subprojects/libnvme describe "${libnvme_ref}")
|
|
|
|
if [[ "${libnvme_VERSION}" =~ ${re} ]]; then
|
|
|
|
echo "libnvme: valid version ${libnvme_VERSION} string"
|
|
|
|
|
|
|
|
# remove the leading 'v'
|
|
|
|
libnvme_ver="${libnvme_VERSION#v}"
|
|
|
|
else
|
|
|
|
echo "libnvme: invalid version string ${libnvme_VERSION}"
|
|
|
|
exit 1
|
|
|
|
fi
|
2025-02-16 12:16:19 +01:00
|
|
|
fi
|
|
|
|
|
2025-02-16 12:27:38 +01:00
|
|
|
if [ "$force" = false ] ; then
|
|
|
|
if [[ -n $(git status -s) ]]; then
|
|
|
|
echo "tree is dirty."
|
|
|
|
if [[ "${dry_run}" = false ]]; then
|
|
|
|
exit 1
|
|
|
|
fi
|
2025-02-16 12:20:48 +01:00
|
|
|
fi
|
|
|
|
|
2025-02-16 12:27:38 +01:00
|
|
|
if [ "$(git rev-parse --abbrev-ref HEAD)" != "master" ] ; then
|
|
|
|
echo "currently not on master branch. abort."
|
|
|
|
exit 1
|
|
|
|
fi
|
2025-02-16 12:16:19 +01:00
|
|
|
fi
|
|
|
|
|
|
|
|
# update all docs
|
|
|
|
doc_dir=""
|
|
|
|
if [ -d "Documentation" ]; then
|
|
|
|
doc_dir="Documentation"
|
|
|
|
elif [ -d "doc" ]; then
|
|
|
|
doc_dir="doc"
|
|
|
|
else
|
2025-02-16 12:25:41 +01:00
|
|
|
echo "documentation directory not found"
|
2025-02-16 12:16:19 +01:00
|
|
|
exit 1
|
|
|
|
fi
|
|
|
|
|
2025-02-16 12:16:55 +01:00
|
|
|
if [ "$build_doc" = true ]; then
|
|
|
|
# update documentation
|
2025-02-16 12:24:13 +01:00
|
|
|
./scripts/update-docs.sh
|
2025-02-16 12:27:38 +01:00
|
|
|
git add $doc_dir
|
|
|
|
git commit -s -m "doc: Regenerate all docs for $VERSION"
|
2025-02-16 12:20:48 +01:00
|
|
|
fi
|
|
|
|
|
2025-02-16 12:27:38 +01:00
|
|
|
# update meson.build
|
|
|
|
sed -i -e "0,/[ \t]version: /s/\([ \t]version: \).*/\1\'$ver\',/" meson.build
|
|
|
|
if [[ -n "$libnvme_VERSION" ]] && [[ -f subprojects/libnvme.wrap ]]; then
|
|
|
|
sed -i -e "s/\(dependency('libnvme', version: '>=\)\([\.1-9]\+\)/\1$libnvme_ver/" meson.build
|
2025-02-16 12:16:19 +01:00
|
|
|
fi
|
|
|
|
|
2025-02-16 12:27:38 +01:00
|
|
|
git add meson.build
|
|
|
|
git commit -s -m "Release $VERSION"
|
|
|
|
|
2025-02-16 12:16:19 +01:00
|
|
|
git tag -s -m "Release $VERSION" "$VERSION"
|
|
|
|
git push --dry-run origin "$VERSION"^{}:master tag "$VERSION"
|
|
|
|
|
|
|
|
read -p "All good? Ready to push changes to remote? [Yy]" -n 1 -r
|
|
|
|
echo
|
|
|
|
if [[ $REPLY =~ ^[Yy]$ ]]; then
|
|
|
|
git push origin "$VERSION"^{}:master tag "$VERSION"
|
2025-02-16 12:27:38 +01:00
|
|
|
unregister_cleanup
|
2025-02-16 12:16:19 +01:00
|
|
|
fi
|