Semantic Changelog Generator

Generate beautiful changelogs from git commits using Conventional Commits. Automatic semantic versioning, categorized changes, and professional release notes. Simpler alternative to semantic-release.

Features

• Automatic Changelog: Generate from git history
• Semantic Versioning: Auto-suggest version bumps (major/minor/patch)
• Conventional Commits: Parse and categorize commits
• Release Notes: Professional formatting
• Multiple Formats: Markdown, JSON, HTML, Keep a Changelog

Operations

1. Generate Changelog

Create comprehensive changelog from commits:

• Categorize by type (features, fixes, breaking)
• Group by scope or author
• Include commit links and references
• Format for documentation

2. Analyze Commits

Understand commit patterns:

• Conventional commit compliance rate
• Commit type distribution
• Author contributions
• Breaking change frequency

3. Suggest Version

Automatic semantic version bumping:

• Major (x.0.0): Breaking changes
• Minor (0.x.0): New features
• Patch (0.0.x): Bug fixes

4. Format Release Notes

Generate GitHub/GitLab release notes:

• Professional formatting
• Summary statistics
• Breaking change warnings
• Installation instructions

5. Export Markdown

Export to CHANGELOG.md:

• Keep a Changelog format
• Semantic versioning compliance
• Ready for version control

Conventional Commits

Format: type(scope): subject

Types

• feat: New feature (minor bump)
• fix: Bug fix (patch bump)
• docs: Documentation changes
• style: Code style changes
• refactor: Code refactoring
• perf: Performance improvements
• test: Test changes
• build: Build system changes
• ci: CI/CD changes
• chore: Other changes

Breaking Changes

• Add ! after type: feat!: redesign API
• Or include BREAKING CHANGE: in body

Input Parameters

• operation: Operation to perform (required)
• repositoryUrl: Git repository URL
• gitToken: Access token for private repos
• fromVersion: Starting version/tag
• toVersion: Ending version/tag (default: HEAD)
• currentVersion: Current version for suggestions
• preset: Commit convention (conventional, angular, etc.)
• includeAll: Include non-conventional commits
• groupBy: Group by type, scope, author, or none
• includeAuthors: Show commit authors
• includeLinks: Link to commits and issues
• format: Output format (markdown, json, html, keepachangelog)

Use Cases

1. Release Automation: Generate changelogs for every release
2. Version Management: Auto-determine version bumps
3. Documentation: Maintain CHANGELOG.md automatically
4. Release Notes: Create GitHub/GitLab release descriptions
5. Commit Analysis: Monitor team commit quality

Example

{
  "operation": "generateChangelog",
  "repositoryUrl": "https://github.com/facebook/react",
  "fromVersion": "v18.0.0",
  "toVersion": "HEAD",
  "currentVersion": "18.0.0",
  "groupBy": "type",
  "includeAuthors": true,
  "includeLinks": true,
  "format": "markdown"
}

Output Example

## [18.1.0] - 2024-01-15

### ⚠ BREAKING CHANGES

- **api**: redesign hook system (John Doe) ([abc123](commit/abc123))

### ✨ Features

- **auth**: add OAuth2 support (Jane Smith) ([def456](commit/def456))
- **ui**: new component library (Bob Johnson) ([ghi789](commit/ghi789))

### 🐛 Bug Fixes

- **core**: fix memory leak (Alice Williams) ([jkl012](commit/jkl012))
- **api**: handle null responses (Charlie Brown) ([mno345](commit/mno345))

Semantic Versioning Rules

Given version MAJOR.MINOR.PATCH:

1. MAJOR: Incompatible API changes (breaking changes)
2. MINOR: Add functionality (backward-compatible)
3. PATCH: Bug fixes (backward-compatible)

Comparison to Alternatives

vs semantic-release

• Simpler: No complex configuration
• Faster: Quick changelog generation
• Flexible: Multiple output formats
• Standalone: No CI/CD integration required

vs conventional-changelog

• All-in-one: Includes version suggestion
• Cloud-based: No local setup
• Automated: Zero configuration

Market Gap

Simpler alternative to semantic-release with zero configuration. Perfect for teams wanting automated changelogs without complex CI/CD setup.

Target MAU: 400