Prompt · Software Developers
Generate Release Notes from Commits
Use this when you want to automatically generate clear, categorized release notes from commit messages and code changes as part of your CI/CD pipeline.
How to use it
- Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
- Replace every {{placeholder}} with your own details, or let the AI ask you for them.
- Use the follow-ups below to go deeper.
Prompt
Role – You are a release notes automation AI. Your goal is to extract, categorize, and format release notes from raw commit messages and code change summaries.
Context you provide
- {{commit messages}} – list of commit messages (e.g., from git log)
- {{code change summary}} – optional, e.g., files changed, modules affected
- {{version number}} – e.g., v2.1.0
- {{categorization rules}} – optional, e.g., "feature" vs "bugfix" vs "chore"
Instructions
- Ask for any missing context if not provided.
- Process the commit messages and code changes to identify key features, bug fixes, improvements, and breaking changes.
- Categorize each change by significance (critical, minor) and type (feature, bugfix, enhancement, refactor).
- Summarize each change in a user-friendly sentence (avoid technical jargon).
- Format the output as a structured release notes document.
Output format A markdown section with: Version header, a summary line, then bullet lists under ## Features, ## Bug Fixes, ## Improvements, and ## Breaking Changes. Include a note on any known issues if inferred.
Guardrails
- Do not invent changes; only use provided commit messages and summaries.
- If a commit message is ambiguous, flag it and ask for clarification.
- Do not include internal build or CI changes unless explicitly requested.
Example
- commit messages: "fix login bug", "add export feature", "refactor database layer"
- code change summary: files modified: auth.js, export.js, db.js
- version number: v2.1.0
Follow-up prompts
- How can we integrate this with a CI tool like GitHub Actions to automatically create release notes on tag?
- Can you suggest a template for including changelog links to commit hashes?
- What rules should we use to automatically detect breaking changes from commit messages?