@scottobert/auto-changelog-lite v1.0.0

auto-changelog-lite

A lightweight npm package that generates concise changelogs from git commit history, with optional AI summarization.

Installation

To install the package, run:

npm install auto-changelog-lite

Usage

To generate a changelog, you can use the generateChangelog function from the package. Here’s a simple example:

import { generateChangelog } from 'auto-changelog-lite';

const changelog = generateChangelog({ summarize: true });
console.log(changelog);

Options

The generateChangelog function accepts an options object:

• summarize: A boolean indicating whether to use AI for summarization (default: false).

CLI Usage

You can also use auto-changelog-lite as a command-line tool after installing it globally or as an npm script.

Run via npx (no install required)

npx auto-changelog-lite

With AI summarization

npx auto-changelog-lite --summarize

Or use the shorthand:

npx auto-changelog-lite -s

Note: To use AI summarization from the CLI, set the OPENAI_API_KEY environment variable in your shell before running the command.

Global install

npm install -g auto-changelog-lite

Then run:

auto-changelog-lite [--summarize|-s]

AI Summarization

The package includes an AI summarization feature that condenses the changelog into a concise summary using OpenAI's API. To enable this, set the summarize option to true when calling generateChangelog.

Environment Variable Required:

To use AI summarization, you must set the OPENAI_API_KEY environment variable with your OpenAI API key. If this variable is not set, an error will be thrown when summarization is requested.

Example (Unix/macOS):

export OPENAI_API_KEY=your_openai_api_key

Example (Windows PowerShell):

$env:OPENAI_API_KEY="your_openai_api_key"

The summarization logic is handled by the Summarizer class in src/ai/summarizer.ts.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue for any enhancements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.