#!/bin/bash # Copyright 2015 The Kubernetes Authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Checkout a PR from GitHub. (Yes, this is sitting in a Git tree. How # meta.) Assumes you care about pulls from remote "upstream" and # checks thems out to a branch named pull_12345. set -o errexit set -o nounset set -o pipefail declare -r KUBE_ROOT="$(dirname "${BASH_SOURCE}")/.." cd "${KUBE_ROOT}" declare -r STARTINGBRANCH=$(git symbolic-ref --short HEAD) declare -r REBASEMAGIC="${KUBE_ROOT}/.git/rebase-apply" if [[ -z ${GITHUB_USER:-} ]]; then echo "Please export GITHUB_USER= (or GH organization, if that's where your fork lives)" exit 1 fi if ! which hub > /dev/null; then echo "Can't find 'hub' tool in PATH, please install from https://github.com/github/hub" exit 1 fi if [[ "$#" -lt 2 ]]; then echo "${0} ...: cherry pick one or more onto and leave instructions for proposing pull request" echo "" echo " Checks out and handles the cherry-pick of (possibly multiple) for you." echo " Examples:" echo " $0 upstream/release-3.14 12345 # Cherry-picks PR 12345 onto upstream/release-3.14 and proposes that as a PR." echo " $0 upstream/release-3.14 12345 56789 # Cherry-picks PR 12345, then 56789 and proposes the combination as a single PR." exit 2 fi if git_status=$(git status --porcelain --untracked=no 2>/dev/null) && [[ -n "${git_status}" ]]; then echo "!!! Dirty tree. Clean up and try again." exit 1 fi if [[ -e "${REBASEMAGIC}" ]]; then echo "!!! 'git rebase' or 'git am' in progress. Clean up and try again." exit 1 fi declare -r BRANCH="$1" shift 1 declare -r PULLS=( "$@" ) function join { local IFS="$1"; shift; echo "$*"; } declare -r PULLDASH=$(join - "${PULLS[@]/#/#}") # Generates something like "#12345-#56789" declare -r PULLSUBJ=$(join " " "${PULLS[@]/#/#}") # Generates something like "#12345 #56789" echo "+++ Updating remotes..." git remote update if ! git log -n1 --format=%H "${BRANCH}" >/dev/null 2>&1; then echo "!!! '${BRANCH}' not found. The second argument should be something like upstream/release-0.21." echo " (In particular, it needs to be a valid, existing remote branch that I can 'git checkout'.)" exit 1 fi declare -r NEWBRANCHREQ="automated-cherry-pick-of-${PULLDASH}" # "Required" portion for tools. declare -r NEWBRANCH="$(echo "${NEWBRANCHREQ}-${BRANCH}" | sed 's/\//-/g')" declare -r NEWBRANCHUNIQ="${NEWBRANCH}-$(date +%s)" echo "+++ Creating local branch ${NEWBRANCHUNIQ}" cleanbranch="" prtext="" gitamcleanup=false function return_to_kansas { echo "" echo "+++ Returning you to the ${STARTINGBRANCH} branch and cleaning up." if [[ "${gitamcleanup}" == "true" ]]; then git am --abort >/dev/null 2>&1 || true fi git checkout -f "${STARTINGBRANCH}" >/dev/null 2>&1 || true if [[ -n "${cleanbranch}" ]]; then git branch -D "${cleanbranch}" >/dev/null 2>&1 || true fi if [[ -n "${prtext}" ]]; then rm "${prtext}" fi } trap return_to_kansas EXIT git checkout -b "${NEWBRANCHUNIQ}" "${BRANCH}" cleanbranch="${NEWBRANCHUNIQ}" gitamcleanup=true for pull in "${PULLS[@]}"; do echo "+++ Downloading patch to /tmp/${pull}.patch (in case you need to do this again)" curl -o "/tmp/${pull}.patch" -sSL "http://pr.k8s.io/${pull}.patch" echo echo "+++ About to attempt cherry pick of PR. To reattempt:" echo " $ git am -3 /tmp/${pull}.patch" echo git am -3 "/tmp/${pull}.patch" || { conflicts=false while unmerged=$(git status --porcelain | grep ^U) && [[ -n ${unmerged} ]] \ || [[ -e "${REBASEMAGIC}" ]]; do conflicts=true # <-- We should have detected conflicts once echo echo "+++ Conflicts detected:" echo (git status --porcelain | grep ^U) || echo "!!! None. Did you git am --continue?" echo echo "+++ Please resolve the conflicts in another window (and remember to 'git add / git am --continue')" read -p "+++ Proceed (anything but 'y' aborts the cherry-pick)? [y/n] " -r echo if ! [[ "${REPLY}" =~ ^[yY]$ ]]; then echo "Aborting." >&2 exit 1 fi done if [[ "${conflicts}" != "true" ]]; then echo "!!! git am failed, likely because of an in-progress 'git am' or 'git rebase'" exit 1 fi } done gitamcleanup=false function make-a-pr() { local rel="$(basename "${BRANCH}")" echo "+++ Creating a pull request on GitHub at ${GITHUB_USER}:${NEWBRANCH}" # This looks like an unnecessary use of a tmpfile, but it avoids # https://github.com/github/hub/issues/976 Otherwise stdin is stolen # when we shove the heredoc at hub directly, tickling the ioctl # crash. prtext="$(mktemp -t prtext.XXXX)" # cleaned in return_to_kansas cat >"${prtext}" <&2 exit 1 fi git push origin -f "${NEWBRANCHUNIQ}:${NEWBRANCH}" make-a-pr