mirror of
https://github.com/d4rken-org/capod.git
synced 2026-09-14 18:26:11 -04:00
479 lines
14 KiB
Bash
Executable File
479 lines
14 KiB
Bash
Executable File
#!/bin/bash
|
||
# Based on
|
||
# * https://gist.github.com/jv-k/703e79306554c26a65a7cfdb9ca119c6
|
||
# * https://github.com/jv-k/ver-bump
|
||
|
||
# █▄▄ █░█ █▀▄▀█ █▀█ ▄▄ █░█ █▀▀ █▀█ █▀ █ █▀█ █▄░█
|
||
# █▄█ █▄█ █░▀░█ █▀▀ ░░ ▀▄▀ ██▄ █▀▄ ▄█ █ █▄█ █░▀█
|
||
#
|
||
#
|
||
# Description:
|
||
# - This script automates bumping the git software project's version using automation.
|
||
|
||
# - It does several things that are typically required for releasing a Git repository, like git tagging,
|
||
# automatic updating of CHANGELOG.md, and incrementing the version number in various JSON files.
|
||
|
||
# - Increments / suggests the current software project's version number
|
||
# - Adds a Git tag, named after the chosen version number
|
||
# - Updates CHANGELOG.md
|
||
# - Updates VERSION file
|
||
# - Commits files to a new branch
|
||
# - Pushes to remote (optionally)
|
||
# - Updates "version" : "x.x.x" tag in JSON files if [-v file1 -v file2...] argument is supplied.
|
||
#
|
||
# Usage:
|
||
# ./bump-version.sh [-v <version number>] [-m <release message>] [-j <file1>] [-j <file2>].. [-n] [-p] [-b] [-h]
|
||
#
|
||
# Options:
|
||
# -v <version number> Specify a manual version number
|
||
# -m <release message> Custom release message.
|
||
# -f <filename.json> Update version number inside JSON files.
|
||
# * For multiple files, add a separate -f option for each one,
|
||
# * For example: ./bump-version.sh -f src/plugin/package.json -f composer.json
|
||
# -p <repository alias> Push commits to remote repository, eg `-p origin`
|
||
# -n Don't perform a commit automatically.
|
||
# * You may want to do that yourself, for example.
|
||
# -b Don't create automatic `release-<version>` branch
|
||
# -h Show help message.
|
||
|
||
#
|
||
# Detailed notes:
|
||
# – The contents of the `VERSION` file which should be a semantic version number such as "1.2.3"
|
||
# or even "1.2.3-beta+001.ab"
|
||
#
|
||
# – It pulls a list of changes from git history & prepends to a file called CHANGELOG.md
|
||
# under the title of the new version # number, allows the user to review and update the changelist
|
||
#
|
||
# – Creates a Git tag with the version number
|
||
#
|
||
# - Creates automatic `release-<version>` branch
|
||
#
|
||
# – Commits the new version to the current repository
|
||
#
|
||
# – Optionally pushes the commit to remote repository
|
||
#
|
||
# – Make sure to set execute permissions for the script, eg `$ chmod 755 bump-version.sh`
|
||
#
|
||
# Credits:
|
||
# – https://github.com/jv-k/bump-version
|
||
#
|
||
# - Inspired by the scripts from @pete-otaqui and @mareksuscak
|
||
# https://gist.github.com/pete-otaqui/4188238
|
||
# https://gist.github.com/mareksuscak/1f206fbc3bb9d97dec9c
|
||
#
|
||
|
||
NOW="$(date +'%B %d, %Y')"
|
||
|
||
# ANSI/VT100 colours
|
||
YELLOW='\033[1;33m'
|
||
LIGHTYELLOW='\033[0;33m'
|
||
RED='\033[0;31m'
|
||
LIGHTRED='\033[1;31m'
|
||
GREEN='\033[0;32m'
|
||
LIGHTGREEN='\033[1;32m'
|
||
BLUE='\033[0;34m'
|
||
LIGHTBLUE='\033[1;34m'
|
||
PURPLE='\033[0;35m'
|
||
LIGHTPURPLE='\033[1;35m'
|
||
CYAN='\033[0;36m'
|
||
LIGHTCYAN='\033[1;36m'
|
||
WHITE='\033[1;37m'
|
||
LIGHTGRAY='\033[0;37m'
|
||
DARKGRAY='\033[1;30m'
|
||
BOLD="\033[1m"
|
||
INVERT="\033[7m"
|
||
RESET='\033[0m'
|
||
|
||
# Default options
|
||
FLAG_JSON="false"
|
||
FLAG_PUSH="false"
|
||
|
||
I_OK="✅"
|
||
I_STOP="🚫"
|
||
I_ERROR="❌"
|
||
I_END="👋🏻"
|
||
|
||
S_NORM="${WHITE}"
|
||
S_LIGHT="${LIGHTGRAY}"
|
||
S_NOTICE="${GREEN}"
|
||
S_QUESTION="${YELLOW}"
|
||
S_WARN="${LIGHTRED}"
|
||
S_ERROR="${RED}"
|
||
|
||
V_SUGGEST="0.1.2-rc5" # This is suggested in case VERSION file or user supplied version via -v is missing
|
||
|
||
V_MAJOR="" # 0
|
||
V_MINOR="" # 1
|
||
V_PATCH="" # 2
|
||
V_BUILD_TYPE="" # rc
|
||
V_BUILD_COUNTER="" # 5
|
||
V_NAME=""
|
||
V_CODE=""
|
||
|
||
SCRIPT_VER="1.0"
|
||
|
||
GIT_MSG="Release: "
|
||
REL_NOTE=""
|
||
REL_PREFIX="release/"
|
||
PUSH_DEST="origin"
|
||
|
||
# Show credits & help
|
||
usage() {
|
||
echo -e "$GREEN" \
|
||
"\n █▄▄ █░█ █▀▄▀█ █▀█ ▄▄ █░█ █▀▀ █▀█ █▀ █ █▀█ █▄░█ " \
|
||
"\n █▄█ █▄█ █░▀░█ █▀▀ ░░ ▀▄▀ ██▄ █▀▄ ▄█ █ █▄█ █░▀█ " \
|
||
"\n\t\t\t\t\t$LIGHTGRAY v${SCRIPT_VER}"
|
||
|
||
echo -e " ${S_NORM}${BOLD}Usage:${RESET}" \
|
||
"\n $0 [-v <version number>] [-m <release message>] [-n] [-p] [-h]" 1>&2
|
||
|
||
echo -e "\n ${S_NORM}${BOLD}Options:${RESET}"
|
||
echo -e " $S_WARN-v$S_NORM <version number>\tSpecify a manual version number"
|
||
echo -e " $S_WARN-m$S_NORM <release message>\tCustom release message."
|
||
echo -e " $S_WARN-p$S_NORM \t\t\tPush commits to ORIGIN. "
|
||
echo -e " $S_WARN-n$S_NORM \t\t\tDon't perform a commit automatically. " \
|
||
"\n\t\t\t* You may want to do that manually after checking everything, for example."
|
||
echo -e " $S_WARN-b$S_NORM \t\t\tDon't create automatic \`release-<version>\` branch"
|
||
echo -e " $S_WARN-h$S_NORM \t\t\tShow this help message. "
|
||
echo -e "\n ${S_NORM}${BOLD}Original author: $S_LIGHT https://github.com/jv-t/bump-version $RESET"
|
||
echo -e "\n ${S_NORM}${BOLD}Changes by: $S_LIGHT https://github.com/d4rken $RESET\n"
|
||
}
|
||
|
||
# If there are no commits in repo, quit, because you can't tag with zero commits.
|
||
check-commits-exist() {
|
||
git rev-parse HEAD &>/dev/null
|
||
if [ ! "$?" -eq 0 ]; then
|
||
echo -e "\n${I_STOP} ${S_ERROR}Your current branch doesn't have any commits yet. Can't tag without at least one commit." >&2
|
||
echo
|
||
exit 1
|
||
fi
|
||
}
|
||
|
||
exit_abnormal() {
|
||
echo -e " ${S_LIGHT}––––––"
|
||
usage # Show help
|
||
exit 1
|
||
}
|
||
|
||
# Process script options
|
||
process-arguments() {
|
||
local OPTIONS OPTIND OPTARG
|
||
|
||
# Get positional parameters
|
||
JSON_FILES=()
|
||
while getopts ":v:p:m:hbn" OPTIONS; do # Note: Adding the first : before the flags takes control of flags and prevents default error msgs.
|
||
case "$OPTIONS" in
|
||
h)
|
||
# Show help
|
||
exit_abnormal
|
||
;;
|
||
v)
|
||
# User has supplied a version number
|
||
V_USR_SUPPLIED=$OPTARG
|
||
;;
|
||
m)
|
||
REL_NOTE=$OPTARG
|
||
# Custom release note
|
||
echo -e "\n${S_LIGHT}Option set: ${S_NOTICE}Release note:" ${S_NORM}"'"$REL_NOTE"'"
|
||
;;
|
||
p)
|
||
FLAG_PUSH=true
|
||
PUSH_DEST=${OPTARG} # Replace default with user input
|
||
echo -e "\n${S_LIGHT}Option set: ${S_NOTICE}Pushing to <${S_NORM}${PUSH_DEST}${S_LIGHT}>, as the last action in this script."
|
||
;;
|
||
n)
|
||
FLAG_NOCOMMIT=true
|
||
echo -e "\n${S_LIGHT}Option set: ${S_NOTICE}Disable commit after tagging."
|
||
;;
|
||
b)
|
||
FLAG_NOBRANCH=true
|
||
echo -e "\n${S_LIGHT}Option set: ${S_NOTICE}Disable committing to new branch."
|
||
;;
|
||
\?)
|
||
echo -e "\n${I_ERROR}${S_ERROR} Invalid option: ${S_WARN}-$OPTARG" >&2
|
||
echo
|
||
exit_abnormal
|
||
;;
|
||
:)
|
||
echo -e "\n${I_ERROR}${S_ERROR} Option ${S_WARN}-$OPTARG ${S_ERROR}requires an argument." >&2
|
||
echo
|
||
exit_abnormal
|
||
;;
|
||
esac
|
||
done
|
||
}
|
||
|
||
# Suggests version from VERSION file, or grabs from user supplied -v <version>.
|
||
# If none is set, suggest default from options.
|
||
process-version() {
|
||
V_RAW=""
|
||
|
||
V_FILE_REGEX='^([0-9]+\.[0-9]+\.[0-9]+-[a-zA-Z]+[0-9]+) ([0-9]+)$'
|
||
V_FILE_RAW="$(cat VERSION)"
|
||
if [ -f VERSION ] && [ -s VERSION ] && [[ $V_FILE_RAW =~ $V_FILE_REGEX ]]; then
|
||
V_PREV="${BASH_REMATCH[1]}"
|
||
V_SUGGEST=$V_PREV
|
||
echo -e "\n${S_NOTICE}Current version from <${S_NORM}VERSION${S_NOTICE}> file: ${S_NORM}$V_PREV"
|
||
else
|
||
echo -ne "\n${S_WARN}The [${S_NORM}VERSION${S_WARN}] "
|
||
if [ ! -f VERSION ]; then
|
||
echo "VERSION file was not found."
|
||
elif [ ! -s VERSION ]; then
|
||
echo "VERSION file is empty."
|
||
else
|
||
echo "could not be parsed."
|
||
fi
|
||
fi
|
||
|
||
# If a version number is supplied by the user with [-v <version number>], then use it
|
||
if [ -n "$V_USR_SUPPLIED" ]; then
|
||
echo -e "\n${S_NOTICE}You selected version using [-v]:" "${S_WARN}${V_USR_SUPPLIED}"
|
||
V_RAW="${V_USR_SUPPLIED}"
|
||
else
|
||
echo -ne "\n${S_QUESTION}Enter a new version number [${S_NORM}$V_SUGGEST${S_QUESTION}]: "
|
||
echo -ne "$S_WARN"
|
||
read -r V_RAW
|
||
fi
|
||
|
||
if [ -z "$V_RAW" ]; then
|
||
V_RAW=$V_PREV
|
||
fi
|
||
|
||
if [ -z "$V_RAW" ]; then
|
||
echo -e "\n${I_STOP} ${S_ERROR}Error: No version was supplied (no file, no CLI)\n"
|
||
exit_abnormal
|
||
fi
|
||
|
||
SEMVER_REGEX='^([0-9]+)\.([0-9]+)\.([0-9]+)-([a-zA-Z]+)([0-9]+)$'
|
||
|
||
echo -e "\n${S_NOTICE}Parsing ${V_RAW}"
|
||
|
||
if [[ $V_RAW =~ $SEMVER_REGEX ]]; then
|
||
echo -e "\n${I_OK} ${S_NOTICE} Successfully parsed ${V_RAW} to ${BASH_REMATCH[0]}"
|
||
V_MAJOR="${BASH_REMATCH[1]}"
|
||
echo "V_MAJOR=$V_MAJOR"
|
||
V_MINOR="${BASH_REMATCH[2]}"
|
||
echo "V_MINOR=$V_MINOR"
|
||
V_PATCH="${BASH_REMATCH[3]}"
|
||
echo "V_PATCH=$V_PATCH"
|
||
V_BUILD_TYPE="${BASH_REMATCH[4]}"
|
||
echo "V_BUILD_TYPE=$V_BUILD_TYPE"
|
||
V_BUILD_COUNTER="${BASH_REMATCH[5]}"
|
||
echo "V_BUILD_COUNTER=$V_BUILD_COUNTER"
|
||
else
|
||
echo -e "\n${I_STOP} ${S_ERROR}Error: Failed to parse $V_RAW\n"
|
||
exit_abnormal
|
||
fi
|
||
|
||
# If no version was provided, bump the previous version
|
||
if [ -z "$V_USR_SUPPLIED" ]; then
|
||
if [ "$V_BUILD_COUNTER" -eq "$V_BUILD_COUNTER" ] 2>/dev/null; then # discard stderr (2) output to black hole (suppress it)
|
||
V_BUILD_COUNTER=$((V_BUILD_COUNTER + 1)) # Increment
|
||
fi
|
||
fi
|
||
|
||
V_NAME="$V_MAJOR.$V_MINOR.$V_PATCH-$V_BUILD_TYPE$V_BUILD_COUNTER"
|
||
V_CODE=$((V_MAJOR * 10000000 + V_MINOR * 100000 + V_PATCH * 1000 + V_BUILD_COUNTER * 10))
|
||
echo -e "${S_NOTICE}Setting version to [${S_NORM}${V_NAME} (${V_CODE})${S_NOTICE}] ...."
|
||
}
|
||
|
||
# Only tag if tag doesn't already exist
|
||
check-tag-exists() {
|
||
TAG_CHECK_EXISTS=$(git tag -l v"$V_NAME")
|
||
if [ -n "$TAG_CHECK_EXISTS" ]; then
|
||
echo -e "\n${I_STOP} ${S_ERROR}Error: A release with that tag version number already exists!\n"
|
||
exit 0
|
||
fi
|
||
}
|
||
|
||
# $1 : version
|
||
# $2 : release note
|
||
create-tag() {
|
||
if [ -z "$2" ]; then
|
||
# Default release note
|
||
git tag -a "v$1" -m "Tag version $1."
|
||
else
|
||
# Custom release note
|
||
git tag -a "v$1" -m "$2"
|
||
fi
|
||
echo -e "\n${I_OK} ${S_NOTICE}Added GIT tag"
|
||
}
|
||
|
||
# Update version.properties which is used by Gradle to generate the `versionName` and `versionCode`
|
||
do-version-properties() {
|
||
PROPS_FILE_NAME="version.properties"
|
||
echo -e "\n${S_NOTICE}Parsing ${PROPS_FILE_NAME}:\n"
|
||
|
||
V_MAJOR_REGEX='^([a-zA-Z\.]+major)=([0-9]+)$'
|
||
V_MINOR_REGEX='^([a-zA-Z\.]+minor)=([0-9]+)$'
|
||
V_PATCH_REGEX='^([a-zA-Z\.]+patch)=([0-9]+)$'
|
||
V_BUILD_REGEX='^([a-zA-Z\.]+build)=([0-9]+)$'
|
||
|
||
PROPS_FILE_NEW=""
|
||
|
||
LAST_LINE=$(wc -l <$PROPS_FILE_NAME)
|
||
CURRENT_LINE=0
|
||
|
||
while read -r line; do
|
||
CURRENT_LINE=$((CURRENT_LINE + 1))
|
||
|
||
if [[ $line =~ $V_MAJOR_REGEX ]]; then
|
||
updated="${BASH_REMATCH[1]}=${V_MAJOR}"
|
||
echo "Found major, replacing: $line -> $updated"
|
||
PROPS_FILE_NEW+=$updated
|
||
elif [[ $line =~ $V_MINOR_REGEX ]]; then
|
||
updated="${BASH_REMATCH[1]}=${V_MINOR}"
|
||
echo "Found minor, replacing: $line -> $updated"
|
||
PROPS_FILE_NEW+=$updated
|
||
elif [[ $line =~ $V_PATCH_REGEX ]]; then
|
||
updated="${BASH_REMATCH[1]}=${V_PATCH}"
|
||
echo "Found patch, replacing: $line -> $updated"
|
||
PROPS_FILE_NEW+=$updated
|
||
elif [[ $line =~ $V_BUILD_REGEX ]]; then
|
||
updated="${BASH_REMATCH[1]}=${V_BUILD_COUNTER}"
|
||
echo "Found build, replacing: $line -> $updated"
|
||
PROPS_FILE_NEW+=$updated
|
||
else
|
||
PROPS_FILE_NEW+="$line"
|
||
fi
|
||
|
||
if [[ $CURRENT_LINE -ne $LAST_LINE ]]; then
|
||
PROPS_FILE_NEW+="\n"
|
||
fi
|
||
|
||
done <"$PROPS_FILE_NAME"
|
||
|
||
echo -e "$PROPS_FILE_NEW" >"$PROPS_FILE_NAME"
|
||
git add "$PROPS_FILE_NAME"
|
||
|
||
echo -e "\n${I_OK} ${S_NOTICE}Updated [${S_NORM}${PROPS_FILE_NAME}${S_NOTICE}] file"
|
||
}
|
||
|
||
# Update a version file that can be parsed by third-parties, e.g. F-Droid
|
||
do-versionfile() {
|
||
[ -f VERSION ] && ACTION_MSG="Updated" || ACTION_MSG="Created"
|
||
|
||
echo "${V_NAME} ${V_CODE}" >VERSION # Create file
|
||
echo -e "\n${I_OK} ${S_NOTICE}${ACTION_MSG} [${S_NORM}VERSION${S_NOTICE}] file"
|
||
|
||
# Stage file for commit
|
||
git add VERSION
|
||
}
|
||
|
||
# Update a version file that can be parsed by third-parties, e.g. F-Droid
|
||
do-fastlane-changelog() {
|
||
CHANGELOGS_DIR="fastlane/metadata/android/en-US/changelogs"
|
||
NEW_CHANGELOG="$CHANGELOGS_DIR/$V_CODE.txt"
|
||
|
||
[ -f "$NEW_CHANGELOG" ] && return
|
||
|
||
echo -e "\n${S_NOTICE}Creating new default fastlane changelog file for $V_CODE...\n"
|
||
|
||
cp "$CHANGELOGS_DIR/default.txt" "$NEW_CHANGELOG"
|
||
|
||
cat "$NEW_CHANGELOG"
|
||
|
||
echo -e "\n\n${I_OK} ${S_NOTICE}${ACTION_MSG} [${S_NORM}$NEW_CHANGELOG${S_NOTICE}] file"
|
||
|
||
# Stage file for commit
|
||
git add "$CHANGELOGS_DIR/$V_CODE.txt"
|
||
}
|
||
|
||
# Does the release branch already exist?
|
||
check-branch-exist() {
|
||
[ "$FLAG_NOBRANCH" = true ] && return
|
||
|
||
BRANCH_MSG=$(git rev-parse --verify "${REL_PREFIX}${V_NAME}" 2>&1)
|
||
if [ "$?" -eq 0 ]; then
|
||
echo -e "\n${I_STOP} ${S_ERROR}Error: Branch <${S_NORM}${REL_PREFIX}${V_NAME}${S_ERROR}> already exists!\n"
|
||
exit 1
|
||
fi
|
||
}
|
||
|
||
# Create release branch if desired
|
||
do-branch() {
|
||
[ "$FLAG_NOBRANCH" = true ] && return
|
||
|
||
echo -e "\n${S_NOTICE}Creating new release branch..."
|
||
|
||
BRANCH_MSG=$(git branch "${REL_PREFIX}${V_NAME}" 2>&1)
|
||
if [ ! "$?" -eq 0 ]; then
|
||
echo -e "\n${I_STOP} ${S_ERROR}Error\n$BRANCH_MSG\n"
|
||
exit 1
|
||
else
|
||
BRANCH_MSG=$(git checkout "${REL_PREFIX}${V_NAME}" 2>&1)
|
||
echo -e "\n${I_OK} ${S_NOTICE}${BRANCH_MSG}"
|
||
fi
|
||
}
|
||
|
||
# Stage & commit all files modified by this script
|
||
do-commit() {
|
||
[ "$FLAG_NOCOMMIT" = true ] && return
|
||
|
||
echo -e "\n${S_NOTICE}Committing..."
|
||
COMMIT_MSG=$(git commit -m "${GIT_MSG}" 2>&1)
|
||
if [ ! "$?" -eq 0 ]; then
|
||
echo -e "\n${I_STOP} ${S_ERROR}Error\n$COMMIT_MSG\n"
|
||
exit 1
|
||
else
|
||
echo -e "\n${I_OK} ${S_NOTICE}$COMMIT_MSG"
|
||
fi
|
||
}
|
||
|
||
# Pushes files + tags to remote repo. Changes are staged by earlier functions
|
||
do-push() {
|
||
[ "$FLAG_NOCOMMIT" = true ] && return
|
||
|
||
if [ "$FLAG_PUSH" = true ]; then
|
||
CONFIRM="Y"
|
||
else
|
||
echo -ne "\n${S_QUESTION}Push tags to <${S_NORM}${PUSH_DEST}${S_QUESTION}>? [${S_NORM}N/y${S_QUESTION}]: "
|
||
read CONFIRM
|
||
fi
|
||
|
||
case "$CONFIRM" in
|
||
[yY][eE][sS] | [yY])
|
||
echo -e "\n${S_NOTICE}Pushing files + tags to <${S_NORM}${PUSH_DEST}${S_NOTICE}>..."
|
||
|
||
PUSH_MSG=$(git push "${PUSH_DEST}" v"$V_NAME" 2>&1) # Push new tag
|
||
PUSH_MSG+="\n"
|
||
PUSH_MSG+=$(git push 2>&1) # Push new tag
|
||
|
||
if [ ! "$?" -eq 0 ]; then
|
||
echo -e "\n${I_STOP} ${S_WARN}Warning\n$PUSH_MSG"
|
||
# exit 1
|
||
else
|
||
echo -e "\n${I_OK} ${S_NOTICE}$PUSH_MSG"
|
||
fi
|
||
;;
|
||
esac
|
||
}
|
||
|
||
#### Initiate Script ###########################
|
||
|
||
check-commits-exist
|
||
|
||
# Process and prepare
|
||
process-arguments "$@"
|
||
process-version
|
||
|
||
GIT_MSG+="${V_NAME}"
|
||
|
||
check-branch-exist
|
||
check-tag-exists
|
||
|
||
echo -e "\n${S_LIGHT}––––––"
|
||
|
||
# Update steps
|
||
do-version-properties
|
||
do-versionfile
|
||
do-fastlane-changelog
|
||
do-branch
|
||
do-commit
|
||
create-tag "${V_NAME}" "${REL_NOTE}"
|
||
do-push
|
||
|
||
echo -e "\n${S_LIGHT}––––––"
|
||
echo -e "\n${I_OK} ${S_NOTICE}"Bumped $([ -n "${V_PREV}" ] && echo "${V_PREV} –>" || echo "to ") "$V_NAME"
|
||
echo -e "\n${GREEN}Done ${I_END}\n"
|