|
| 1 | +#!/usr/bin/env bash |
| 2 | + |
| 3 | +# Safe backport helper. Creates a PR in the current repository that cherry-picks a commit from upstream. |
| 4 | + |
| 5 | +set -euo pipefail |
| 6 | + |
| 7 | +# ANSI colors for readability |
| 8 | +RED='\033[0;31m' |
| 9 | +GREEN='\033[0;32m' |
| 10 | +YELLOW='\033[1;33m' |
| 11 | +NC='\033[0m' |
| 12 | + |
| 13 | +die() { |
| 14 | + echo -e "${RED}$1${NC}" >&2 |
| 15 | + exit "${2:-1}" |
| 16 | +} |
| 17 | + |
| 18 | +require_env() { |
| 19 | + local name="$1" |
| 20 | + local value="${!name:-}" |
| 21 | + if [[ -z "$value" ]]; then |
| 22 | + die "Environment variable $name is required" |
| 23 | + fi |
| 24 | +} |
| 25 | + |
| 26 | +if [[ $# -ne 1 ]]; then |
| 27 | + die "Usage: $0 <commit-sha>" |
| 28 | +fi |
| 29 | + |
| 30 | +COMMIT_SHA="$1" |
| 31 | + |
| 32 | +if ! [[ "$COMMIT_SHA" =~ ^[0-9a-f]{40}$ ]]; then |
| 33 | + die "Invalid commit SHA: $COMMIT_SHA" |
| 34 | +fi |
| 35 | + |
| 36 | +SOURCE_REPO="${SOURCE_REPO:-apache/apisix-ingress-controller}" |
| 37 | +TARGET_BRANCH="${TARGET_BRANCH:-master}" |
| 38 | +GITHUB_REPO="${GITHUB_REPOSITORY:-}" |
| 39 | + |
| 40 | +require_env SOURCE_REPO |
| 41 | +require_env TARGET_BRANCH |
| 42 | +require_env GH_TOKEN |
| 43 | + |
| 44 | +[[ "$SOURCE_REPO" =~ ^[A-Za-z0-9._-]+/[A-Za-z0-9._-]+$ ]] || die "Invalid SOURCE_REPO: $SOURCE_REPO" |
| 45 | +[[ "$TARGET_BRANCH" =~ ^[A-Za-z0-9._/-]+$ ]] || die "Invalid TARGET_BRANCH: $TARGET_BRANCH" |
| 46 | + |
| 47 | +if [[ -z "$GITHUB_REPO" ]]; then |
| 48 | + GITHUB_REPO="$(gh repo view --json nameWithOwner -q '.nameWithOwner')" |
| 49 | +fi |
| 50 | + |
| 51 | +[[ "$GITHUB_REPO" =~ ^[A-Za-z0-9._-]+/[A-Za-z0-9._-]+$ ]] || die "Invalid target repo: $GITHUB_REPO" |
| 52 | + |
| 53 | +echo -e "${YELLOW}Backporting commit ${COMMIT_SHA} from ${SOURCE_REPO}${NC}" |
| 54 | + |
| 55 | +ORIGINAL_REF="" |
| 56 | +ORIGINAL_COMMIT="" |
| 57 | +if ORIGINAL_REF=$(git symbolic-ref --quiet HEAD 2>/dev/null); then |
| 58 | + ORIGINAL_REF=${ORIGINAL_REF#refs/heads/} |
| 59 | +else |
| 60 | + ORIGINAL_COMMIT=$(git rev-parse HEAD) |
| 61 | +fi |
| 62 | + |
| 63 | +restore_original_ref() { |
| 64 | + if [[ -n "$ORIGINAL_REF" ]]; then |
| 65 | + git checkout "$ORIGINAL_REF" >/dev/null 2>&1 || true |
| 66 | + elif [[ -n "$ORIGINAL_COMMIT" ]]; then |
| 67 | + git checkout --detach "$ORIGINAL_COMMIT" >/dev/null 2>&1 || true |
| 68 | + fi |
| 69 | +} |
| 70 | + |
| 71 | +if ! git cat-file -e "${COMMIT_SHA}^{commit}" 2>/dev/null; then |
| 72 | + die "Commit $COMMIT_SHA is not available locally - fetch upstream before running this script" |
| 73 | +fi |
| 74 | + |
| 75 | +COMMIT_TITLE="$(git log --format='%s' -n 1 "$COMMIT_SHA")" |
| 76 | +COMMIT_AUTHOR="$(git log --format='%an <%ae>' -n 1 "$COMMIT_SHA")" |
| 77 | +COMMIT_URL="https://github.com/${SOURCE_REPO}/commit/${COMMIT_SHA}" |
| 78 | +SHORT_SHA="${COMMIT_SHA:0:7}" |
| 79 | +if [[ -z "$COMMIT_TITLE" ]]; then |
| 80 | + COMMIT_TITLE="Backport ${SHORT_SHA} from ${SOURCE_REPO}" |
| 81 | +fi |
| 82 | +TITLE_SUFFIX=" (${SHORT_SHA})" |
| 83 | +if [[ "$COMMIT_TITLE" == *"$SHORT_SHA"* ]]; then |
| 84 | + TITLE_SUFFIX="" |
| 85 | +fi |
| 86 | +BRANCH_NAME="backport/${SHORT_SHA}-to-${TARGET_BRANCH}" |
| 87 | + |
| 88 | +[[ "$BRANCH_NAME" =~ ^[A-Za-z0-9._/-]+$ ]] || die "Generated branch name is unsafe: $BRANCH_NAME" |
| 89 | + |
| 90 | +echo -e "${YELLOW}Generated branch name: ${BRANCH_NAME}${NC}" |
| 91 | + |
| 92 | +EXISTING_PR="$(gh pr list --state all --head "$BRANCH_NAME" --json url --jq '.[0].url' 2>/dev/null || true)" |
| 93 | +if [[ -n "$EXISTING_PR" ]]; then |
| 94 | + echo -e "${GREEN}PR already exists: ${EXISTING_PR}. Skipping duplicate.${NC}" |
| 95 | + exit 0 |
| 96 | +fi |
| 97 | + |
| 98 | +git fetch origin "$TARGET_BRANCH" --quiet |
| 99 | +git checkout -B "$TARGET_BRANCH" "origin/$TARGET_BRANCH" |
| 100 | + |
| 101 | +if git rev-parse --verify "$BRANCH_NAME" >/dev/null 2>&1; then |
| 102 | + git checkout "$BRANCH_NAME" |
| 103 | + git reset --hard "origin/$TARGET_BRANCH" |
| 104 | +else |
| 105 | + git checkout -b "$BRANCH_NAME" |
| 106 | +fi |
| 107 | + |
| 108 | +PARENT_COUNT="$(git rev-list --parents -n 1 "$COMMIT_SHA" | awk '{print NF-1}')" |
| 109 | +HAS_CONFLICTS=false |
| 110 | + |
| 111 | +echo -e "${YELLOW}Running cherry-pick...${NC}" |
| 112 | + |
| 113 | +cherry_pick() { |
| 114 | + if [[ "$PARENT_COUNT" -gt 1 ]]; then |
| 115 | + git cherry-pick -x -m 1 "$COMMIT_SHA" |
| 116 | + else |
| 117 | + git cherry-pick -x "$COMMIT_SHA" |
| 118 | + fi |
| 119 | +} |
| 120 | + |
| 121 | +if ! cherry_pick; then |
| 122 | + echo -e "${YELLOW}Cherry-pick reported conflicts; leaving markers for manual resolution.${NC}" |
| 123 | + HAS_CONFLICTS=true |
| 124 | + git add . |
| 125 | + git -c core.editor=true cherry-pick --continue || true |
| 126 | +fi |
| 127 | + |
| 128 | +echo -e "${YELLOW}Pushing branch to origin...${NC}" |
| 129 | +if ! git push -u origin "$BRANCH_NAME"; then |
| 130 | + echo -e "${YELLOW}Push failed, trying force-with-lease...${NC}" |
| 131 | + git fetch origin "$BRANCH_NAME" || true |
| 132 | + git branch --set-upstream-to="origin/$BRANCH_NAME" "$BRANCH_NAME" || true |
| 133 | + git push -u origin "$BRANCH_NAME" --force-with-lease || { |
| 134 | + git checkout "$TARGET_BRANCH" |
| 135 | + git branch -D "$BRANCH_NAME" || true |
| 136 | + restore_original_ref |
| 137 | + die "Unable to push branch ${BRANCH_NAME}" |
| 138 | + } |
| 139 | +fi |
| 140 | + |
| 141 | +echo -e "${YELLOW}Creating pull request...${NC}" |
| 142 | + |
| 143 | +if [[ "$HAS_CONFLICTS" == "true" ]]; then |
| 144 | + PR_TITLE="conflict: ${COMMIT_TITLE}${TITLE_SUFFIX}" |
| 145 | + PR_BODY=$(cat <<EOF |
| 146 | +<!-- backport:${COMMIT_SHA} --> |
| 147 | +
|
| 148 | +## ⚠️ Backport With Conflicts |
| 149 | +
|
| 150 | +- Upstream commit: ${COMMIT_URL} |
| 151 | +- Original title: ${COMMIT_TITLE} |
| 152 | +- Original author: ${COMMIT_AUTHOR} |
| 153 | +
|
| 154 | +This PR contains unresolved conflicts. Please resolve them before merging. |
| 155 | +
|
| 156 | +### Suggested workflow |
| 157 | +1. \`git fetch origin ${BRANCH_NAME}\` |
| 158 | +2. \`git checkout ${BRANCH_NAME}\` |
| 159 | +3. Resolve conflicts, commit, and push updates. |
| 160 | +
|
| 161 | +> Created automatically by backport-bot. |
| 162 | +EOF |
| 163 | +) |
| 164 | + LABEL_FLAGS=(--label backport --label automated --label needs-manual-action --label conflicts) |
| 165 | +else |
| 166 | + PR_TITLE="${COMMIT_TITLE}${TITLE_SUFFIX}" |
| 167 | + PR_BODY=$(cat <<EOF |
| 168 | +<!-- backport:${COMMIT_SHA} --> |
| 169 | +
|
| 170 | +## 🔄 Automated Backport |
| 171 | +
|
| 172 | +- Upstream commit: ${COMMIT_URL} |
| 173 | +- Original title: ${COMMIT_TITLE} |
| 174 | +- Original author: ${COMMIT_AUTHOR} |
| 175 | +
|
| 176 | +Please review and run the relevant validation before merging. |
| 177 | +
|
| 178 | +> Created automatically by backport-bot. |
| 179 | +EOF |
| 180 | +) |
| 181 | + LABEL_FLAGS=(--label backport --label automated) |
| 182 | +fi |
| 183 | + |
| 184 | +set +e |
| 185 | +PR_RESPONSE="$(gh pr create \ |
| 186 | + --title "$PR_TITLE" \ |
| 187 | + --body "$PR_BODY" \ |
| 188 | + --head "$BRANCH_NAME" \ |
| 189 | + --base "$TARGET_BRANCH" \ |
| 190 | + --repo "$GITHUB_REPO" \ |
| 191 | + "${LABEL_FLAGS[@]}" 2>&1)" |
| 192 | +PR_EXIT_CODE=$? |
| 193 | +set -e |
| 194 | + |
| 195 | +if [[ $PR_EXIT_CODE -ne 0 ]]; then |
| 196 | + echo -e "${RED}Failed to create PR:${NC}\n${PR_RESPONSE}" |
| 197 | + if grep -q "already exists" <<<"$PR_RESPONSE"; then |
| 198 | + echo -e "${YELLOW}Detected existing PR, assuming success.${NC}" |
| 199 | + git checkout "$TARGET_BRANCH" |
| 200 | + restore_original_ref |
| 201 | + exit 0 |
| 202 | + fi |
| 203 | + git checkout "$TARGET_BRANCH" |
| 204 | + git push origin --delete "$BRANCH_NAME" || true |
| 205 | + git branch -D "$BRANCH_NAME" || true |
| 206 | + restore_original_ref |
| 207 | + die "PR creation failed" |
| 208 | +fi |
| 209 | + |
| 210 | +echo -e "${GREEN}Pull request created successfully:${NC} ${PR_RESPONSE}" |
| 211 | + |
| 212 | +restore_original_ref |
| 213 | + |
| 214 | +echo -e "${GREEN}Backport finished for ${COMMIT_SHA}.${NC}" |
0 commit comments