Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anc95/chatgpt-codereview
🐥 A code review bot powered by ChatGPT
https://github.com/anc95/chatgpt-codereview
chatgpt codereview probot
Last synced: 3 days ago
JSON representation
🐥 A code review bot powered by ChatGPT
- Host: GitHub
- URL: https://github.com/anc95/chatgpt-codereview
- Owner: anc95
- License: isc
- Created: 2023-02-11T14:35:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T02:45:22.000Z (about 1 month ago)
- Last Synced: 2025-01-21T04:01:39.674Z (3 days ago)
- Topics: chatgpt, codereview, probot
- Language: JavaScript
- Homepage: https://github.com/apps/cr-gpt
- Size: 8 MB
- Stars: 4,120
- Watchers: 23
- Forks: 418
- Open Issues: 51
-
Metadata Files:
- Readme: README.ja.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ChatGPT-repositories - ChatGPT-CodeReview - 🐥 A code review bot powered by ChatGPT (Chatbots)
README
# CodeReview BOT
> A code review robot powered by ChatGPT
Translation Versions: [ENGLISH](./README.md) | [简体中文](./README.zh-CN.md) | [繁體中文](./README.zh-TW.md) | [한국어](./README.ko.md) | [日本語](./README.ja.md)
## Usage
❗️⚠️ コストを考慮して BOT はテスト目的でのみ使用され、現在 AWS Lambda に展開されて速度制限を受けています。そのため、不安定な状況は完全に正常です。アプリケーションを直接展開することをお勧めします。
## Install
Install: [apps/cr-gpt](https://github.com/apps/cr-gpt);
### Configuration
1. リポジトリのホームページに移動します
2. `settings` をクリックします
3. `secrets and variables` メニューの下の `actions` をクリックします
4. `New repository variable` をクリックして OpenAI の API キーの登録を行います。変数名は `OPENAI_API_KEY` にしてください。変数の値には OpenAI の API キーを入力します。 (OpenAI のホームページから API キーを取得できます。)
### Start using
1. この bot は新しいプルリクエストが作成されたときに自動的にコードレビューを行います。レビュー結果はプルリクエストのタイムラインやファイル変更部分に表示されます。
2. `git push` によりプルリクエストの更新が行われたときにも自動的にコードレビューを行います。
example:
[ChatGPT-CodeReview/pull/21](https://github.com/anc95/ChatGPT-CodeReview/pull/21)
### Using Github Actions
> 基本的には、Github Actions での利用を推奨します。
[actions/chatgpt-codereviewer](https://github.com/marketplace/actions/chatgpt-codereviewer)
1. `OPENAI_API_KEY` を設定する
2. 以下の例のように `.github/workflows/cr.yml` を作成する
```yml
name: Code Review
permissions:
contents: read
pull-requests: write
on:
pull_request:
types: [opened, reopened, synchronize]
jobs:
test:
if: ${{ contains(github.event.*.labels.*.name, 'gpt review') }} # Optional; to run only when a label is attached
runs-on: ubuntu-latest
steps:
- uses: anc95/ChatGPT-CodeReview@main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
# Optional
LANGUAGE: Chinese
MODEL:
PROMPT:
top_p: 1
temperature: 1
IGNORE_PATTERNS: /node_modules,*.md # Regex pattern to ignore files, separated by comma
```
## Self-hosting
1. このリポジトリをクローンします
2. `.env.example` を `.env` にリネームし、必要な環境変数を設定します
3. 以下のコマンドを順番に実行することで依存関係をインストールし、bot を起動します
```sh
npm i
npm -i g pm2
npm run build
pm2 start pm2.config.cjs
```
詳細は [probot](https://probot.github.io/docs/development/) を参照してください。
## Dev
### Setup
```sh
# Install dependencies
npm install
# Run the bot
npm start
```
### Docker
```sh
# 1. Build container
docker build -t cr-bot .
# 2. Start container
docker run -e APP_ID= -e PRIVATE_KEY= cr-bot
```
## Contributing
cr-bot の改善に関する提案やバグ報告は、issue を作成してください。どのような貢献でも歓迎します！！
より詳しい情報は [Contributing Guide](CONTRIBUTING.md) を参照してください。
## Credit
this project is inpired by [codereview.gpt](https://github.com/sturdy-dev/codereview.gpt)
## License
[ISC](LICENSE) © 2023 anc95