Skip to content

Latest commit

 

History

History
110 lines (72 loc) · 2.67 KB

README.zh-TW.md

File metadata and controls

110 lines (72 loc) · 2.67 KB
Raw

代碼審查機器人

由 ChatGPT 提供支持的代碼審查機器人

翻譯版本：英語|中文簡體|中文繁體 | 한국어 | 日本語

用法

安裝

安裝：apps/cr-gpt;

配置

  1. 轉到你要集成此機器人的倉庫首頁
  2. 點擊settings
  3. 點擊actions在下面secrets and variables
  4. 切換到Variables選項，創建一個新變量OPENAI_API_KEY，值為你的open api 的keyimage

開始使用

  1. 當你創建一個新的 Pull request 時，機器人會自動進行代碼審查，審查信息將顯示在 pr timeline / file changes 部分。
  2. 在git push更新PR之後，cr bot 將重新審查更改的文件

例子：

ChatGPT-CodeReview/pull/21

image

使用 Github Action

這是推薦的方式，因為 github bot 在一個不起眼的 vps 上服務，我不能確保它總是穩定的

actions/chatgpt-codereviewer

  1. 添加OPENAI_API_KEY到你的 github action 密鑰
  2. 創建.github/workflows/cr.yml添加以下內容
name: Code Review

permissions:
  contents: read
  pull-requests: write

on:
  pull_request:
    types: [opened, reopened]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: anc95/ChatGPT-CodeReview@main
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

自托管

  1. 克隆代碼
  2. 復製.env.example到.env, 並填寫環境變量
  3. 安裝deps並運行
npm i
npm -i g pm2
npm run build
pm2 start pm2.config.cjs

機器人了解更多詳情

開發

設置

# Install dependencies
npm install

# Run the bot
npm start

Docker

# 1. Build container
docker build -t cr-bot .

# 2. Start container
docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> cr-bot

貢獻

如果您對如何改進 cr-bot 有建議，或者想報告錯誤，請打開一個問題！我們會喜歡所有的貢獻。

有關更多信息，請查看投稿指南.

靈感

這個項目的靈感來自代碼審查.gpt

License

ISC© 2023 anc95