Skip to content

Commit 6544d3f

Browse files
linglingye001linglingye001
committed
update
1 parent 73b616e commit 6544d3f

File tree

2 files changed

+162
-4
lines changed

2 files changed

+162
-4
lines changed

‎.github/skills/prepare-release/SKILL.md‎

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,21 @@ When the script prompts `Proceed? [y/N]`, confirm by entering `y`.
6868

6969
#### Step 2: Merge Main to Release Branch
7070

71-
After the version bump PR is merged, create a PR to merge `test-main` into the stable release branch.
71+
After the version bump PR is merged, create a PR to merge `test-main` into the stable release branch by running:
7272

73-
1. Determine the major version from the new version string (e.g., `2` from `2.4.0`).
73+
```bash
74+
./scripts/merge-to-release.sh <new_version>
75+
```
76+
77+
For example: `./scripts/merge-to-release.sh 2.5.0`
78+
79+
The script will automatically:
80+
1. Determine the major version from the version string (e.g., `2` from `2.5.0`).
7481
2. Create a PR from `test-main` → `test-release/stable/v{major}` (e.g., `test-release/stable/v2`).
7582
3. Title the PR: `Merge test-main to test-release/stable/v{major}`.
7683

84+
When the script prompts `Proceed? [y/N]`, confirm by entering `y`.
85+
7786
> **Important**: Use "Merge commit" (not squash) when merging this PR to preserve commit history.
7887
7988
**Sample PR**: https://github.com/Azure/AppConfiguration-JavaScriptProvider/pull/268
@@ -115,12 +124,21 @@ When the script prompts `Proceed? [y/N]`, confirm by entering `y`.
115124

116125
#### Step 3: Merge Preview to Release Branch
117126

118-
After the version bump PR is merged, create a PR to merge `test-preview` into the preview release branch.
127+
After the version bump PR is merged, create a PR to merge `test-preview` into the preview release branch by running:
119128

120-
1. Determine the major version from the new version string (e.g., `2` from `2.4.1-preview`).
129+
```bash
130+
./scripts/merge-to-release.sh <new_version> --preview
131+
```
132+
133+
For example: `./scripts/merge-to-release.sh 2.5.1-preview --preview`
134+
135+
The script will automatically:
136+
1. Determine the major version from the version string (e.g., `2` from `2.5.1-preview`).
121137
2. Create a PR from `test-preview` → `test-release/v{major}` (e.g., `test-release/v2`).
122138
3. Title the PR: `Merge test-preview to test-release/v{major}`.
123139

140+
When the script prompts `Proceed? [y/N]`, confirm by entering `y`.
141+
124142
> **Important**: Use "Merge commit" (not squash) when merging this PR.
125143
126144
**Sample PR**: https://github.com/Azure/AppConfiguration-JavaScriptProvider/pull/274

