Skip to content

Improve merge_upstream.sh script #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
optionsome merged 9 commits into from
Feb 26, 2026
Merged

Improve merge_upstream.sh script #389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
acaf151
Change incorrect use of pathspec to tree-ish
VillePihlava Feb 23, 2026
756b61f
Improve README.md
VillePihlava Feb 23, 2026
ab99da7
Add changelog diff to merge_upstream.sh script
VillePihlava Feb 23, 2026
bdd2ec9
Add title for RELEASE_CHANGELOG.md
VillePihlava Feb 24, 2026
894950a
Make variable names more clear and fetch only necessary remotes.
VillePihlava Feb 24, 2026
5ee6e07
Add diff comparison branch flag
VillePihlava Feb 24, 2026
d2f44da
Make curl command silent
VillePihlava Feb 24, 2026
44145de
Add mention of changelog diff to README.md
VillePihlava Feb 24, 2026
b483de6
Fix comment
VillePihlava Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ There is also a `custom-release` branch that is used for building versions of OT

Checkout [`.github/workflows`](/.github/workflows/). The configured CI pipelines build docker images for dev and prod. The built images can be found here: https://hub.docker.com/r/hsldevcom/opentripplanner.

## `merge_upstream.sh`
## [`merge_upstream.sh`](/merge_upstream.sh)

This script can be used to merge and push changes from e.g. `upstream/dev-2.x` to the `v2` or `custom-release` branches.
You need to have `python3` and `jq` installed.

## [`digitransit/RELEASE_CHANGELOG.md`](/digitransit/RELEASE_CHANGELOG.md)

The generated changelog diff can be found in this file, if it exists.
139 changes: 95 additions & 44 deletions merge_upstream.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,19 @@

set -euo pipefail

DEVBRANCH=v2
REMOTE_REPO=$(git remote -v | grep -i "hsldevcom/OpenTripPlanner" | grep "push" | awk '{print $1;}')
SCRIPT_DIR=$(cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)

DEFAULT_REMOTE=$(git config checkout.defaultRemote)
OTP_BASE=""
ORIGIN_REMOTE="origin"
INCOMING_OTP_BASE_REMOTE=""
HSLDEVCOM_REMOTE=$(git remote -v | grep -i "hsldevcom/OpenTripPlanner" | grep "push" | awk '{print $1;}')

OUTPUT_BRANCH=v2

OPTIONS=""
INCOMING_OTP_BASE=""
FORCE_PUSH_TO_BRANCH=""
CUSTOM_RELEASE=""
DIFF_COMPARISON_BRANCH=""

