/commitgen

Automatically generate git commit comment!

Primary LanguageJavaScript

commitgen

Generate git commit comments from source code differences.

Especially for personal hobby projects, you may have experienced that commit comments are often vague or meaningless. With commitgen, you can set up a git alias that generates natural commit comments from source code differences and commits them automatically.

how to use

  1. Clone this repository to any folder you like.

  2. Create a .env file with your key. (or set env variables)

    • For OpenAI, specify the key in the .env file you created.
    OPENAI_API_KEY={your OpenAI API Key}
    • For Azure OpenAI Service, specify the endpoint name, model name, and key.
    AOAI_API_KEYAOAI_API_KEY={your Azure OpenAI API Key}
AOAI_ENDPOINT={your Azure OpenAI API Endpoint}
AOAI_MODEL={your Azure OpenAI Service's ChatGPT Model name}

  3. Try running a test. Run the following command to check if it works.

node {absolute path of the clone folder}/commitgen.js "Updated test.js".
  1. Try to use on real project. After confirming that it works with an absolute path, move to your project that uses Git. After doing git add, run the following command.
git commit -m "$(node {absolute path of the clone folder}/commitgen.js "$(git diff --staged)")"
  1. Regist Github alias If you want to use github alias, please edit config and regist the below command. Open config
git config --global --edit

Add alias below. I confirmed the alias in GitBash on Windows, please modify this alias depending on your environment.

[alias]
	ccg = !git diff --staged | node {absolute path of the clone folder}/commitgen.js \"$(cat -)\" | xargs git commit -m
	ccgtest = !git diff --staged | node {absolute path of the clone folder}/commitgen.js \"$(cat -)\"
	acp = !git add -A && git ccg && git push origin $1 &&:

After edit the config, please use this tool like below.

git add .
git ccg

'git ccg' automatically commit your code with comment that ChatGPT create. 'git ccgtest' show the comment that ChatGPT create. 'acp' is all-set of add-commit-push with ChatGPT comment.