https://github.com/ikoofe/chat-review
ChatGPT Gitlab Code Review
https://github.com/ikoofe/chat-review
Last synced: 5 months ago
JSON representation
ChatGPT Gitlab Code Review
- Host: GitHub
- URL: https://github.com/ikoofe/chat-review
- Owner: ikoofe
- Created: 2023-04-06T17:06:26.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-08T01:11:09.000Z (over 1 year ago)
- Last Synced: 2024-08-02T01:25:54.977Z (9 months ago)
- Language: TypeScript
- Size: 68.4 KB
- Stars: 88
- Watchers: 3
- Forks: 29
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-ChatGPT-repositories - chat-review - ChatGPT Gitlab Code Review (Others)
README
# @koofe/chat-review
## Install
```sh
npm i @koofe/chat-review
```
## Usage
### Node.js
```js
import review from '@koofe/chat-review';
review({
gitlabConfig: {
host: 'https://gitlab.mokahr.com/',
mrIId: 2001,
projectId: 200,
token: 'glpat-xxxxxx',
},
chatgptConfig: {
apiKey: 'sk-xxxxxxxxx',
},
});
```
### Shell
```sh
chat-review --chatgpt sk-xxxxxxxxx --token 'glpat-xxxxxx' --project 200 --mr 2001
```
通过 ChatGPT 进行代码审核的 CLI 工具，主要包含以下几个命令选项：
- `--chatgpt`：ChatGPT 的 API Token。
- `--token`：GitLab 的访问 Token。
- `--project`：GitLab 项目 ID。
- `--mr`：GitLab Merge Request ID。
- `--model`：ChatGPT 的模型类型，默认为 `gpt-3.5-turbo`。
- `--language`：ChatGPT 的语言类型，默认为中文。
- `--host`：GitLab 的访问地址，默认为 `https://gitlab.com`。
- `--proxyHost`：ChatGPT API host, 默认是 `https://api.openai.com`。
- `--target`：GitLab Review 的文件，默认为 /\.(j|t)sx?$/
### CI
在 Gitlab CI/CD 中设置 CHATGPT_KEY、GITLAB_TOKEN 变量，`.gitlab-ci.yml` 如下：
```yml
stages:
- merge-request
Code Review:
stage: merge-request
image: node:latest
script:
- npm i @koofe/chat-review -g
- echo "$CI_MERGE_REQUEST_PROJECT_ID"
- echo "$CI_MERGE_REQUEST_IID"
- chat-review run --chatgpt "$CHATGPT_KEY" --token "$GITLAB_TOKEN" --project "$CI_MERGE_REQUEST_PROJECT_ID" --mr "$CI_MERGE_REQUEST_IID"
only:
- merge_requests
except:
variables:
- $CI_MERGE_REQUEST_TARGET_BRANCH_NAME !~ /^(main|release)$/
when: manual
```