Change Scribe
Change Scribe is an VS Code extension that automates the generation of semantic change logs for your repositories and project. It uses LLMs to analyze your Git commit history and creates meaningful, well-formatted, semantic changelog entries.
Features
- Automatically generate changelogs from your Git commit history
- Use LLMs to create concise and meaningful descriptions for each change
- Support for both OpenAI and Azure OpenAI as LLM providers
- Support for custom OpenAI API endpoints
- Support for LLM providers that use the OpenAI package like Groq and SambaNova
- Support for Google Gemini models
- Smart changelog management:
- Append to existing CHANGELOG.md
- Preserve existing content
- Organize changes by type (Added, Changed, Fixed, etc.)
- Progress indicators for all operations
- Interactive UI for viewing and customizing the generated changelog
- Save the changelog to a file or commit it directly to your repository
- Limit the number of commits included in the changelog
Requirements
- Visual Studio Code v1.85.0 or higher
- Git repository
- OpenAI API key or Azure OpenAI credentials
Installation
Via Marketplace
To download from the Visual Studio marketplace, visit the Change Scribe page.
Via VS Code
- Open Visual Studio Code
- Go to the Extensions view (Ctrl+Shift+X)
- Search for "Change Scribe"
- Click Install
Configuration
Before using Change Scribe, you need to set up a few configuration options:
- Open VS Code settings (File > Preferences > Settings)
- Search for "Change Scribe"
- Set your preferred LLM provider:
- openai: To use the OpenAI models
- azureopenai: To use the Azure OpenAI models
- openai-compatible: To use LLM providers that use the OpenAI package like Groq and SambaNova
- gemini: To use Google Gemini models
- (Optional) Choose your preferred changelog format. Defaults to Keep a Changelog format
- (Optional) Set the maximum number of commits to include. Defaults to 50
- Provide the necessary API credentials:
- For OpenAI: Set your OpenAI API key, model name, and optional API endpoint
- For Azure OpenAI: Set your API key, endpoint, deployment name, and model name
- For OpenAI-compatible LLMs: Set your API key, model name, and API endpoint
- For Gemini: Set your API key, and model name
Configuring Models
OpenAI
To configure OpenAI as your LLM provider, you need to provide the following details in the VS Code settings:
- OpenAI API Key: Your OpenAI API Key for generating changelog descriptions.
- OpenAI Model: The OpenAI Model for generating changelog descriptions.
- OpenAI API Endpoint (Optional): Your custom OpenAI API Endpoint (default:
https://api.openai.com/v1).
Azure OpenAI
To configure Azure OpenAI as your LLM provider, you need to provide the following details in the VS Code settings:
- Azure OpenAI API Key: Your Azure OpenAI API Key for generating changelog descriptions.
- Azure OpenAI Endpoint: Your Azure OpenAI API Endpoint.
- Azure OpenAI Deployment Name: The Azure OpenAI Deployment Name.
- Azure OpenAI API Version: The Azure OpenAI API Version.
- Azure OpenAI Model: The Azure OpenAI Model.
OpenAI-Compatible Providers
There are some LLM providers that use the OpenAI package, such as Groq and SambaNova. To configure these providers, you need to provide the following details in the VS Code settings:
- OpenAI Compatible API Key: Your Provider's API Key for generating changelog descriptions (e.g. your Groq API Key).
- OpenAI Compatible API Endpoint: Your Providers API Endpoint (e.g. your Groq API Endpoint).
- OpenAI Compatible Model: The Model from the Provider that you want to use for generating changelog descriptions (e.g. your Groq Model; llama-2-7b-chat).
Gemini
To configure Google Gemini as your LLM provider, you need to provide the following details in the VS Code settings:
- Gemini API Key: Your Gemini API Key for generating changelog descriptions.
- Gemini Model: The Gemini Model for generating changelog descriptions.
Usage
- Open a project with a Git repository
- Open the Command Palette (Ctrl+Shift+P)
- Type "Generate Changelog" and select the command
- The extension will show progress as it:
- Analyzes your commit history
- Generates descriptions using AI
- Creates or updates your changelog
- Review the generated changelog in the webview
- Use the "Save Changelog" button to save to CHANGELOG.md
- Use the "Commit Changelog" button to commit the changes
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License. See the LICENSE file for details.
