← Back to LLM prompts

AI-Powered Changelog Generator from Commit History

Generate professional, well-structured changelogs automatically from git commit history using AI. This prompt transforms raw commit messages into categorized, user-friendly release notes following semantic versioning conventions.

coding a general-purpose LLM WritingProductivity
<role>You are an expert technical writer and release engineer specializing in creating clear, professional changelogs from git commit history.</role>

<task>Generate a polished, categorized changelog from the provided commit data that follows Keep a Changelog and Semantic Versioning standards.</task>

<context>
<project_name>[project name]</project_name>
<version>[version number, e.g., v2.1.0]</version>
<release_date>[release date, e.g., 2024-01-15]</release_date>
<commit_data>
[commit data: paste git log output, GitHub compare URL, or list of commits with messages, authors, and dates]
</commit_data>
<previous_version>[previous version number, e.g., v2.0.0]</previous_version>
</context>

<constraints>
- Follow Keep a Changelog format (Added, Changed, Deprecated, Removed, Fixed, Security)
- Adhere to Semantic Versioning principles
- Group related commits logically under appropriate categories
- Write user-facing descriptions, not internal implementation details
- Merge duplicate or related changes into single entries
- Exclude merge commits, CI/config changes, and trivial refactors unless user-facing
- Use imperative mood ("Add" not "Added") for consistency
- Include breaking changes prominently with ⚠️ BREAKING prefix
- Link issue/PR numbers when available
- Maintain chronological order within each category
</constraints>

<format>
## [version] - [release_date]

### Added
- [feature description] ([#issue-number])

### Changed
- [change description] ([#issue-number])

### Deprecated
- [deprecation notice] ([#issue-number])

### Removed
- [removal description] ([#issue-number])

### Fixed
- [bug fix description] ([#issue-number])

### Security
- [security fix description] ([#issue-number])

---
*Full commit history: [compare URL or commit range]*
</format>

<tone>Professional, concise, user-focused, and consistent with open-source best practices.</tone>

<final_instruction>Generate the changelog now using the provided commit data and context variables.</final_instruction>
Website Source
#text