-
-
Notifications
You must be signed in to change notification settings - Fork 432
326 lines (289 loc) · 14 KB
/
release-draft.yaml
File metadata and controls
326 lines (289 loc) · 14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
name: Release Draft
on:
# Use pull_request_target to always use the workflow file from main branch
# This ensures new PRs from branches that don't have the latest workflow will still work
# Security note: This is safe because we only run on merged PRs (code is already in main)
pull_request_target:
types: [closed]
branches: [main]
# Prevent race conditions when multiple PRs merge simultaneously
concurrency:
group: release-draft
cancel-in-progress: false
permissions:
contents: write
pull-requests: write
jobs:
analyze-and-draft:
# Only run on merged PRs that haven't been analyzed yet
if: |
github.event.pull_request.merged == true &&
!contains(github.event.pull_request.labels.*.name, 'breaking-change-analyzed')
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Ensure labels exist
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Create labels if they don't exist (ignore errors if already exist)
gh label create "breaking-change-analyzed" --color "0E8A16" --description "PR has been analyzed for breaking changes" 2>/dev/null || true
gh label create "breaking-change" --color "D93F0B" --description "PR contains breaking changes" 2>/dev/null || true
- name: Run Claude Code Analysis
id: claude
timeout-minutes: 10
uses: anthropics/claude-code-action@v1
with:
# OAuth authentication for Max plan subscribers
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
github_token: ${{ secrets.GITHUB_TOKEN }}
show_full_output: true
prompt: |
Analyze PR #${{ github.event.pull_request.number }} for breaking changes.
PR Title: ${{ github.event.pull_request.title }}
PR Body:
${{ github.event.pull_request.body }}
Analyze the merged changes and determine if this PR contains breaking changes.
Breaking changes for datamodel-code-generator include:
1. Code Generation Changes - Changes to generated code output that may break existing users
2. Custom Template Update Required - Changes requiring users to update their Jinja2 templates
3. API/CLI Changes - Changes to command-line options or Python API
4. Default Behavior Changes - Changes to default values or behavior
5. Python Version Changes - Dropping Python version support
6. Error Handling Changes - Changes to how errors are reported or handled
If breaking changes are found, format them EXACTLY like this CHANGELOG.md format:
### Category Name
* Description of breaking change - Detailed explanation (#${{ github.event.pull_request.number }})
Rules:
- Each category should be a ### heading (Code Generation Changes, Custom Template Update Required, etc.)
- Each item starts with "* " followed by a brief title, then " - " and detailed explanation
- Include PR number at the end as (#NUMBER)
- If code examples help, include them in markdown code blocks
- Only include categories that have actual breaking changes
- Return empty string for breaking_changes_content if no breaking changes
claude_args: |
--model claude-opus-4-6
--max-turns 50
--json-schema '{"type":"object","properties":{"has_breaking_changes":{"type":"boolean","description":"Whether this PR contains breaking changes"},"breaking_changes_content":{"type":"string","description":"Formatted breaking changes section content (without ## Breaking Changes header), or empty string if none"},"reasoning":{"type":"string","description":"Brief explanation of why this is or is not a breaking change"}},"required":["has_breaking_changes","breaking_changes_content","reasoning"]}'
- name: Parse Claude output
id: parse
env:
CLAUDE_OUTPUT: ${{ steps.claude.outputs.structured_output }}
run: |
# Parse structured output from Claude using env var to avoid shell injection
HAS_BC=$(echo "$CLAUDE_OUTPUT" | jq -r '.has_breaking_changes // false')
BC_CONTENT=$(echo "$CLAUDE_OUTPUT" | jq -r '.breaking_changes_content // ""')
REASONING=$(echo "$CLAUDE_OUTPUT" | jq -r '.reasoning // ""')
echo "has_breaking_changes=$HAS_BC" >> $GITHUB_OUTPUT
# Use unique delimiter to avoid collision with content
DELIMITER="EOF_$(date +%s%N)"
# Use heredoc for multiline content with unique delimiter
{
echo "breaking_changes_content<<$DELIMITER"
printf '%s\n' "$BC_CONTENT"
echo "$DELIMITER"
} >> $GITHUB_OUTPUT
{
echo "reasoning<<$DELIMITER"
printf '%s\n' "$REASONING"
echo "$DELIMITER"
} >> $GITHUB_OUTPUT
- name: Add breaking-change-analyzed label
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh pr edit ${{ github.event.pull_request.number }} --add-label "breaking-change-analyzed"
- name: Add breaking-change label if applicable
if: steps.parse.outputs.has_breaking_changes == 'true'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh pr edit ${{ github.event.pull_request.number }} --add-label "breaking-change"
- name: Post analysis result to PR
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
HAS_BC: ${{ steps.parse.outputs.has_breaking_changes }}
BC_CONTENT: ${{ steps.parse.outputs.breaking_changes_content }}
REASONING: ${{ steps.parse.outputs.reasoning }}
run: |
# Use temp file to avoid shell escaping issues with special characters
TMPFILE=$(mktemp)
trap 'rm -f "$TMPFILE"' EXIT
# Build comment using printf to avoid YAML parsing issues with markdown
{
printf '## Breaking Change Analysis\n\n'
if [ "$HAS_BC" = "true" ]; then
printf 'Result: Breaking changes detected\n\n'
printf 'Reasoning: %s\n\n' "$REASONING"
printf '### Content for Release Notes\n\n%s\n\n' "$BC_CONTENT"
else
printf 'Result: No breaking changes detected\n\n'
printf 'Reasoning: %s\n\n' "$REASONING"
fi
printf -- '---\n'
printf '*This analysis was performed by Claude Code Action*\n'
} > "$TMPFILE"
gh pr comment ${{ github.event.pull_request.number }} --body-file "$TMPFILE"
- name: Calculate version and update draft release
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
HAS_BC: ${{ steps.parse.outputs.has_breaking_changes }}
BC_CONTENT: ${{ steps.parse.outputs.breaking_changes_content }}
run: |
set -euo pipefail
# Get latest published release tag and strip "v" prefix if present
LATEST_TAG_RAW=$(gh release list --limit 1 --exclude-drafts --json tagName --jq '.[0].tagName // "0.0.0"')
LATEST_TAG="${LATEST_TAG_RAW#v}"
LATEST_TAG="${LATEST_TAG#V}"
echo "Latest published tag: $LATEST_TAG_RAW (parsed as: $LATEST_TAG)"
# Parse version components (format: 0.xx.yy)
MAJOR=$(echo "$LATEST_TAG" | cut -d. -f1)
MINOR=$(echo "$LATEST_TAG" | cut -d. -f2)
PATCH=$(echo "$LATEST_TAG" | cut -d. -f3)
# Validate version components are numeric
if ! [[ "$MAJOR" =~ ^[0-9]+$ ]] || ! [[ "$MINOR" =~ ^[0-9]+$ ]] || ! [[ "$PATCH" =~ ^[0-9]+$ ]]; then
echo "Warning: Could not parse version from tag '$LATEST_TAG_RAW', using 0.0.0"
MAJOR=0
MINOR=0
PATCH=0
fi
# Check if draft release exists (use jq to extract first draft tag safely)
# Keep raw tag name for gh commands, strip prefix only for version comparison
DRAFT_TAG_RAW=$(gh release list --json tagName,isDraft --jq '[.[] | select(.isDraft == true)] | .[0].tagName // ""')
DRAFT_TAG="${DRAFT_TAG_RAW#v}"
DRAFT_TAG="${DRAFT_TAG#V}"
BC_SOURCE_TAG_RAW="$DRAFT_TAG_RAW"
# Determine next version
if [ -n "$DRAFT_TAG" ]; then
echo "Existing draft: $DRAFT_TAG_RAW"
DRAFT_MINOR=$(echo "$DRAFT_TAG" | cut -d. -f2)
DRAFT_PATCH=$(echo "$DRAFT_TAG" | cut -d. -f3)
# If this PR has breaking changes and draft is a patch release, upgrade to minor
if [ "$HAS_BC" = "true" ] && [ "$DRAFT_PATCH" != "0" ]; then
echo "Upgrading from patch to minor release due to breaking changes"
NEW_MINOR=$((MINOR + 1))
NEXT_VERSION="${MAJOR}.${NEW_MINOR}.0"
OLD_DRAFT_TAG="$DRAFT_TAG_RAW"
DRAFT_TAG_RAW=""
DRAFT_TAG=""
else
NEXT_VERSION="$DRAFT_TAG"
OLD_DRAFT_TAG=""
fi
else
OLD_DRAFT_TAG=""
BC_SOURCE_TAG_RAW=""
# No draft exists, calculate new version
if [ "$HAS_BC" = "true" ]; then
NEW_MINOR=$((MINOR + 1))
NEXT_VERSION="${MAJOR}.${NEW_MINOR}.0"
else
NEW_PATCH=$((PATCH + 1))
NEXT_VERSION="${MAJOR}.${MINOR}.${NEW_PATCH}"
fi
fi
echo "Next version: $NEXT_VERSION"
# Generate release notes using gh (same as GitHub UI)
# Only include previous_tag_name if a prior release exists (check normalized version)
if [ -n "$LATEST_TAG" ] && [ "$LATEST_TAG" != "0.0.0" ]; then
GENERATED_NOTES=$(gh api \
--method POST \
-H "Accept: application/vnd.github+json" \
/repos/${{ github.repository }}/releases/generate-notes \
-f tag_name="$NEXT_VERSION" \
-f previous_tag_name="$LATEST_TAG_RAW" \
--jq '.body')
else
# First release - generate notes without previous tag
GENERATED_NOTES=$(gh api \
--method POST \
-H "Accept: application/vnd.github+json" \
/repos/${{ github.repository }}/releases/generate-notes \
-f tag_name="$NEXT_VERSION" \
--jq '.body')
fi
# Get existing draft body if updating (only if DRAFT_TAG_RAW is set, meaning we're updating same version)
EXISTING_BC=""
if [ -n "$BC_SOURCE_TAG_RAW" ]; then
EXISTING_BODY=$(gh release view "$BC_SOURCE_TAG_RAW" --json body --jq '.body // ""')
# Extract existing Breaking Changes section content
# Use awk for precise extraction - stops at any ## header that's not "## Breaking Changes"
if echo "$EXISTING_BODY" | grep -q '^## Breaking Changes$'; then
EXISTING_BC=$(echo "$EXISTING_BODY" | awk '
/^## Breaking Changes$/ { found=1; next }
found && /^## / { exit }
found { print }
')
fi
fi
# Build final release body using printf to avoid YAML parsing issues
# Merge breaking changes sections with same headings
FINAL_BC=""
if [ -n "$BC_CONTENT" ] && [ -n "$EXISTING_BC" ]; then
# Merge sections with same ### headings to avoid duplicates
# Preserves blank lines inside fenced code blocks
MERGED_BC=$(printf '%s\n\n%s' "$EXISTING_BC" "$BC_CONTENT" | awk '
BEGIN { current_section = ""; in_fence = 0; }
/^```/ || /^~~~/ { in_fence = !in_fence; }
/^### / && !in_fence {
current_section = $0;
if (!(current_section in sections)) {
order[++order_count] = current_section;
}
next;
}
/^[[:space:]]*$/ && !in_fence { next; }
current_section != "" {
if (sections[current_section] != "") {
sections[current_section] = sections[current_section] "\n" $0;
} else {
sections[current_section] = $0;
}
}
END {
for (i = 1; i <= order_count; i++) {
section = order[i];
if (i > 1) print "";
print section;
print sections[section];
}
}
')
FINAL_BC=$(printf '## Breaking Changes\n\n%s' "$MERGED_BC")
elif [ -n "$BC_CONTENT" ]; then
FINAL_BC=$(printf '## Breaking Changes\n\n%s' "$BC_CONTENT")
elif [ -n "$EXISTING_BC" ]; then
FINAL_BC=$(printf '## Breaking Changes\n\n%s' "$EXISTING_BC")
fi
if [ -n "$FINAL_BC" ]; then
RELEASE_BODY=$(printf '%s\n\n%s' "$FINAL_BC" "$GENERATED_NOTES")
else
RELEASE_BODY="$GENERATED_NOTES"
fi
# Create or update draft release
if [ -n "$DRAFT_TAG_RAW" ] && [ "$DRAFT_TAG" = "$NEXT_VERSION" ]; then
echo "Updating existing draft release: $DRAFT_TAG_RAW"
echo "$RELEASE_BODY" | gh release edit "$DRAFT_TAG_RAW" \
--title "$NEXT_VERSION" \
--notes-file -
else
echo "Creating new draft release: $NEXT_VERSION"
# Create new draft first, then delete old one (to prevent data loss)
if echo "$RELEASE_BODY" | gh release create "$NEXT_VERSION" \
--title "$NEXT_VERSION" \
--notes-file - \
--draft; then
# Only delete old draft after successful creation
if [ -n "$OLD_DRAFT_TAG" ]; then
echo "Deleting old draft: $OLD_DRAFT_TAG"
gh release delete "$OLD_DRAFT_TAG" --yes 2>/dev/null || true
fi
else
echo "Failed to create new draft release"
exit 1
fi
fi
echo "Draft release updated: $NEXT_VERSION"