Skip to content

release candidate #348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
di-sukharev merged 13 commits into from
May 25, 2024
Merged

release candidate #348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
5cda8b1
test: ✅ add the first E2E test and configuration to CI (#316)
matscube Mar 25, 2024
c410486
Add push config (#220)
Moret84 Mar 29, 2024
a448089
feat: add instructions and support for configuring gpt-4-turbo (#320)
YOwatari Apr 12, 2024
91399a0
✅ fix the broken E2E tests due to the addition of OCO_GITPUSH (#321)
matscube Apr 13, 2024
673eee2
Feat: Add Claude 3 support (#318)
metavind Apr 14, 2024
e19305d
🐛bug fix: enable to use the new format of OpenAI's project API Key (#…
matscube May 2, 2024
278e4cb
♻️ refactor(config.ts): Addition of UnitTest environment and unittest…
matscube May 5, 2024
7469633
Merge remote-tracking branch 'origin/master' into dev
di-sukharev May 5, 2024
058bad9
new version
di-sukharev May 5, 2024
74024a4
improve OCO_AI_PROVIDER=ollama[/model name] (#327)
tumf May 7, 2024
f814c6b
add support for Azure OpenAI API - continue MR 167 (#324)
ByJacob May 9, 2024
3125404
feat(cli.ts, commit.ts): add `--yes` flag to skip commit confirmation…
ignlg May 23, 2024
c5ee5cd
Merge remote-tracking branch 'origin/dev'
di-sukharev May 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,14 @@ This is due to limit the number of tokens sent in each request. However, if you
oco --fgm
```

#### Skip Commit Confirmation

This flag allows users to automatically commit the changes without having to manually confirm the commit message. This is useful for users who want to streamline the commit process and avoid additional steps. To use this flag, you can run the following command:

```
oco --yes
```

## Configuration

### Local per repo configuration
Expand All @@ -97,7 +105,7 @@ OCO_TOKENS_MAX_OUTPUT=<max response tokens (default: 500)>
OCO_OPENAI_BASE_PATH=<may be used to set proxy path to OpenAI api>
OCO_DESCRIPTION=<postface a message with ~3 sentences description of the changes>
OCO_EMOJI=<boolean, add GitMoji>
OCO_MODEL=<either 'gpt-4o', 'gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview'>
OCO_MODEL=<either 'gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview'>
OCO_LANGUAGE=<locale, scroll to the bottom to see options>
OCO_MESSAGE_TEMPLATE_PLACEHOLDER=<message template placeholder, default: '$msg'>
OCO_PROMPT_MODULE=<either conventional-commit or @commitlint, default: conventional-commit>
Expand Down Expand Up @@ -150,6 +158,20 @@ oco config set OCO_MODEL=gpt-4-0125-preview

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

### Switch to Azure OpenAI

By default OpenCommit uses [OpenAI](https://openai.com).

You could switch to [Azure OpenAI Service](https://learn.microsoft.com/azure/cognitive-services/openai/)🚀

```sh
opencommit config set OCO_AI_PROVIDER=azure
```

Of course need to set 'OPENAI_API_KEY'. And also need to set the
'OPENAI_BASE_PATH' for the endpoint and set the deployment name to
'model'.

### Locale configuration

To globally specify the language used to generate commit messages:
Expand Down
Loading