AI Changelog Generator

AI-powered changelog generation that analyzes your actual code changes

Transform your git commits into professional, detailed changelogs using advanced AI analysis of diffs, file changes, and code context. Works with 10+ AI providers including OpenAI, Anthropic Claude, Google, Azure, Amazon Bedrock, and local models.

This tool revolutionizes changelog generation by analyzing actual code changes, not just commit messages. It helps developers create professional release notes automatically and provides intelligent categorization with user-focused summaries.

Features

AI Code Analysis Analyzes actual diffs and code changes, not just commit messages, for intelligent categorization

Multi-Provider Support Works with OpenAI, Claude, Google, Azure, Bedrock, and local models like Ollama

Multiple Output Formats Markdown, JSON, and customizable templates with conventional commits and emoji support

MCP Integration Model Context Protocol server for Claude Desktop and other MCP-compatible tools

Quick Start

Installation

# Install globally
npm install -g @entro314labs/ai-changelog-generator

# Or use directly with npx
npx @entro314labs/ai-changelog-generator init

# Or clone and run from source
git clone https://github.com/entro314-labs/AI-changelog-generator.git
cd AI-changelog-generator
npm install

Basic Usage

Using installed package

# Generate changelog from recent commits
ai-changelog

# Interactive mode with guided setup
ai-changelog --interactive

# Analyze working directory changes
ai-changelog working-dir

# Start MCP server
ai-changelog-mcp

# Get help
ai-changelog --help

Using bash wrappers (from source)

# Generate changelog from recent commits
./ai-changelog.sh

# Interactive mode with guided setup
./ai-changelog.sh --interactive

# Analyze working directory changes
./ai-changelog.sh working-dir

# Start MCP server
./ai-changelog-mcp.sh

# Get help
./ai-changelog.sh --help

💡 Bash Wrappers: The .sh scripts automatically validate your Node.js environment, install dependencies if needed, and provide helpful error messages. Perfect for development, CI/CD, and direct execution from source.

That's it! Your AI-powered changelog is ready to generate.

Demo

Interactive Mode

See the tool in action with our interactive mode demo:

Interactive mode with guided setup and provider selection

Quick Generation

Watch how fast you can generate professional changelogs:

Generate changelogs from recent commits in seconds

Video Walkthrough

For a complete walkthrough of features and capabilities:

📺 Watch Full Demo Video

How It Works

1. Code Analysis: Analyzes actual git diffs and file changes using advanced AI models
2. Smart Categorization: Automatically categorizes changes by type (feature, fix, refactor, etc.) and impact
3. User-Focused Summaries: Translates technical changes into clear, user-friendly descriptions
4. Professional Output: Generates conventional commit-compliant changelogs with links and formatting

Supported Technologies

AI Providers

Runtime

Git Integration

Output Formats

Core Commands

# Changelog generation
ai-changelog                              # Generate from recent commits
ai-changelog --since v1.0.0               # Generate since specific tag
ai-changelog --release-version 2.0.0      # Set release version

# Analysis modes
ai-changelog --detailed                    # Detailed technical analysis
ai-changelog --enterprise                  # Enterprise-grade analysis
ai-changelog --interactive                 # Interactive guided mode

# Working directory
ai-changelog working-dir                   # Analyze uncommitted changes
ai-changelog working-dir --dry-run         # Preview without saving

# Utilities
ai-changelog providers list                # List available AI providers
ai-changelog validate                      # Validate configuration
ai-changelog health                        # Repository health check

Configuration

AI Provider Setup

# Configure your preferred AI provider
ai-changelog providers configure openai

# Environment variables (.env.local)
OPENAI_API_KEY=your_openai_key
ANTHROPIC_API_KEY=your_anthropic_key
AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com/
GOOGLE_API_KEY=your_google_key

YAML Configuration (ai-changelog.config.yaml)

changelog:
  commitTypes:
    - feat
    - fix
    - perf
    - refactor
    - docs
    - build
    - chore

  headlines:
    feat: "🚀 Features"
    fix: "🐛 Bug Fixes"
    perf: "⚡ Performance"
    refactor: "♻️ Refactoring"
    docs: "📚 Documentation"

  commitUrl: "https://github.com/user/repo/commit/%commit%"
  issueUrl: "https://github.com/user/repo/issues/%issue%"

Examples

Basic Project Setup

# Generate changelog for recent commits
ai-changelog

# Generate since specific version
ai-changelog --since v1.0.0 --release-version 2.0.0

# Interactive mode with provider selection
ai-changelog --interactive

Advanced Usage

# Detailed analysis with custom model
ai-changelog --detailed --model gpt-4o

# Working directory analysis with preview
ai-changelog working-dir --dry-run --output CHANGES.md

# MCP server for Claude Desktop integration
ai-changelog-mcp

CI/CD Integration

# Generate changelog in CI pipeline
ai-changelog --since $LAST_TAG --release-version $NEW_VERSION --silent

# Validate configuration
ai-changelog validate --exit-code

# Health check before release
ai-changelog health --detailed

Documentation

• Getting Started Guide - Complete setup and first changelog
• AI Provider Setup - Configure OpenAI, Claude, and other providers
• Configuration Reference - All YAML and environment options
• MCP Integration - Claude Desktop and MCP server setup
• Desktop Extension (MCPB) - Build and package as Claude Desktop Extension
• API Reference - All commands, options, and programmatic usage
• Demo Media - Interactive demos, GIFs, and video walkthroughs

Claude Desktop Extension

Install AI Changelog Generator in Claude Desktop with one click using the MCPB (MCP Bundle) format:

1. Download the latest .mcpb file from Releases
2. Open Claude Desktop → Settings → Extensions
3. Drag and drop the .mcpb file
4. Click "Install"

No configuration files, no terminal commands - just drag, drop, and start generating changelogs!

For developers: Learn how to build and package the extension in MCPB_BUILD.md

# Build Desktop Extension
pnpm mcpb:validate  # Validate manifest
pnpm mcpb:pack      # Create .mcpb file

Contributing

We welcome contributions! Please see our Contributing Guide for details.

• Report bugs
• Request features
• Improve documentation
• Submit pull requests

Roadmap

• [ ] Visual Studio Code Extension - Native VS Code integration with diff analysis
• [ ] Semantic Release Integration - Automatic version bumping and publishing
• [ ] Multi-Repository Support - Analyze and generate changelogs across multiple repos
• [ ] Custom AI Model Training - Fine-tuned models for specific project types

Requirements

• Node.js: >= 22.0.0
• npm: >= 8.0.0 or pnpm >= 7.0.0 (recommended)
• Git: Any recent version with repository history
• AI Provider: API key for at least one supported provider (or local Ollama setup)

License

MIT License - see the LICENSE file for details.

Support

• GitHub Issues: Report bugs and request features
• Discussions: Community discussions and Q&A
• Documentation: Complete guides and API reference
• Examples: Real-world usage examples

Made with ❤️ by entro314labs

GitHub • NPM Package • Issues • Discussions