Git Changelog Generator 🚀

A modern, high-performance changelog generator that transforms your git history into a beautiful, interactive, and portable single-file HTML document.

📋 View This Project's Changelog

✨ Key Features

• Native Git Integration: Automatically extracts commits directly from any local .git repository.
• Single-File Portability: Bundles HTML, CSS, and JavaScript into a single .html file that works anywhere without a server.
• Premium UI Design: Built with React and Vanilla CSS for a sleek, dark-themed, and responsive experience.
• Intelligent Categorization: Automatically categorizes commits based on prefixes (feat, fix, perf, etc.).
• Detailed Timestamps: Displays relative dates and specific times for every change.
• Flexible CLI: Run it interactively or with command-line arguments for automation.

Tip

🤖 Want AI-Enhanced Descriptions?
Check out the AI-Enhanced Branch which uses Google Gemini to automatically transform developer commit messages into user-friendly descriptions!
View AI-Enhanced Changelog Demo

🚀 Getting Started

Prerequisites

• Node.js (v18 or higher recommended)
• Git installed and accessible in your system path.

Installation

1. Clone this repository:

   git clone <repository-url>
   cd changelog

2. Install dependencies:

   npm install

📖 Usage

Standalone Generator (Recommended)

To generate a changelog for any project on your computer:

npm run standalone

The script will guide you through:

1. Entering the path to the git repository you want to analyze.
2. Choosing where to save the final .html file.

Automated Generation

You can also bypass the prompts by providing arguments directly:

npm run standalone -- --repo "C:\path\to\your\project" --output "C:\path\to\changelog.html"

Local Development

If you want to modify the design or logic:

# Start development server with hot-reload
npm run dev

The dev server will automatically generate data from the current repository.

🛠️ How It Works

1. Data Extraction: A Node.js script (scripts/generate-changelog.js) runs git log on the target repository.
2. Data Baking: The extracted history is transformed into a TypeScript data file (src/generatedChangelog.ts).
3. Standalone Build: Vite compiles the React application and uses vite-plugin-singlefile to inline all assets.
4. Deployment: The script moves the final index.html to your desired output path.

🎨 Customizing

• Styles: Modify src/Changelog.css to update colors, typography, and layout.
• Categories: Update scripts/generate-changelog.js to change how commit messages are categorized.
• Components: Edit src/Changelog.tsx to change the HTML structure or logic.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.