opencommit 2.0.15 → 2.0.16

package/README.md

@@ -18,7 +18,70 @@
 
 All the commits in this repo are done with OpenCommit — look into [the commits](https://github.com/di-sukharev/opencommit/commit/eae7618d575ee8d2e9fff5de56da79d40c4bc5fc) to see how OpenCommit works. Emoji and long commit description text is configurable.
 
-## Setup
+## Setup OpenCommit as a Github Action
+
+OpenCommit is now available as a GitHub Action which automatically improves all new commits messages when you push to remote!
+
+This is great if you want to make sure all of the commits in all of repository branches are meaningful and not lame like `fix1` or `done2`.
+
+### Automatic 1 click setup
+
+You can simply [setup the action automatically via the GitHub Marketplace](TODO).
+
+### Manual 3 clicks setup
+
+Create a file `.github/workflows/opencommit.yml` with contents below:
+
+```yml
+name: 'OpenCommit'
+
+on:
+  push:
+    # this list of branches is often enough,
+    # but you may still ignore other public branches
+    branches-ignore: [main master dev development release]
+
+jobs:
+  opencommit:
+    name: OpenCommit
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - name: Setup Node.js Environment
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: di-sukharev/opencommit@github-action
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+        env:
+          # set openAI api key in repo actions secrets,
+          # for openAI keys go to: https://platform.openai.com/account/api-keys
+          # for repo secret go to: <your_repo_url>/settings/secrets/actions
+          OCO_OPENAI_API_KEY: ${{ secrets.OCO_OPENAI_API_KEY }}
+
+          # customization
+          OCO_OPENAI_MAX_TOKENS: 500
+          OCO_OPENAI_BASE_PATH: ''
+          OCO_DESCRIPTION: false
+          OCO_EMOJI: false
+          OCO_MODEL: gpt-3.5-turbo
+          OCO_LANGUAGE: en
+```
+
+That is it. Now when you push to any branch in your repo — all NEW commits are being improved by never-tired-AI.
+
+Make sure you exclude public collaboration branches (`main`, `dev`, `etc`) in `branches-ignore`, so OpenCommit does not 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.
+
+## Setup OpenCommit as a CLI
+
+You can use OpenCommit by simply running it via CLI like this `oc`. 2 seconds and your staged changes are committed with a meaningful message.
 
 1. Install OpenCommit globally to use in any repository:
 
@@ -31,7 +94,7 @@ All the commits in this repo are done with OpenCommit — look into [the commits
 3. Set the key to OpenCommit config:
 
    ```sh
-   opencommit config set OPENAI_API_KEY=<your_api_key>
+   opencommit config set OCO_OPENAI_API_KEY=<your_api_key>
    ```
 
    Your api key is stored locally in `~/.opencommit` config file.
@@ -52,82 +115,70 @@ git add <files...>
 oc
 ```
 
-## Features
+## Configuration
 
-### Switch to GPT-4
+### Local per repo configuration
 
-By default OpenCommit uses GPT-3.5-turbo (ChatGPT).
-
-You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
+Create an `.env` file and add OpenCommit config variables there like this:
 
-```sh
-oc config set model=gpt-4
+```env
+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>
 ```
 
-Make sure you do lowercase `gpt-4`.
-
-### Preface commits with emoji 🤠
+### Global config for all repos
 
-[GitMoji](https://gitmoji.dev/) convention is used.
+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.
 
-To add emoji:
+Simply run any of the variable above like this:
 
 ```sh
-oc config set emoji=true
+oc config set OCO_OPENAI_API_KEY=gpt-4
 ```
 
-To remove emoji:
+Configure [GitMoji](https://gitmoji.dev/) to preface a message.
 
 ```sh
-oc config set emoji=false
+oc config set OCO_EMOJI=true
 ```
 
-### Postface commits with descriptions of changes
-
-To add descriptions:
+To remove preface emoji:
 
 ```sh
-oc config set description=true
+oc config set OCO_EMOJI=false
 ```
 
-To remove description:
-
-```sh
-oc config set description=false
-```
-
-### Configure openAI maxTokens param
+### Switch to GPT-4
 
-Default value for `maxTokens` is 196, sometimes you can get 400 error if request+response exceeds `maxToken` parameter.
+By default OpenCommit uses GPT-3.5-turbo (ChatGPT).
 
-so you can increase it:
+You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
 
 ```sh
-oc config set OPENAI_MAX_TOKENS=<number>
+oc config set OCO_MODEL=gpt-4
 ```
 
-### Configure BASE_PATH for openAI api
-
-if you want to call GPT via proxy — you can change `BASE_PATH` parameter:
-
-```sh
-oc config set OPENAI_BASE_PATH=<string>
-```
+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.
 
-### Internationalization support
+## Locale configuration
 
-To specify the language used to generate commit messages:
+To globally specify the language used to generate commit messages:
 
 ```sh
 # de, German ,Deutsch
-oc config set language=de
-oc config set language=German
-oc config set language=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 language=fr
-oc config set language=French
-oc config set language=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**  
@@ -160,7 +211,7 @@ This is useful for preventing opencommit from uploading artifacts and large file
 
 By default, opencommit ignores files matching: `*-lock.*` and `*.lock`
 
-## Git hook
+## Git hook (KILLER FEATURE)
 
 You can set OpenCommit as Git [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook. Hook integrates with you IDE Source Control and allows you edit the message before commit.