added github_pull_merge_upstream.sh

github/github_pull_merge_upstream.sh

@@ -0,0 +1,106 @@
+#!/usr/bin/env bash
+#  vim:ts=4:sts=4:sw=4:et
+#
+#  Author: Hari Sekhon
+#  Date: 2024-06-19 19:12:25 +0200 (Wed, 19 Jun 2024)
+#
+#  https///github.com/HariSekhon/DevOps-Bash-tools
+#
+#  License: see accompanying Hari Sekhon LICENSE file
+#
+#  If you're using my code you're welcome to connect with me on LinkedIn and optionally send me feedback to help steer this or other code I publish
+#
+#  https://www.linkedin.com/in/HariSekhon
+#
+
+set -euo pipefail
+[ -n "${DEBUG:-}" ] && set -x
+srcdir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+cd "$srcdir"
+
+# shellcheck disable=SC1090,SC1091
+. "$srcdir/lib/github.sh"
+
+# shellcheck disable=SC2034,SC2154
+usage_description="
+In a forked GitHub repo's checkout, determines the origin of the fork using GitHub CLI,
+configures a git remote to the upstream, pulls the trunk branch and if on a branch other than trunk
+merges the trunk branch to the local branch
+
+Simplifies and automates keeping your personal forked repo up to date with the upstream to resolve merge conflicts
+locally and submit updated Pull Requests
+
+Set environment variable GIT_REBASE=true if you want the pulls and merge to current branch to rebase instead of merge commit...
+if you really love violating VCS history integrity! Personally, not a fan. You can also end up in rebase hell for a series of
+commits that a default merge commit would have auto-resolved
+
+Requires GitHub CLI to be installed and authenticated, as well as jq
+"
+
+# used by usage() in lib/utils.sh
+# shellcheck disable=SC2034
+usage_args="[<owner/repo>]"
+
+help_usage "$@"
+
+max_args 1 "$@"
+
+check_github_origin
+
+if [ $# -gt 0 ]; then
+    upstream_owner_repo="$1"
+    shift
+else
+    upstream_owner_repo="$(github_upstream_owner_repo)"
+fi
+
+rebase="${GIT_REBASE:-false}"
+
+if ! is_bool "$rebase"; then
+    usage "GIT_REBASE environment variable must be set to 'true' or 'false'"
+fi
+
+# follow the clone checkout scheme eg. https:// or ssh://
+#
+# this helps remote workers like me avoiding proxy / wifi hotspot restrictions using HTTPS clones instead of SSH
+timestamp "Determining git base url"
+echo
+github_url_base="$(
+    git remote -v |
+    awk '/origin/ { print $2; exit }' |
+    sed 's|\(.*github.com[:/]\).*|\1|'
+)"
+
+if git remote -v | grep -q '^upstream'; then
+    timestamp "Git remote 'upstream' already exists, not creating"
+else
+    timestamp "Adding git remote 'upstream' to be able to pull directly from original source repo we are forked from"
+    git remote add upstream "${github_url_base}${upstream_owner_repo}"
+fi
+echo
+
+default_branch="$(default_branch)"
+
+# should be a straight fast-forward
+timestamp "Pulling default branch '$default_branch' from origin"
+echo
+git pull origin "$default_branch" "$default_branch" --rebase="$rebase"
+echo
+
+timestamp "Pulling from upstream $upstream_owner_repo"
+echo
+git pull upstream "$default_branch" "$default_branch" --rebase="$rebase"
+echo
+
+current_branch="$(git rev-parse --abbrev-ref HEAD)"
+
+if [ "$current_branch" != "develop" ]; then
+    if [ "$rebase" = true ]; then
+        timestamp "Rebasing current branch '$current_branch' from default branch '$default_branch'"
+        git rebase "$default_branch"
+    else
+        timestamp "Merging default branch '$default_branch' into current branch '$current_branch'"
+        git merge "$default_branch"
+    fi
+fi