Release Notes Generator
A tool that generates release notes from git tags, conventional commits, and PR descriptions with categorization and formatting. Supports multiple output formats, contributor listing, and automatic...
Target user
Open source maintainers and release managers
Problem
Release managers need to generate formatted release notes from commit history and PRs without manually reviewing every change between releases.
Requirements
- Generate notes from git tag range
- Categorize changes by commit type
- Include PR descriptions and links
- List contributors for the release
- Support Markdown and HTML output
Core technologies
TypeScript, simple-git, CLI
Completion criteria
Users can generate categorized release notes from git history with contributor listing and multiple formats.
Optional extensions
- Add auto-version bumping
- Implement GitHub release creation
- Add changelog integration
- Support custom templates
Project phases
Phase 1: Phase 1: Git Analysis
Tasks: Set up TypeScript project, Retrieve commits between tags, Parse conventional commit format, Fetch PR descriptions
Phase 2: Phase 2: Categorization
Tasks: Group changes by type, Extract contributor list, Sort entries by importance, Build release notes structure
Phase 3: Phase 3: Output
Tasks: Generate Markdown output, Add HTML output format, Create CLI interface, Write documentation