# bash colored output control characters
BASH_GREEN="\e[32m"
Expand Down Expand Up @@ -43,37 +50,32 @@ echo_bold() {
function main() {
setup "$@"
resetDevelop
createChangelogDiffFile
configDigitransitCI
logSuccess
}

function setup() {
if [[ "$REMOTE_REPO" != "origin" ]]; then
printHelp
echo ""
echo "The origin remote does not point to hsldevcom/OpenTripPlanner"
exit 1
fi

if [[ "$DEFAULT_REMOTE" != "origin" ]]; then
printHelp
echo ""
echo "The default remote is not set to origin"
exit 1
fi
checkOriginRemote

# Parse -b (mandatory), -p, and -c options and set appropriate variables when an option is given.
while getopts "b:pc" opt; do
# Parse -b (mandatory), -p, -c, and -d options and set appropriate variables when an option is given.
while getopts "b:pcd:" opt; do
case "$opt" in
b)
OTP_BASE="$OPTARG"
OPTIONS="$OPTIONS -b $OPTARG"
INCOMING_OTP_BASE="$OPTARG"
;;
p)
FORCE_PUSH_TO_BRANCH="-p"
OPTIONS="$OPTIONS -p"
FORCE_PUSH_TO_BRANCH="true"
;;
c)
CUSTOM_RELEASE="-c"
DEVBRANCH="custom-release"
OPTIONS="$OPTIONS -c"
OUTPUT_BRANCH="custom-release"
;;
d)
OPTIONS="$OPTIONS -d $OPTARG"
DIFF_COMPARISON_BRANCH="$OPTARG"
;;
*)
printHelp
Expand All @@ -82,22 +84,25 @@ function setup() {
esac
done

# If no OTP base branch/pathspec is given.
if [[ -z "$OTP_BASE" ]]; then
printHelp
exit 1
fi
checkDiffComparisonBranch
parseIncomingOtpBase

echo ""
echo "Options: ${FORCE_PUSH_TO_BRANCH} ${CUSTOM_RELEASE}"
echo "Git base branch/commit: ${OTP_BASE}"
echo "Digitransit development branch: ${DEVBRANCH}"
echo "Digitransit remote repo(pull/push): ${REMOTE_REPO}"
echo "Options:$OPTIONS"
echo "Git base branch or commit object: ${INCOMING_OTP_BASE}"
if [[ -n "${FORCE_PUSH_TO_BRANCH}" ]]; then
echo "Force push to branch: true"
else
echo "Force push to branch: false"
fi
echo "Diff comparison branch or commit object: ${DIFF_COMPARISON_BRANCH}"
echo "Digitransit output branch: ${OUTPUT_BRANCH}"
echo "Digitransit remote repo: ${HSLDEVCOM_REMOTE}"
echo ""

if git diff-index --quiet HEAD --; then
echo ""
echo "OK - No local changes, prepare to checkout '${DEVBRANCH}'"
echo "OK - No local changes, prepare to checkout '${OUTPUT_BRANCH}'"
echo ""
else
echo ""
Expand All @@ -106,38 +111,46 @@ function setup() {
exit 2
fi

git fetch --all
git fetch --multiple "$ORIGIN_REMOTE" "$INCOMING_OTP_BASE_REMOTE"
}

function resetDevelop() {
echo ""
echo_bold "## ------------------------------------------------------------------------------------- ##"
echo_bold "## RESET '${DEVBRANCH}' TO '${OTP_BASE}'"
echo_bold "## RESET '${OUTPUT_BRANCH}' BRANCH TO '${INCOMING_OTP_BASE}'"
echo_bold "## ------------------------------------------------------------------------------------- ##"
echo ""
echo "Would you like to reset the '${DEVBRANCH}' to '${OTP_BASE}'? "
echo "Would you like to reset the '${OUTPUT_BRANCH}' branch to '${INCOMING_OTP_BASE}'? "
echo ""

whatDoYouWant

echo ""
echo "Checkout '${DEVBRANCH}'"
git checkout ${DEVBRANCH}
echo "Checkout '${OUTPUT_BRANCH}'"
git checkout ${OUTPUT_BRANCH}

echo ""
echo "Reset '${DEVBRANCH}' branch to '${OTP_BASE}' (hard)"
git reset --hard "${OTP_BASE}"
echo "Reset '${OUTPUT_BRANCH}' branch to '${INCOMING_OTP_BASE}' (hard)"
git reset --hard "${INCOMING_OTP_BASE}"
echo ""
}

function createChangelogDiffFile() {
mkdir -p "$SCRIPT_DIR/digitransit"
echo "# Digitransit OTP Release Summary" > "$SCRIPT_DIR/digitransit/RELEASE_CHANGELOG.md"
python3 "$SCRIPT_DIR/script/changelog-diff.py" $DIFF_COMPARISON_BRANCH $INCOMING_OTP_BASE >> "$SCRIPT_DIR/digitransit/RELEASE_CHANGELOG.md"

git add "$SCRIPT_DIR/digitransit"
git commit -m "Create RELEASE_CHANGELOG.md"
}

function configDigitransitCI() {
git checkout "${DEVBRANCH}"
rm -rf .github
git checkout origin/digitransit_ext_config .github
git commit -a -m "Configure Digitransit CI actions"
if [[ -n "${FORCE_PUSH_TO_BRANCH}" ]]; then
echo ""
echo "Force pushing contents to '${DEVBRANCH}'"
echo "Force pushing contents to '${OUTPUT_BRANCH}'"
git push -f
fi
}
Expand All @@ -147,7 +160,7 @@ function logSuccess() {
echo_green "## ------------------------------------------------------------------------------------- ##"
echo_green "## UPSTREAM MERGE DONE -- SUCCESS"
echo_green "## ------------------------------------------------------------------------------------- ##"
echo " - '${REMOTE_REPO}/${DEVBRANCH}' reset to '${OTP_BASE}'"
echo " - '${HSLDEVCOM_REMOTE}/${OUTPUT_BRANCH}' reset to '${INCOMING_OTP_BASE}'"
echo " - 'digitransit_ext_config' CI features added"
echo ""
echo ""
Expand All @@ -166,6 +179,42 @@ function whatDoYouWant() {
fi
}

function checkOriginRemote() {
if [[ "$HSLDEVCOM_REMOTE" != "$ORIGIN_REMOTE" ]]; then
printHelp
echo ""
echo "The origin remote does not point to hsldevcom/OpenTripPlanner"
exit 1
fi

if [[ "$DEFAULT_REMOTE" != "$ORIGIN_REMOTE" ]]; then
printHelp
echo ""
echo "The default remote is not set to origin"
exit 1
fi
}

function checkDiffComparisonBranch() {
# If no diff comparison branch or commit object argument is given.
if [[ -z "$DIFF_COMPARISON_BRANCH" ]]; then
# Assign the latest release tag.
DIFF_COMPARISON_BRANCH=$(curl -s https://api.github.com/repos/HSLdevcom/OpenTripPlanner/releases/latest | jq -r .tag_name)
fi
}

function parseIncomingOtpBase() {
# If no OTP base branch or commit object argument is given.
if [[ -z "$INCOMING_OTP_BASE" ]]; then
printHelp
exit 1
fi

if [[ "$INCOMING_OTP_BASE" == */* ]]; then
INCOMING_OTP_BASE_REMOTE="${INCOMING_OTP_BASE%%/*}"
fi
}

function printHelp() {
echo ""
printf "This script requires one argument, the base ${BOLD}branch${BASH_ENDFORMAT} or ${BOLD}commit${BASH_ENDFORMAT} to use for the output branch.\n"
Expand All @@ -178,10 +227,12 @@ function printHelp() {
echo_bold "Options:"
echo ""
echo " MANDATORY:"
echo " -b : The base branch (or pathspec) to use for the output. Given as an argument to 'git reset --hard <argument>'."
echo " -b : The base branch (or commit object) argument to use for the output. Given as an argument to 'git reset --hard <argument>'."
echo " OPTIONAL:"
echo " -p : Force push to the selected branch, v2 (default) or custom-release, at the end of the script."
echo " -c : Use the custom-release branch instead of v2 for the output of this script."
echo " -d : Define a changelog diff comparison branch (or commit object) that the new incoming changelog will be compared to."
echo " If nothing is specified, the latest Digitransit OTP release tag is used."
echo ""
echo_bold "Usage:"
echo ""
Expand Down