Release Helper Scripts (#3299)
* Update and fix the version of the debian release * Create proper initial status * Create release helper script * [add] Versioning Readmeupstream-master
Ulrich Huber
5 years ago
committed by
GitHub
parent
3a77573cb6
commit
3742b7d1bb
7 changed files with 685 additions and 5 deletions
@ -0,0 +1,87 @@ |
||||
# Versioning |
||||
|
||||
Every release of Xournal++ is tagged with a unique incrementing version. In the history of the project, two changes to the versioning scheme happened. Be careful when trying to automatically parse older versions. |
||||
The current versioning scheme adheres to the rules of [Debian upstream_version](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-version). |
||||
|
||||
## Main Version |
||||
|
||||
We follow the common versioning scheme of major, minor and patch versions in this order, separated by dots. |
||||
|
||||
The version string therefore has the following format: |
||||
|
||||
``` |
||||
[0-9]+\.[0-9]+\.[0-9]+ |
||||
``` |
||||
|
||||
We do NOT adhere to semantic versioning, as it is primarily meant for libraries and is more confusing to normal users than it is helpful. |
||||
To help you understand when we use what version increment, use these rules: |
||||
|
||||
- A major version bump happens when we introduce a change with a very high impact to many users. For example a major redesign of the GUI or the introduction of a new file format as the default format. |
||||
- A minor version bump happens whenever we introduce new features |
||||
- A patch version bump happens whenever we introduce fixes to already implemented features. This may include minor changes to existing features as well. |
||||
|
||||
Whenever a bump of the major version happens, minor and patch versions are reset to `0`. Equally the patch version is reset to `0` when the minor version is bumped. |
||||
|
||||
## Version Suffix |
||||
|
||||
The main version string may be followed by a suffix. This suffix is used to describe unreleased versions and hotfixes. |
||||
|
||||
The suffix may only start with one of the two characters `+` or `~`. These characters hold special meaning: |
||||
|
||||
- `+` denotes a version that is based on top of the main version (is newer) |
||||
- `~` denotes a version that predates the main version (is older) |
||||
|
||||
The suffix may only contain alphanumerics, `+`, `~`, `-` and `.`. |
||||
|
||||
We mainly use suffixes to specify development versions. Our main development branch (`master`) has a permanent suffix `+dev` and as main version the last released version of Xournal++. This specifies that the current commit of the main development branch is based on the last release of Xournal++, but may contain any number of changes. |
||||
|
||||
When we start our release process, we branch off a release branch. At this point of time it is clear what changes we include in the release and we can use the above rules to determine the correct version. From this point on we will change the main version string to this new version and use the suffix `~dev`. This describes our intent of working towards this release. |
||||
|
||||
# Branching Strategy |
||||
|
||||
Our branching model knows five types of branches: |
||||
|
||||
- The main development branch (`master`) used for merging feature branches and hosting the newest state of Xournal++. |
||||
- Release branches (`release-*`) exist for preparing a release. This type of branches is branched off from the main development branch and will from that point on only receive bug fixes for the current version of this branch. Only the patch level may be bumped on such branches. When the release is ready, it is tagged on this branch and then merged back to the main development branch. |
||||
- Hotfix branches (`hotfix-*`) originate from the tagged commit of a released version and facilitate the development of a hotfix. When the hotfix is ready for release, it will be tagged and merged back into the main development branch. |
||||
- Feature branches (`feature-*`) are commonly used for Pull Requests with new features. Such branches are always merged into the main development branch. |
||||
- Bugfix branches (`bugfix-*`) are used for Pull Requests with a bugfix for a maintained release or the current development version. Depending on their target they must be merged into the appropriate branch. |
||||
|
||||
# Helper Script |
||||
|
||||
To help with the task of versioning, we provide a helper script, that does most of the work for you. You can find the script at `scripts/release_helper.sh`. |
||||
|
||||
## Preparing a new minor/major release |
||||
The starting point of a new minor/major release is always the main development branch. You may use `release_helper.sh prepare <version>` to prepare the release. `<version>` Shall be replaced with the appropriate version. Be aware that the patch version must be `0`. |
||||
|
||||
The script will: |
||||
|
||||
1. Create a release branch |
||||
2. Check the new branch out |
||||
3. Apply the supplied version to all relevant files suffixed by `~dev`. |
||||
|
||||
Whatever version suffix you choose, will be appended by `~dev` to signify that this is not yet the release version but development progresses towards this release. |
||||
|
||||
## Preparing a hotfix |
||||
The starting point of a hotfix release is the tagged commit of the release this hotfix is based upon. You must check out this release and then call `release_helper.sh prepare <version><+suffix>` where the version equals the currently checked out version and the chosen suffix. The suffix must start with a `+` as only hotfixes based on top of this version are allowed. |
||||
|
||||
The script will: |
||||
|
||||
1. Create a hotfix branch |
||||
2. Check the new branch out |
||||
3. Apply the supplied version to all relevant files suffixed by `~dev`. |
||||
|
||||
## Publishing a release |
||||
Publishing a release can only happen on a release branch or a hotfix branch. It can be triggered by `release_helper.sh publish` and will initiate the process of publishing the release. |
||||
|
||||
The script will: |
||||
|
||||
1. Remove the `~dev` suffix (and leave any other suffix supplied by the user) |
||||
2. Update the changelogs to signify the release of this version |
||||
3. Tag the release |
||||
4. Proposal to merge the release back to the main development branch |
||||
|
||||
During the merge it is imperative that the instructions of the script are followed stringently to not confuse our versioning scheme. |
||||
|
||||
|
||||
|
||||
@ -0,0 +1,588 @@ |
||||
#!/bin/bash |
||||
|
||||
# Get the path of the script |
||||
SCRIPT_PATH=$(dirname "$(realpath -s "$0")") |
||||
|
||||
# Parse current version string |
||||
function current_major_version() { |
||||
sed -n 's/^set (CPACK_PACKAGE_VERSION_MAJOR "\([0-9]\+\)")/\1/p' "${SCRIPT_PATH}/../CMakeLists.txt" |
||||
} |
||||
|
||||
function current_minor_version() { |
||||
sed -n 's/^set (CPACK_PACKAGE_VERSION_MINOR "\([0-9]\+\)")/\1/p' "${SCRIPT_PATH}/../CMakeLists.txt" |
||||
} |
||||
|
||||
function current_patch_version() { |
||||
sed -n 's/^set (CPACK_PACKAGE_VERSION_PATCH "\([0-9]\+\)")/\1/p' "${SCRIPT_PATH}/../CMakeLists.txt" |
||||
} |
||||
|
||||
function current_suffix_version() { |
||||
sed -n 's/^set (VERSION_SUFFIX "\([+~][^\"]*\)")/\1/p' "${SCRIPT_PATH}/../CMakeLists.txt" |
||||
} |
||||
|
||||
function current_version() { |
||||
echo $(current_major_version).$(current_minor_version).$(current_patch_version)$(current_suffix_version) |
||||
} |
||||
|
||||
function parse_major_version() { |
||||
echo $1 | sed -n 's/^\([0-9]\+\)\..*$/\1/p' |
||||
} |
||||
|
||||
function parse_minor_version() { |
||||
echo $1 | sed -n 's/^[0-9]\+\.\([0-9]\+\)\..*$/\1/p' |
||||
} |
||||
|
||||
function parse_patch_version() { |
||||
echo $1 | sed -n 's/^[0-9]\+\.[0-9]\+\.\([0-9]\+\).*$/\1/p' |
||||
} |
||||
|
||||
function parse_suffix_version() { |
||||
echo $1 | sed -n 's/^[0-9]\+\.[0-9]\+\.[0-9]\+\([+~].*\)$/\1/p' |
||||
} |
||||
|
||||
# Compares two versions $1 and $2 |
||||
# If $2 is greater it returns 0 |
||||
function compare_versions() { |
||||
if [[ $1 == $2 ]]; then |
||||
return 1 |
||||
fi |
||||
if printf "%s\n%s" "$1" "$2" | LC_ALL=C sort -CVu; then |
||||
return 0 |
||||
fi |
||||
return 1 |
||||
} |
||||
|
||||
# Validates the provided version string |
||||
# $1 the version as a string |
||||
# Returns 1 if the version is valid |
||||
function validate_version() { |
||||
if ! [[ $1 =~ ^[0-9]+\.[0-9]+\.[0-9]+([+~][A-Za-z0-9+~\.-]*)*?$ ]]; then |
||||
return 1 |
||||
else |
||||
if [[ $1 =~ ~dev$ ]]; then |
||||
return 0 |
||||
fi |
||||
return 1 |
||||
fi |
||||
} |
||||
|
||||
# Print information about the correct format of a version string |
||||
function print_version_help() { |
||||
echo "Please supply the version of the release in the format [0-9]+.[0-9]+.[0-9]+([+~][0-9A-Za-z+~.-]*)*" |
||||
echo "The suffix is optional, starts with a '+' or '~' and may only contain alphanumeric characters and '+', '~', '.' and '-'." |
||||
echo "Within the suffix '+' is evaluated as a higher release and '~' as a lower release than the basic version number." |
||||
} |
||||
|
||||
# Abort execution |
||||
# $1 The exit code |
||||
# $2 The message to print before abort |
||||
function abort() { |
||||
echo "ABORT: $2" |
||||
exit $1 |
||||
} |
||||
|
||||
# Check if branch already exists |
||||
# $1 The name of the branch |
||||
# If it exists returns 0 |
||||
function branch_exists() { |
||||
if git rev-parse --quiet --verify $1 > /dev/null; then |
||||
return 0 |
||||
fi |
||||
return 1 |
||||
} |
||||
|
||||
# Check if release already exists |
||||
# $1 The version string of the release |
||||
# If it exists returns 0 |
||||
function release_exists() { |
||||
if git tag | grep -Fxq "v$1"; then |
||||
return 0 |
||||
fi |
||||
return 1 |
||||
} |
||||
|
||||
# Check if git is in detached head mode |
||||
# If yes returns 1 |
||||
function is_detached() { |
||||
if git status --branch --porcelain | grep -Fxq "## HEAD (no branch)"; then |
||||
return 0 |
||||
fi |
||||
return 1 |
||||
} |
||||
|
||||
# Bumps the version in all relevant places |
||||
# Should the prior version be the same version but with an added ~dev this version is replaced |
||||
# $1 The version string |
||||
# $2 Whether to replace the current version |
||||
function bump_version() { |
||||
local prior_version=$(current_version) |
||||
local replace=$2 |
||||
|
||||
if ! [[ "$1" =~ ~dev|\+dev$ ]]; then |
||||
local publish=1 |
||||
else |
||||
local publish=0 |
||||
fi |
||||
|
||||
# Update version in the CMakeLists.txt |
||||
sed -i "s/set (CPACK_PACKAGE_VERSION_MAJOR \"[0-9]\+\")/set (CPACK_PACKAGE_VERSION_MAJOR \"$(parse_major_version $1)\")/g" "${SCRIPT_PATH}/../CMakeLists.txt" |
||||
sed -i "s/set (CPACK_PACKAGE_VERSION_MINOR \"[0-9]\+\")/set (CPACK_PACKAGE_VERSION_MINOR \"$(parse_minor_version $1)\")/g" "${SCRIPT_PATH}/../CMakeLists.txt" |
||||
sed -i "s/set (CPACK_PACKAGE_VERSION_PATCH \"[0-9]\+\")/set (CPACK_PACKAGE_VERSION_PATCH \"$(parse_patch_version $1)\")/g" "${SCRIPT_PATH}/../CMakeLists.txt" |
||||
sed -i "s/set (VERSION_SUFFIX \"[^\"]*\")/set (VERSION_SUFFIX \"$(parse_suffix_version $1)\")/g" "${SCRIPT_PATH}/../CMakeLists.txt" |
||||
|
||||
# From now on current_*_version functions return the new version |
||||
|
||||
# Update Changelog |
||||
if [ $replace -eq 0 ]; then |
||||
sed -i "N;N;s/# Changelog\n\n/# Changelog\n\n## $(current_version) (Unreleased)\n\n/g" "${SCRIPT_PATH}/../CHANGELOG.md" |
||||
else |
||||
if [ $publish -eq 0 ]; then |
||||
sed -i "s/## ${prior_version} (Unreleased)/## $(current_version) (Unreleased)/g" "${SCRIPT_PATH}/../CHANGELOG.md" |
||||
else |
||||
sed -i "s/## ${prior_version} (Unreleased)/## $(current_version)/g" "${SCRIPT_PATH}/../CHANGELOG.md" |
||||
fi |
||||
fi |
||||
|
||||
# Update Debian Changelog |
||||
local git_user=$(git config --get user.name) |
||||
if [ $? -ne 0 ]; then |
||||
abort 2 "Could not read current git user - Please set with 'git config --set user.name <name>'" |
||||
fi |
||||
local git_mail=$(git config --get user.email) |
||||
if [ $? -ne 0 ]; then |
||||
abort 2 "Could not read current git user email - Please set with 'git config --set user.email <email>'" |
||||
fi |
||||
local date=$(date --rfc-2822) |
||||
|
||||
if [ $replace -eq 0 ]; then |
||||
sed -i "1i xournalpp ($(current_version)-1) UNRELEASED; urgency=medium\n\n * \n\n -- ${git_user} <${git_mail}> ${date}\n" "${SCRIPT_PATH}/../debian/changelog" |
||||
else |
||||
if [ $publish -eq 0 ]; then |
||||
sed -i "s/xournalpp (${prior_version}-1) UNRELEASED; urgency=medium/xournalpp ($(current_version)-1) UNRELEASED; urgency=medium/g" "${SCRIPT_PATH}/../debian/changelog" |
||||
sed -i "/xournalpp ($(current_version)-1)/,/xournalpp/s/ --.*/ -- ${git_user} <${git_mail}> ${date}/g" "${SCRIPT_PATH}/../debian/changelog" |
||||
else |
||||
sed -i "s/xournalpp (${prior_version}-1) UNRELEASED; urgency=medium/xournalpp ($(current_version)-1) unstable; urgency=medium/g" "${SCRIPT_PATH}/../debian/changelog" |
||||
sed -i "/xournalpp ($(current_version)-1)/,/xournalpp/s/ --.*/ -- ${git_user} <${git_mail}> ${date}/g" "${SCRIPT_PATH}/../debian/changelog" |
||||
fi |
||||
fi |
||||
|
||||
# Update Appdata |
||||
local date=$(date +%Y-%m-%d) |
||||
|
||||
if [ $replace -eq 0 ]; then |
||||
sed -i "1,/^ <release .*$/ {/^ <release .*$/i\ |
||||
\ \ \ \ <release date=\"$date\" version=\"$(current_version)\" /> |
||||
}" "${SCRIPT_PATH}/../desktop/com.github.xournalpp.xournalpp.appdata.xml" |
||||
else |
||||
sed -i "s/\ \ \ \ <release date=\".*\" version=\"${prior_version}\" \/>/\ \ \ \ <release date=\"$date\" version=\"$(current_version)\" \/>/g" "${SCRIPT_PATH}/../desktop/com.github.xournalpp.xournalpp.appdata.xml" |
||||
fi |
||||
} |
||||
|
||||
# Prepares a new version |
||||
# A new version differs in the major or minor version part from the last. |
||||
# Assumes it is on the main development branch |
||||
# $1 The version string for the new version |
||||
function prepare_new_version() { |
||||
if [[ $(parse_patch_version $1) -ne 0 ]]; then |
||||
abort 6 "The patch level must be '0'." |
||||
fi |
||||
|
||||
# Check for a valid modification of the version strings |
||||
if ! compare_versions "$(current_version)" "$1"; then |
||||
abort 7 "The provided version is not higher than the current one." |
||||
print_version_help |
||||
fi |
||||
|
||||
# Create release branch |
||||
local branch_name="release-$(parse_major_version $1).$(parse_minor_version $1)" |
||||
|
||||
# Checkout release branch |
||||
git checkout --quiet -b $branch_name |
||||
if [ $? -ne 0 ]; then |
||||
abort 11 "Could not check out new release branch" |
||||
fi |
||||
|
||||
# Bump version of release branch |
||||
local new_version="$(echo $1|sed 's/+dev$//g')~dev" |
||||
bump_version $new_version 1 |
||||
if [ $? -ne 0 ]; then |
||||
abort 9 "Could not bump version of release branch" |
||||
fi |
||||
|
||||
# Commit version bump |
||||
git commit --quiet -a -m "Automated version bump to $new_version" |
||||
if [ $? -ne 0 ]; then |
||||
abort 10 "Could not commit version bump on release branch" |
||||
fi |
||||
|
||||
echo "SUCCESS: New release $new_version was successfully prepared" |
||||
echo "You are now on the release branch ($branch_name)." |
||||
echo "Please check the last commit on the current branch and master for consistency" |
||||
echo "and push your changes with:" |
||||
echo "" |
||||
echo " git push origin master $branch_name" |
||||
echo "" |
||||
echo "Should the commit not meet your expectations, you may amend the changes." |
||||
echo "BUT do not modify the version numbers!" |
||||
} |
||||
|
||||
# Prepares a hotfix |
||||
# A hotfix may only differ in the version suffix from its base release |
||||
# Assumes it is on the commit of the release |
||||
# $1 The version string for the hotfix |
||||
function prepare_hotfix() { |
||||
# Check for a valid modification of the version strings |
||||
if [[ $(parse_major_version $1) -ne $(current_major_version) ]]; then |
||||
abort 6 "The major version may not differ from the base release for a hotfix." |
||||
fi |
||||
if [[ $(parse_minor_version $1) -ne $(current_minor_version) ]]; then |
||||
abort 6 "The minor version may not differ from the base release for a hotfix." |
||||
fi |
||||
if [[ $(parse_patch_version $1) -ne $(current_patch_version) ]]; then |
||||
abort 6 "The patch version may not differ from the base release for a hotfix." |
||||
fi |
||||
|
||||
if ! compare_versions $(current_version) $1; then |
||||
abort 7 "The provided version is not higher than the release it is based on." |
||||
print_version_help |
||||
fi |
||||
|
||||
local branch_name="hotfix-$1" |
||||
|
||||
# Check if branch already exists |
||||
if branch_exists $branch_name; then |
||||
abort 8 "The branch for this release already exists. Use this branch directly instead." |
||||
fi |
||||
|
||||
# Check if hotfix was already released |
||||
if release_exists $1; then |
||||
abort 8 "The release already exists." |
||||
fi |
||||
|
||||
# Check out new release-branch |
||||
git checkout --quiet -b $branch_name |
||||
if [ $? -ne 0 ]; then |
||||
abort 9 "Could not check out new release branch" |
||||
fi |
||||
|
||||
# Bump version |
||||
bump_version "$1~dev" 0 |
||||
if [ $? -ne 0 ]; then |
||||
abort 10 "Could not set version of release" |
||||
fi |
||||
|
||||
# Commit version bump |
||||
git commit --quiet -a -m "Automated version bump to $1" |
||||
if [ $? -ne 0 ]; then |
||||
abort 10 "Could not commit version bump on new release branch" |
||||
fi |
||||
|
||||
echo "SUCCESS: New release $1 was successfully prepared" |
||||
echo "You are now on the release branch ($branch_name)." |
||||
echo "Please check the last commit on the current branch for consistency and push your changes with:" |
||||
echo "" |
||||
echo " git push origin" |
||||
echo "" |
||||
} |
||||
|
||||
function publish_release() { |
||||
# Determine on which branch we are |
||||
local branch=$(git branch --show-current) |
||||
if [ $? -ne 0 ]; then |
||||
abort 2 "Could not determine the current branch" |
||||
fi |
||||
|
||||
if ! [[ $branch =~ ^(release-[0-9]+\.[0-9]+|hotfix-[0-9]+\.[0-9]+\.[0-9]+([+~][A-Za-z0-9+~\.-]*)*)?$ ]]; then |
||||
abort 4 "You are not on a release or hotfix branch. Are you on the right branch?" |
||||
fi |
||||
|
||||
if ! [[ $(read -e -p "Are you sure you want to publish release $(current_version|sed 's/~dev$//g')? [y/N] "; echo $REPLY) =~ ^[Yy]+$ ]]; then |
||||
exit 0 |
||||
fi |
||||
|
||||
#Strip ~dev from the version |
||||
bump_version $(echo $(current_version)|sed 's/~dev$//g') 1 |
||||
|
||||
# Commit version bump |
||||
git commit -a -m "Release $(current_version)" |
||||
if [ $? -ne 0 ]; then |
||||
abort 5 "Could not commit version bump for release" |
||||
fi |
||||
|
||||
# Get SHA of release commit |
||||
sha=$(git rev-parse HEAD) |
||||
|
||||
# Store the version of the release |
||||
release_version=$(current_version) |
||||
|
||||
# Tag the release |
||||
echo "Tagging the release" |
||||
git tag -a "v$(current_version)" -m "Release $(current_version)" |
||||
if [ $? -ne 0 ]; then |
||||
abort 6 "Could not tag release" |
||||
fi |
||||
|
||||
# Bump the version to the next patch and add ~dev again if we are on a release-branch |
||||
if [[ $branch =~ ^release-[0-9]+\.[0-9]+$ ]]; then |
||||
bump_version "$(current_major_version).$(current_minor_version).$(($(current_patch_version)+1))$(current_suffix_version)~dev" 0 |
||||
|
||||
# Commit version bump |
||||
git commit -a -m "Automated version bump to $(current_version)" |
||||
if [ $? -ne 0 ]; then |
||||
abort 7 "Could not commit version bump after release" |
||||
fi |
||||
fi |
||||
|
||||
echo "SUCCESS: Release was published locally!" |
||||
echo "To publish the release globally push your changes with:" |
||||
echo "" |
||||
echo " git push --follow-tags origin ${branch}" |
||||
echo "" |
||||
|
||||
if ! [[ $(read -e -p 'Do you want to merge the release back to the main development branch now? [Y/n] '; echo $REPLY) =~ ^[Nn]+$ ]]; then |
||||
|
||||
# Switch to main development branch |
||||
git checkout --quiet master |
||||
if [ $? -ne 0 ]; then |
||||
abort 7 "Could not checkout main development branch" |
||||
fi |
||||
|
||||
local old_version="$(current_version)" |
||||
|
||||
# Ensure that the git hooks are not placed already and that the sample for the pre-merge-commit hook is available |
||||
if test -x "${SCRIPT_PATH}/../.git/hooks/commit-msg"; then |
||||
abort 8 "Some git hooks already exist. This is not supported by this script." |
||||
fi |
||||
|
||||
# If the current version of master is lower than the one we merge in, we must bump the version |
||||
if compare_versions $old_version $release_version; then |
||||
# Release version is higher |
||||
echo "" |
||||
echo "Be careful while patching! Read these instructions carefully before starting the merge:" |
||||
echo "- Merge your version as if it will be the new version of the main development branch." |
||||
echo "- There should not exist a development version anymore!" |
||||
echo " A new development version will be created automatically!" |
||||
|
||||
if ! [[ $(read -e -p "Start the merging process? [y/N] "; echo $REPLY) =~ ^[Yy]+$ ]]; then |
||||
git checkout --quiet $branch |
||||
if [ $? -ne 0 ]; then |
||||
abort 7 "Could not checkout release branch. BEWARE you are on 'master' now!" |
||||
fi |
||||
exit 0 |
||||
fi |
||||
|
||||
echo "" |
||||
|
||||
# These git hooks will be called before the merge commit is created. They will take care of bumping the version to the correct value. |
||||
# Create the commit-msg hook |
||||
cat << EOF > "${SCRIPT_PATH}/../.git/hooks/commit-msg" |
||||
#!/bin/bash |
||||
|
||||
# Acquire helper methods |
||||
SOURCE_ONLY=1 |
||||
source scripts/release_helper.sh |
||||
|
||||
# Fix the script path as Git sets the working directory to the repository root |
||||
SCRIPT_PATH="scripts" |
||||
|
||||
# Make sure the version is correct |
||||
if ! [[ "\$(current_version)" == "$release_version" ]]; then |
||||
echo "The version information in CMakeLists.txt is not correct. The current version should be $release_version" |
||||
exit 1 |
||||
fi |
||||
|
||||
# Make sure there is no artifact of an old development version |
||||
if ! [ -z "\$(cat CHANGELOG.md | grep -E "\+dev|~dev")" ]; then |
||||
echo "CHANGELOG.md should not contain a development version string '[+~]dev'" |
||||
exit 1 |
||||
fi |
||||
|
||||
if ! [ -z "\$(cat debian/changelog | grep -E "\+dev|~dev")" ]; then |
||||
echo "debian/changelog should not contain a development version string '[+~]dev'" |
||||
exit 1 |
||||
fi |
||||
|
||||
if ! [ -z "\$(cat desktop/com.github.xournalpp.xournalpp.appdata.xml | grep -E "\+dev|~dev")" ]; then |
||||
echo "desktop/com.github.xournalpp.xournalpp.appdata.xml should not contain a development version string '[+~]dev'" |
||||
exit 1 |
||||
fi |
||||
|
||||
# Bump the version to the next dev version |
||||
bump_version "${release_version}+dev" 0 |
||||
|
||||
# Amend the previous commit to include the version change |
||||
git add CMakeLists.txt CHANGELOG.md debian/changelog desktop/com.github.xournalpp.xournalpp.appdata.xml |
||||
|
||||
# Wait for merge to finish and then amend the commit (This hack is needed since git does not allow amendments in hooks) |
||||
bash -c "git merge HEAD &> /dev/null; while [ $? -ne 0 ]; do sleep 1; git merge HEAD &> /dev/null; done; git commit --amend -C HEAD --no-verify" & |
||||
|
||||
# Remove the git hooks |
||||
rm .git/hooks/commit-msg |
||||
|
||||
# Signify git that it can proceed with the merge |
||||
exit 0 |
||||
EOF |
||||
|
||||
# The post-commit hook must be executable |
||||
chmod +x "${SCRIPT_PATH}/../.git/hooks/commit-msg" |
||||
|
||||
# Start merge |
||||
git merge --no-ff -m "Merge back Release ${release_version}" $sha |
||||
|
||||
else |
||||
# Release version is lower |
||||
echo "" |
||||
echo "Be careful while patching! Read these instructions carefully before starting the merge:" |
||||
echo "- Merge your version as if it is a historic release and do not modify or delete other versions" |
||||
echo "- The versions in the changelog should be ordered in a descending order (highest first)" |
||||
echo "- There should not exist any development version lower than your published release" |
||||
|
||||
if ! [[ $(read -e -p "Start the merging process? [y/N] "; echo $REPLY) =~ ^[Yy]+$ ]]; then |
||||
git checkout --quiet $branch |
||||
if [ $? -ne 0 ]; then |
||||
abort 7 "Could not checkout release branch. BEWARE you are on 'master' now!" |
||||
fi |
||||
exit 0 |
||||
fi |
||||
|
||||
echo "" |
||||
|
||||
# These git hooks will be called before the merge commit is created. They will take care of bumping the version to the correct value. |
||||
# Enable the pre-merge-commit hook as it will call the pre-commit hook |
||||
mv "${SCRIPT_PATH}/../.git/hooks/pre-merge-commit.sample" "${SCRIPT_PATH}/../.git/hooks/pre-merge-commit" |
||||
# Create the pre-commit hook |
||||
cat << EOF > "${SCRIPT_PATH}/../.git/hooks/pre-commit" |
||||
#!/bin/bash |
||||
|
||||
# Acquire helper methods |
||||
SOURCE_ONLY=1 |
||||
source scripts/release_helper.sh |
||||
|
||||
# Fix the script path as Git sets the working directory to the repository root |
||||
SCRIPT_PATH="scripts" |
||||
|
||||
# Make sure the version is correct |
||||
if ! [[ "\$(current_version)" == "$old_version" ]]; then |
||||
echo "The version information in CMakeLists.txt is not correct. The current version should be $old_version" |
||||
exit 1 |
||||
fi |
||||
|
||||
# Make sure the latest version did not change in the changelogs |
||||
if ! [[ "\$(sed -n "N;N;s/# Changelog\n\n## \([^\ ]*\) (Unreleased)/\1/p" CHANGELOG.md)" == "$old_version" ]]; then |
||||
echo "The first version in CHANGELOG.md should be $old_version" |
||||
exit 1 |
||||
fi |
||||
|
||||
if ! [[ "\$(sed -n "1,/xournalpp/{s/xournalpp (\([^-]*-1\)) UNRELEASED; urgency=medium/\1/p}" debian/changelog)" == "$old_version-1" ]]; then |
||||
echo "The first version in debian/changelog should be $old_version" |
||||
exit 1 |
||||
fi |
||||
|
||||
if ! [[ "\$(sed -n "1,/\ \ \ \ <release /{s/\ \ \ \ <release date=\"[^\"]*\" version=\"\([^\"]*\)\" \/>/\1/p}" desktop/com.github.xournalpp.xournalpp.appdata.xml)" == "$old_version" ]]; then |
||||
echo "The first version in desktop/com.github.xournalpp.xournalpp.appdata.xml should be $old_version" |
||||
exit 1 |
||||
fi |
||||
|
||||
# Remove the git hooks |
||||
mv .git/hooks/pre-merge-commit .git/hooks/pre-merge-commit.sample |
||||
rm .git/hooks/pre-commit |
||||
|
||||
# Signify git that it can proceed with the merge |
||||
exit 0 |
||||
EOF |
||||
|
||||
# The pre-commit hook must be executable |
||||
chmod +x "${SCRIPT_PATH}/../.git/hooks/pre-commit" |
||||
|
||||
# Start merge |
||||
git merge --no-ff -m "Merge back Release ${release_version}" $sha |
||||
|
||||
fi |
||||
fi |
||||
} |
||||
|
||||
if [ -z ${SOURCE_ONLY+x} ]; then |
||||
#################### |
||||
# Main functionality |
||||
#################### |
||||
|
||||
# Check for a version number passed by argument |
||||
if [ "$#" -lt 1 ]; then |
||||
echo "Missing command" |
||||
command="help" |
||||
else |
||||
command=$1 |
||||
fi |
||||
|
||||
if [[ $command != @(help|prepare|publish) ]]; then |
||||
echo "ABORT: unknown command" |
||||
command="help" |
||||
fi |
||||
|
||||
if [[ $command == "help" ]]; then |
||||
echo "Usage: $0 <command> <arguments>" |
||||
echo "" |
||||
echo "Commands:" |
||||
echo " prepare <version> Prepares a release in the form of a new branch with correct version strings." |
||||
echo " This command may only be run on a clean HEAD from:" |
||||
echo " - The main development branch (master)" |
||||
echo " The supplied version must differ from the current version in the major" |
||||
echo " or minor version level. The suffix string may differ in any way." |
||||
echo " - A commit of a published release (has a tag starting with 'v')" |
||||
echo " The supplied version must differ from the current version in the suffix" |
||||
echo " and must be higher than the current version." |
||||
echo " The supplied version suffix may not end with '+dev'. This ending is a" |
||||
echo " protected suffix and is applied by the script automatically." |
||||
echo "" |
||||
echo " publish Publishes a priorly prepared release. You must be on a branch that that was" |
||||
echo " created during the prepare phase of this script. The version of the release" |
||||
echo " is derived from the prepare phase. Make sure to update the changelogs prior" |
||||
echo " to starting this phase. Changelogs are contained in:" |
||||
echo " - CHANGELOG" |
||||
echo " - debian/changelog" |
||||
echo "" |
||||
echo " help Prints this help message" |
||||
echo "" |
||||
fi |
||||
|
||||
# Check on which branch we are |
||||
branch=$(git branch --show-current) |
||||
if [ $? -ne 0 ]; then |
||||
abort 2 "Could not determine the current branch" |
||||
fi |
||||
|
||||
# Check for a clean git working space - otherwise this script will commit whatever is there |
||||
if ! git diff --quiet --cached --exit-code > /dev/null; then |
||||
abort 3 "Your working tree is not clean. Please commit or stash all staged changes before running this script." |
||||
fi |
||||
if ! git diff --quiet --exit-code > /dev/null; then |
||||
abort 3 "Your working tree is not clean. Please commit or stash all staged changes before running this script." |
||||
fi |
||||
|
||||
if [[ $command == "prepare" ]]; then |
||||
version=$2 |
||||
|
||||
if validate_version $1; then |
||||
print_version_help |
||||
abort 4 "No valid version string provided" |
||||
fi |
||||
|
||||
if [[ $version =~ [~+]dev$ ]]; then |
||||
abort 5 "You may not use a suffix ending with '+dev' or '~dev'" |
||||
fi |
||||
|
||||
if [[ $branch == "master" ]]; then |
||||
# Disallow detached HEAD |
||||
if is_detached; then |
||||
abort 6 "You can not prepare a release in detached HEAD mode" |
||||
fi |
||||
prepare_new_version $version |
||||
elif [[ $(git tag --contains | grep -Exc '^v[0-9]+.[0-9]+.[0-9]+([+~][0-9A-Za-z+~.-]*)*$') -ne 0 ]]; then |
||||
prepare_hotfix $version |
||||
else |
||||
abort 4 "You may only call this script from the main development branch, an existing release branch or a tagged release." |
||||
fi |
||||
elif [[ $command == "publish" ]]; then |
||||
publish_release |
||||
fi |
||||
fi |
||||
@ -1,3 +1,3 @@ |
||||
# git-build-recipe format 0.4 deb-version {debupstream}~{revtime} |
||||
# git-build-recipe format 0.4 deb-version 1:{debupstream}-{revtime}-1 |
||||
lp:xournalpp master |
||||
|
||||
|
||||
Loading…
Reference in new issue