A powerful Streamlit application that generates comprehensive changelogs by analyzing git commit differences between two references.
- Visual Git Comparison: Compare any two commits or references from a GitHub repository
- Detailed Change Information: Extract detailed information about commits and file changes
- Multiple Changelog Formats:
- Standard Changelog: A traditional chronological listing of commits and changes
- Categorized Changelog: Changes organized by type (features, bugfixes, docs, etc.)
- AI-Processed Changelog: An intelligent, structured changelog created using OpenAI
- Clearly separates additions, removals, changes, and fixes
- Focuses on human-readable summaries over technical details
- Easy to Use: Simple interface with download options for all generated changelogs
- Python 3.8+
- Streamlit
- Hyperbrowser API key
- OpenAI API key (for AI-processed changelogs)
-
Clone this repository:
git clone <your-repo-url> cd github-changelog-generator
-
Install the required dependencies:
pip install -r requirements.txt
-
Set up environment variables: Create a
.envfile in the project root with the following content:HYPERBROWSER_API_KEY=your_hyperbrowser_key_here OPENAI_API_KEY=your_openai_key_here
-
Start the Streamlit app:
streamlit run app.py
-
In your browser, enter:
- A GitHub repository URL (e.g.,
https://github.com/username/repo) - Starting commit hash/reference (e.g.,
v1.0or a commit hash) - Ending commit hash/reference (e.g.,
mainor a commit hash)
- A GitHub repository URL (e.g.,
-
Click "View Comparison" to generate changelogs
-
Navigate between the different tabs to view different changelog formats:
- Detailed View: Browse commits and file changes with expandable sections
- Standard Changelog: A traditional chronological changelog
- Categorized Changelog: Changes organized by type (features, bugfixes, etc.)
- AI-Processed Changelog: An intelligent changelog with additions, removals, changes, and fixes clearly separated
- Raw Data: View the raw JSON data
-
Download any changelog format using the provided download buttons
A traditional changelog that lists all commits chronologically with their associated file changes.
Organizes commits into categories based on their type:
- ✨ Features
- 🐛 Bug Fixes
- 📄 Documentation
- 🔨 Refactoring
- 🧪 Tests
- 🔄 Other Changes
Uses OpenAI to generate a human-readable changelog that clearly separates:
- Added: New features, files, or functionality
- Removed: Deleted functionality, deprecated features, or files
- Changed: Updates to existing features or refactoring
- Fixed: Bug fixes and error corrections
app.py: Main Streamlit applicationchangelog_generator.py: Core logic for generating changelogsrequirements.txt: Project dependencies
- The application uses Hyperbrowser to extract git comparison data from GitHub
- It processes this data to extract commits, file changes, additions, and deletions
- Various changelog formats are generated based on this data
- For AI-processed changelogs, the data is sent to OpenAI's API to generate more human-friendly descriptions
Contributions, issues, and feature requests are welcome! Feel free to check the issues page.