All the commits in this repo are done with OpenCommit — look into the commits to see how OpenCommit works. Emoji and long commit description text is configurable.

Setup OpenCommit as a Github Action

OpenCommit is now available as a GitHub Action which automatically improves all new commits messages looking into their diffs!

Open a Pull Request and OpenCommit will do the job for you on every push of all the new changes.

Automatic 1 click setup

You can simply setup the action automatically by downloading it on the GitHub Marketplace.

Manual 3 clicks setup

Create a file .github/workflows/opencommit.yml with contents below:

on: [pull_request]
    types: [opened, synchronize]
    branches-ignore:
      - master
      - dev
      - main
      - development
      - release
      - release-candidate
      - <YOUR_OTHER_BRANCHES_TO_EXCLUDE>
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: di-sukharev/opencommit@master
      with:
        # pattern: only improve messages that match the regexp, e.g. ^fix$
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Make sure you exclude public collaboration branches in branches-ignore, so OpenCommit does not interactive rebase commits there when improving the messages.

Interactive rebase (rebase -i) changes commit SHA, so commit history in remote becomes different with your local branch history. It's ok when you work on the branch alone, but may be inconvenient for other collaborators due to history conflicts when pulling new changes.

Setup OpenCommit as a CLI

Install OpenCommit globally to use in any repository:
```
npm install -g opencommit
```
Get your API key from OpenAI. Make sure you add payment details, so API works.
Set the key to OpenCommit config:
```
opencommit config set OCO_OPENAI_API_KEY=<your_api_key>
```
Your api key is stored locally in ~/.opencommit config file.

Usage

You can call OpenCommit directly to generate a commit message for your staged changes:

git add <files...>
opencommit

You can also use the oc shortcut:

git add <files...>
oc

Configuration

Local per repo configuration

Create an .env file and add OpenCommit config variables there like this:

OCO_OPENAI_API_KEY=<your openAI API token>
OCO_OPENAI_MAX_TOKENS=<max response tokens from openAI API>
OCO_OPENAI_BASE_PATH=<may be used to set proxy path to openAI api>
OCO_DESCRIPTION=<postface a message with ~3 sentences description>
OCO_EMOJI=<add GitMoji>
OCO_MODEL=<either gpt-3.5-turbo or gpt-4>
OCO_LANGUAGE=<locale, scroll to the bottom to see options>

Global config for all repos

Local config still has more priority as Global config, but you may set OCO_MODEL and OCO_LOCALE globally and set local configs for OCO_EMOJI and OCO_DESCRIPTION per repo which is more convenient.

Simply run any of the variable above like this:

oc config set OCO_OPENAI_API_KEY=gpt-4

Configure GitMoji to preface a message.

oc config set OCO_EMOJI=true

To remove preface emoji:

oc config set OCO_EMOJI=false

Switch to GPT-4

By default OpenCommit uses GPT-3.5-turbo (ChatGPT).

You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠

oc config set OCO_MODEL=gpt-4

Make sure you do lowercase gpt-4 and you have API access to the 4th model. Even if you have ChatGPT+ it doesn't necessarily mean that you have API access to GPT-4.

Locale configuration

To globally specify the language used to generate commit messages:

# de, German ,Deutsch
oc config set OCO_LANGUAGE=de
oc config set OCO_LANGUAGE=German
oc config set OCO_LANGUAGE=Deutsch

# fr, French, française
oc config set OCO_LANGUAGE=fr
oc config set OCO_LANGUAGE=French
oc config set OCO_LANGUAGE=française

The default language set is English
All available languages are currently listed in the i18n folder

Git flags

The opencommit or oc commands can be used in place of the git commit -m "${generatedMessage}" command. This means that any regular flags that are used with the git commit command will also be applied when using opencommit or oc.

oc --no-verify

is translated to :

git commit -m "${generatedMessage}" --no-verify

Ignore files

You can ignore files from submission to OpenAI by creating a .opencommitignore file. For example:

path/to/large-asset.zip
**/*.jpg

This is useful for preventing opencommit from uploading artifacts and large files.

By default, opencommit ignores files matching: *-lock.* and *.lock

Git hook (KILLER FEATURE)

You can set OpenCommit as Git prepare-commit-msg hook. Hook integrates with you IDE Source Control and allows you edit the message before commit.

To set the hook:

oc hook set

To unset the hook:

oc hook unset

To use the hook:

git add <files...>
git commit

Or follow the process of your IDE Source Control feature, when it calls git commit command — OpenCommit will integrate into the flow.

Payments

You pay for your own requests to OpenAI API. OpenCommit uses ChatGPT (3.5-turbo) official model, that is ~15x times cheaper than GPT-4.