Introduce a helper script for automating the upstream/downstream sync process

Signed-off-by: timflannagan <[email protected]>

Author: timflannagan

Makefile

@@ -186,6 +186,10 @@ crc: crc-start crc-build crc-deploy
 clean:
 	rm -rf bin
 
+.PHONY: sync
+sync:
+	./scripts/sync.sh
+
 .PHONY: help
 help: ## Display this help.
 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

scripts/sync.sh

@@ -0,0 +1,70 @@
+#! /bin/bash
+
+set -o nounset
+set -o errexit
+set -o pipefail
+
+ROOT_DIR=$(dirname "${BASH_SOURCE[0]}")/..
+# shellcheck disable=SC1091
+source "${ROOT_DIR}/scripts/common.sh"
+
+SYNC_BRANCH_NAME="sync-$(printf '%(%Y-%m-%d)T\n' -1)"
+
+add_remote() {
+    echo "Adding upstream remotes if they don't already exist"
+    git config remote.api.url >&- || git remote add api https://github.com/operator-framework/api
+    git config remote.operator-registry.url >&- || git remote add api https://github.com/operator-framework/operator-registry
+    git config remote.operator-lifecycle-manager.url >&- || git remote add api https://github.com/operator-framework/operator-lifecycle-manager
+    git config remote.upstream.url >&- || git remote add upstream https://github.com/openshift/operator-framework-olm
+}
+
+fetch_remote() {
+    git fetch upstream
+
+    echo "Fetching upstream remotes"
+    for remote in "${UPSTREAM_REMOTES[@]}"; do
+        git fetch "$remote"
+    done
+}
+
+new_candidate_branch() {
+    echo "Creating a sync branch if it doesn't already exist"
+    git checkout -b "$SYNC_BRANCH_NAME" upstream/master 2>/dev/null || git checkout "$SYNC_BRANCH_NAME"
+}
+
+candidates() {
+    # TODO: add support for only collecting a single remote.
+    echo "Collecting all upstream commits since last sync"
+    for remote in "${UPSTREAM_REMOTES[@]}"; do
+        "${ROOT_DIR}"/scripts/sync_get_candidates.sh "$remote"
+    done
+}
+
+pop() {
+    echo "Applying all upstream commit candidates"
+    for remote in "${UPSTREAM_REMOTES[@]}"; do
+        "${ROOT_DIR}"/scripts/sync_pop_candidate.sh "$remote" -a
+    done
+}
+
+check_local_branch_commit_diff() {
+    commits_ahead=$(git rev-list upstream/master..HEAD | wc -l)
+
+    if [[ "$commits_ahead" -gt 1 ]]; then
+        # TODO: automatically open a new pull request here.
+        echo "The local sync branch is $commits_ahead commits ahead of the upstream/master branch"
+    else
+        echo "No sync PR is needed as the upstream/master branch is up-to-date"
+    fi
+}
+
+main() {
+    add_remote
+    fetch_remote
+    new_candidate_branch
+    candidates
+    pop
+    check_local_branch_commit_diff
+}
+
+main