commit-msg

Commit Message

Create a commit message suggestion from the git diff using the openAI API.

Note that this means that filename and lines changed is sent to openAI. If that bothers you - don't use this tool.

Make sure environment variable OPENAI_API_KEY contains a valid API key. Note that this tool uses the openAI API so it will incur a cost. It is recommended to set a hard limit in the openai account settings panel.

Example Usage

Needs commit-msg (that is the binary from this repo) in PATH.

───────┬────────────────────────────────────────────────────────────────────────────────────
       │ File: .git/hooks/prepare-commit-msg
───────┼────────────────────────────────────────────────────────────────────────────────────
   1   │ #!/bin/sh
   2   │
   3   │ # Use CLI tool commit-msg to fetch a suggested commit message. Prepend the
   4   │ # suggested commit message to the commit message file.
   5   │
   6   │ COMMIT_MSG_FILE=$1
   7   │
   8   │ echo "Fetching suggested commit message..."
   9   │
  10   │ COMMIT_MSG=$(commit-msg --timeout=15s --file=$COMMIT_MSG_FILE)
  11   │
  12   │ if [ $? -ne 0 ]; then
  13   │     echo "❌ prepare-commit-msg: commit-msg failed. Doing nothing..."
  14   │     exit 0
  15   │ fi
  16   │
  17   │ printf '%s\n%s\n' "${COMMIT_MSG}" "$(cat $COMMIT_MSG_FILE)" >$COMMIT_MSG_FILE
───────┴────────────────────────────────────────────────────────────────────────────────────

Flags

Conventional Commit

Use flag --conventional-commit if the commit should be conventional commit compliant.

Style

Use flag --style to specify the style of the commit. DescriptiveAndNeutral is the default if no style is specified.

$ commit-msg --style="ConversationalAndCasual" --timeout=10s --file ./example_commit_msg
Refactor project structure and update Makefile

We've made some changes to the project structure and updated the Makefile
accordingly. Specifically, we've changed the module path from
"github.com/philiplinell/go-template" to "github.com/philiplinell/commit-msg".
We've also removed the "init.sh" script, which was used to initialize a new
repository with the correct module path and hooks. Instead, users will need to
manually update the module path in the "go.mod" and "Makefile" files. 


$ commit-msg --style="ListBased" --timeout=10s --file ./example_commit_msg
Refactor project structure and remove unnecessary files

In this commit:

- The project structure has been refactored to use the new repository name "commit-msg"
- The Makefile has been updated to reflect the new repository name
- The pre-push git hook and init.sh files have been removed as they are no longer needed


$ commit-msg --style="ProblemSolution" --timeout=10s --file ./example_commit_msg
Refactor Makefile and init.sh for better maintainability

Problem: The Makefile and init.sh scripts were difficult to maintain and contained unnecessary code.

Solution: In this commit, we've made the following changes:

- Updated the Makefile to reflect the new module path
- Removed the install-hooks and uninstall-hooks targets from the Makefile, as
  they were not being used
- Removed the pre-push hook script, as it was not being used
- Removed the init.sh script, as it was not being used

These changes will make the codebase easier to maintain and reduce clutter.