git-ai-summary - npm
It provides a convenient way to generate summaries and translations of a project's commit history, which can be helpful for freelancers or developers who need to communicate their work to non-technical clients or colleagues who speak a different language.
Note: I use, and this tool is designed for, conventional/semantic style commit messages. If you have a different format, use the commit_format arg to describe it.
** THIS PACKAGE SENDS YOUR COMMIT MESSAGES (but not the code or diffs) TO ChatGPT. YOU HAVE BEEN WARNED. THE AUTHOR ASSUMES NO RESPONSIBILITY FOR THE SECURITY OR PRIVACY OF YOUR SUBMISSIONS **
To use this package, you will need an OpenAI API key Set it as an env var, pass it as an arg when calling the function, or from the CLI.
Be careful sending too much of a history to ChatGPT. Even though it should be able to handle 8,000ish words, I've been getting 400 errors from their API going above 25ish commits.
To best understand and summarize commit messages for software release notes, it's helpful if the commit messages follow a consistent structure. Here are some best practices for structuring commit messages that will make it easier for me as a marketing and communications specialist to parse and understand them:
