@lxgicstudios/ai-changelog
v1.0.0
Published
Generate clean changelogs from git history using OpenAI
Readme
ai-changelog
Generates a clean, categorized changelog from your git history. You give it two refs (tags, branches, commits) and it reads the log between them, then uses OpenAI to turn that mess of commit messages into a proper CHANGELOG entry.
Install
npm install -g ai-changelogSetup
You'll need an OpenAI API key:
export OPENAI_API_KEY=sk-your-key-hereUsage
# Between two tags
npx ai-changelog --from v1.0.0 --to v2.0.0
# From a tag to HEAD
npx ai-changelog --from v1.0.0 --to HEAD
# Write directly to a file
npx ai-changelog --from v1.0.0 --to v2.0.0 -o CHANGELOG.mdIt'll group your commits into Added, Changed, Fixed, Removed. No more hand-writing changelogs.
What it does
- Reads git log between the two refs you give it
- Sends the commit list to OpenAI
- Gets back a nicely formatted changelog entry
- Prints it or writes it to a file
That's it. Nothing fancy, just saves you 20 minutes every release.
