Release Announcement Generation Prompt
This prompt template generates release announcements from CHANGELOG.md entries. Use with Claude Code or other AI assistants to create polished, engaging announcements.
Input Variables
Before using this prompt, gather the following information:
- Version: (e.g., v1.2.0)
- Release Date: (e.g., 2025-12-25)
- Release Type: (Major/Minor/Patch)
- Changelog: (latest section from CHANGELOG.md)
- Target Audience: (Developers/End Users/Mixed)
- Tone: (Professional/Casual/Technical/Marketing)
- Output Format: (Blog Post/Social Media/Email Newsletter/GitHub Discussion)
AI Prompt Template
You are a technical content writer creating a release announcement for version of .
### Context
- **Release Version:**
- **Release Date:**
- **Release Type:**
- **Target Audience:**
- **Tone:**
- **Output Format:**
### Changelog Content
### Instructions
Create a compelling release announcement that includes:
1. **Headline**
- Catchy, descriptive title that highlights the main value proposition
- Should be under 100 characters for social media compatibility
- Examples:
- " : Faster, Stronger, Better"
- "Introducing with "
- " – "
2. **Opening Paragraph**
- Brief, engaging introduction (2-3 sentences)
- State what's new and why it matters
- Hook the reader to continue
3. **Key Features Section**
- Highlight 3-5 most important changes
- Focus on benefits, not just features
- Use bullet points for scannability
- Include code examples for technical features (if applicable)
4. **Breaking Changes** (if applicable)
- Clear warning about breaking changes
- Brief migration guidance or link to full guide
- Estimated upgrade effort
5. **Migration Notes** (if breaking changes)
- Step-by-step upgrade instructions
- Common pitfalls to avoid
- Support resources
6. **Performance Metrics** (if applicable)
- Quantify improvements with numbers
- Use comparisons (e.g., "40% faster than v1.1.0")
- Include benchmarks or charts
7. **Community Recognition**
- Thank contributors by name (if available)
- Highlight first-time contributors
- Link to contributor profiles
8. **What's Next**
- Tease upcoming features
- Link to roadmap or project board
- Invite community feedback
9. **Call to Action**
- Clear next steps (download, upgrade, try it)
- Links to documentation, changelog, GitHub release
- Support channels for questions
### Style Guidelines
- Use active voice
- Write conversationally but professionally
- Explain technical concepts clearly for
- Keep paragraphs short (2-4 sentences)
- Use headings and bullet points for structure
- Include relevant links and resources
- Proofread for grammar and clarity
### Special Instructions for
- Target length: 800-1200 words
- Include table of contents
- Add relevant images/screenshots (describe where needed)
- SEO-friendly meta description (160 characters)
- Include code examples with syntax highlighting
- Add "Related Posts" section at end
Generate variants for:
- **Twitter/X:** Under 280 characters, include hashtags
- **LinkedIn:** 1-3 paragraphs, professional tone
- **Mastodon:** Under 500 characters, technical community focus
- **Bluesky:** Under 300 characters, casual but informative
Include:
- Emoji use (sparingly, 1-2 per post)
- Relevant hashtags (# #release #opensource)
- Visual assets needed (screenshot, banner, demo GIF)
- Subject line variants (3 options, A/B test ready)
- Preheader text (preview text, ~100 characters)
- Mobile-friendly formatting
- Clear CTA buttons
- Footer with links to: documentation, GitHub, support, unsubscribe
- Use GitHub-flavored Markdown
- Link to related issues and PRs
- Include checkboxes for user feedback
- Tag relevant users/teams
- Enable reactions for quick feedback
- Pin important notices
### Output Format
Provide the announcement in clean Markdown format, ready to publish.
Include all sections outlined above.
Add YAML frontmatter if the format requires it.
Example Usage
For Blog Post
# Extract latest changelog entry
VERSION=$(grep -m 1 "^## " CHANGELOG.md | sed 's/## \[\(.*\)\].*/\1/')
DATE=$(date +%Y-%m-%d)
CHANGELOG=$(awk '/^## \[/{if(++n==1)print;next}/^## \[/{exit}n==1' CHANGELOG.md)
# Generate with Claude Code
cat templates/release/announcement.prompt.md | \
sed "s//${VERSION}/g" | \
sed "s//${DATE}/g" | \
sed "s//Minor/g" | \
sed "s//${CHANGELOG}/g" | \
sed "s//Developers/g" | \
sed "s//Professional/g" | \
sed "s//Blog Post/g" | \
claude-code prompt
For Social Media Snippets
# Generate Twitter/X announcement
echo "Create a Twitter/X announcement for release.
Key features:
-
-
-
Requirements:
- Under 280 characters
- Include 2-3 relevant hashtags
- Add one emoji
- Link to GitHub release
- Engaging and professional tone
" | claude-code prompt
Post-Generation Checklist
After generating the announcement:
- Verify all version numbers are correct
- Confirm all links work (changelog, docs, GitHub release)
- Check for typos and grammar errors
- Ensure tone matches brand voice
- Validate code examples compile/run
- Test formatting in target platform
- Review for accessibility (alt text, heading structure)
- Get peer review before publishing
- Add tracking parameters to links (UTM codes)
- Schedule cross-posting to all relevant channels
Multi-Channel Distribution
Generate announcements for all channels:
# Blog post
./generate-announcement.sh --format=blog
# Social media variants
./generate-announcement.sh --format=social
# Email newsletter
./generate-announcement.sh --format=email
# GitHub Discussion
./generate-announcement.sh --format=github
# All formats
./generate-announcement.sh --format=all
Social Media Snippet Templates
Twitter/X Template (280 chars max)
is live!
📖 Changelog:
⬇️ Download:
# #release #opensource
LinkedIn Template (1-3 paragraphs)
I'm excited to announce the release of ! 🎉
Key highlights:
•
•
•
This release wouldn't be possible without our amazing contributors. Thank you to everyone who reported issues, submitted PRs, and participated in discussions.
Learn more and download:
# #OpenSource #SoftwareDevelopment #
Mastodon Template (500 chars max)
released! 🚀
Full changelog:
Docs:
# #opensource # #release
Bluesky Template (300 chars max)
drops today!
New:
Get it:
Blog Post Structure Template
---
title: " : "
date:
author:
tags: [release, , ]
description: ""
image: /images/releases/-banner.png
---
# :
## Table of Contents
- [What's New](#whats-new)
- [Breaking Changes](#breaking-changes)
- [Migration Guide](#migration-guide)
- [Performance Improvements](#performance-improvements)
- [Contributors](#contributors)
- [What's Next](#whats-next)
- [Get Started](#get-started)
## What's New
###
###
###
## Breaking Changes
⚠️ **Important:** This release contains breaking changes.
See the [Migration Guide](#migration-guide) below for upgrade instructions.
✅ No breaking changes in this release!
## Migration Guide
## Performance Improvements
## Contributors
## What's Next
## Get Started
---
**Related Posts:**
-
-
-
Automation Hook
Integrate with changelog workflow:
# .github/workflows/release-announcement.yml
- name: Generate release announcement
run: |
VERSION=$(cat version.txt)
CHANGELOG=$(awk '/^## \[/{if(++n==1)print;next}/^## \[/{exit}n==1' CHANGELOG.md)
# Generate blog post
./scripts/generate-announcement.sh \
--version="$VERSION" \
--changelog="$CHANGELOG" \
--format=blog \
--output=content/blog/release-${VERSION}.md
# Generate social snippets
./scripts/generate-announcement.sh \
--version="$VERSION" \
--changelog="$CHANGELOG" \
--format=social \
--output=content/social/release-${VERSION}.md
Quality Checklist
Before publishing:
✅ Accuracy
- Version numbers correct
- Feature descriptions accurate
- Code examples tested
- Links valid
- Statistics verified
✅ Clarity
- Technical jargon explained
- Benefits over features emphasized
- Clear migration path (if breaking)
- Actionable next steps
✅ Completeness
- All major features covered
- Contributors acknowledged
- Known issues mentioned
- Support channels linked
✅ Consistency
- Brand voice maintained
- Formatting uniform
- Terminology consistent
- Cross-references aligned
✅ Accessibility
- Alt text for images
- Heading hierarchy correct
- Color contrast sufficient
- Screen reader friendly
Generated from templates/release/announcement.prompt.md