Skip to content

Commit 46e4f8c

Browse files
author
Shaurya Singh
committed
fix: improve release summary prompt to stop after code block
- Clearer instructions to not generate content after code block - Better emoji formatting for GitHub-ready output - Simplified copy-ready section structure
1 parent cbc42cb commit 46e4f8c

File tree

1 file changed

+29
-12
lines changed

1 file changed

+29
-12
lines changed

src/ai/prompts.ts

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -233,33 +233,50 @@ ${recentPRs.map(pr => `- #${pr.number}: ${pr.title} (${pr.labels.join(', ')})`).
233233
Last Release:
234234
${snapshot.releases[0] ? `${snapshot.releases[0].tag_name}: ${snapshot.releases[0].name}` : 'No releases found'}
235235
236-
Create a Release Summary in this EXACT format:
236+
Create a Release Summary in this EXACT format. DO NOT add any content after the final code block.
237237
238238
# Release Summary
239239
240240
## Features
241-
[New features and enhancements]
241+
[New features and enhancements - bullet points with commit SHAs]
242242
243243
## Fixes
244-
[Bug fixes and corrections]
244+
[Bug fixes and corrections - bullet points with commit SHAs]
245245
246246
## Internal
247-
[Refactoring, dependencies, tooling]
247+
[Refactoring, dependencies, tooling - keep brief]
248248
249249
## Breaking Changes
250-
[Any breaking changes - be explicit]
250+
[Any breaking changes - be explicit, or "None" if none]
251251
252252
## Upgrade Notes
253-
[What users need to do to upgrade]
253+
[What users need to do to upgrade, or "No action required" if none]
254254
255-
## Copy-Ready GitHub Release
256-
\`\`\`markdown
257-
[Formatted release notes ready to paste]
255+
---
256+
257+
**Copy-Ready Release Notes** (paste directly into GitHub Releases):
258+
259+
\`\`\`
260+
# What's New
261+
262+
## ✨ Features
263+
[Concise list for end users]
264+
265+
## 🐛 Bug Fixes
266+
[Concise list for end users]
267+
268+
## ⚠️ Breaking Changes
269+
[If any]
270+
271+
---
272+
Full changelog: [link to commits]
258273
\`\`\`
259274
260-
Use ${tone === 'detailed' ? 'complete technical detail' : 'concise bullet points'}.
261-
Reference commit SHAs and PR numbers.
262-
Identify breaking changes carefully.`;
275+
IMPORTANT:
276+
- Use ${tone === 'detailed' ? 'complete technical detail' : 'concise bullet points'}.
277+
- Reference commit SHAs in parentheses like (abc1234).
278+
- The code block above is the FINAL output. Do NOT write anything after it.
279+
- Keep "Internal" section brief - users care most about Features and Fixes.`;
263280
}
264281

265282
/**

0 commit comments

Comments
 (0)