‎scripts/merge-to-release.sh‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
#!/bin/bash
2+
3+
# ============================================================================
4+
# merge-to-release.sh
5+
#
6+
# Creates a PR to merge a development branch into its corresponding release
7+
# branch. Used after a version bump PR has been merged.
8+
#
9+
# Usage:
10+
# ./scripts/merge-to-release.sh <version> [--preview]
11+
#
12+
# Examples:
13+
# ./scripts/merge-to-release.sh 2.5.0 # test-main → test-release/stable/v2
14+
# ./scripts/merge-to-release.sh 2.5.1-preview --preview # test-preview → test-release/v2
15+
#
16+
# Prerequisites:
17+
# - git and gh (GitHub CLI) must be installed and authenticated
18+
# ============================================================================
19+
20+
set -euo pipefail
21+
22+
# ── Helpers ──────────────────────────────────────────────────────────────────
23+
24+
usage() {
25+
cat <<EOF
26+
Usage: $(basename "$0") <version> [--preview]
27+
28+
Arguments:
29+
version The version that was just bumped (used to determine major version)
30+
--preview Merge test-preview → test-release/v{major} instead of
31+
test-main → test-release/stable/v{major}
32+
33+
Examples:
34+
$(basename "$0") 2.5.0 # test-main → test-release/stable/v2
35+
$(basename "$0") 2.5.1-preview --preview # test-preview → test-release/v2
36+
EOF
37+
exit 1
38+
}
39+
40+
error() {
41+
echo "ERROR: $1" >&2
42+
exit 1
43+
}
44+
45+
info() {
46+
echo "── $1"
47+
}
48+
49+
# ── Parse arguments ──────────────────────────────────────────────────────────
50+
51+
VERSION=""
52+
IS_PREVIEW=false
53+
54+
while [[ $# -gt 0 ]]; do
55+
case "$1" in
56+
--preview)
57+
IS_PREVIEW=true
58+
shift
59+
;;
60+
-h|--help)
61+
usage
62+
;;
63+
*)
64+
if [[ -z "$VERSION" ]]; then
65+
VERSION="$1"
66+
else
67+
error "Unexpected argument: $1"
68+
fi
69+
shift
70+
;;
71+
esac
72+
done
73+
74+
[[ -z "$VERSION" ]] && usage
75+
76+
# Validate version format
77+
if ! echo "$VERSION" | grep -qE '^[0-9]+\.[0-9]+\.[0-9]+(-preview)?$'; then
78+
error "Invalid version format '$VERSION'. Expected: X.Y.Z or X.Y.Z-preview"
79+
fi
80+
81+
# ── Determine branches ──────────────────────────────────────────────────────
82+
83+
# Extract major version (e.g. "2" from "2.5.0" or "2.5.1-preview")
84+
MAJOR_VERSION=$(echo "$VERSION" | cut -d. -f1)
85+
86+
if [[ "$IS_PREVIEW" == true ]]; then
87+
SOURCE_BRANCH="test-preview"
88+
TARGET_BRANCH="test-release/v${MAJOR_VERSION}"
89+
PR_TITLE="Merge test-preview to test-release/v${MAJOR_VERSION}"
90+
else
91+
SOURCE_BRANCH="test-main"
92+
TARGET_BRANCH="test-release/stable/v${MAJOR_VERSION}"
93+
PR_TITLE="Merge test-main to test-release/stable/v${MAJOR_VERSION}"
94+
fi
95+
96+
info "Source branch : $SOURCE_BRANCH"
97+
info "Target branch : $TARGET_BRANCH"
98+
info "PR title : $PR_TITLE"
99+
echo ""
100+
101+
# ── Confirm with user ────────────────────────────────────────────────────────
102+
103+
read -rp "Proceed? [y/N] " confirm
104+
if [[ ! "$confirm" =~ ^[Yy]$ ]]; then
105+
echo "Aborted."
106+
exit 0
107+
fi
108+
109+
echo ""
110+
111+
# ── Resolve project directory ────────────────────────────────────────────────
112+
113+
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
114+
PROJECT_DIR="$(dirname "$SCRIPT_DIR")"
115+
cd "$PROJECT_DIR"
116+
117+
# ── Fetch latest branches ───────────────────────────────────────────────────
118+
119+
info "Fetching latest branches..."
120+
git fetch origin "$SOURCE_BRANCH"
121+
git fetch origin "$TARGET_BRANCH"
122+
123+
# ── Create PR ────────────────────────────────────────────────────────────────
124+
125+
info "Creating pull request..."
126+
PR_URL=$(gh pr create \
127+
--base "$TARGET_BRANCH" \
128+
--head "$SOURCE_BRANCH" \
129+
--title "$PR_TITLE" \
130+
--body "Merge \`$SOURCE_BRANCH\` into \`$TARGET_BRANCH\` after version bump \`$VERSION\`.
131+
132+
> **Important**: Use **Merge commit** (not squash) when merging this PR to preserve commit history.
133+
134+
---
135+
*This PR was created automatically by \`scripts/merge-to-release.sh\`.*")
136+
137+
echo ""
138+
info "Done! PR created: $PR_URL"
139+
echo ""
140+
echo "⚠️ Remember: Use \"Merge commit\" (not squash) when merging this PR."

0 commit comments

Comments
 (0)