#changelog #git #git-commit #pull-request #cli

app git-glance

AI assisted GitHub PR-based Git changelog generator

1 unstable release

0.1.0 Jul 6, 2024

#2052 in Command line utilities

MIT license

22KB
441 lines

Git Glance

This is a very simple Git changelog generator.

It does not rely on any specific style of commit messages (such as "conventional commits") and assumes that you're using GitHub pull requests as the main path to feature integration.

It figures out what the commit range is you are trying to generate a changelog for, then gathers all the associated pull request data, then generates tagged summaries via OpenAI.

preparing the message

Once all that data is gathered, it will output a markdown based changelog with links to relevant PRs.

markdown output

Requirements

In order to get the PR data, it assumes that you have gh cli tool setup and that we can execute it.

It also uses OpenAI to help with classification and summarization. You will need an OpenAI key or it will bail.

$ git config --global --add glance.openai.key sk_blahblahblah

Warnings

This is horrible, horrible software and it will probably break. I'm not great at Rust and I've done little testing. It works for me, but if you're looking for solid code, this isn't a great place to look. Have fun. :)

Dependencies

~21–30MB
~607K SLoC