AutoReviewer

？由 ChatGPT 提供支援的自動程式碼審查？

GitHub 操作使用 OpenAI 的 GPT-4 來執行自動程式碼審查。當您建立 PR 時，我們的操作將自動審核程式碼並提出更改建議，就像人工程式碼審核員一樣。

如何使用

• 從 OpenAI 取得 API 金鑰
• 將其添加為 GitHub 秘密
• 設定對每個 PR 運行的操作

 name : ' code-review '
on : # rebuild any PRs and main branch changes
  pull_request :
jobs :
  code-review :
    runs-on : ubuntu-latest
    permissions :
      contents : read
      pull-requests : write
    steps :
      - uses : actions/checkout@v3
      - uses : gvasilei/[email protected]
        env :
          NODE_OPTIONS : ' --experimental-fetch '
        with :
          github_token : ${{ secrets.GITHUB_TOKEN }}
          openai_api_key : ${{ secrets.OPENAI_API_KEY }}
          exclude_files : ' *.json, *.md, *.yml ' # optionally exclude files based on a wildcard expression. 

• 或當新增標籤時

 name : ' code-review '
on : # rebuild any PRs and main branch changes
  pull_request :
    types : [labeled]
jobs :
  code-review :
    if : ${{ contains( github.event.label.name, 'AutoReview') }}
    runs-on : ubuntu-latest
    permissions :
      contents : read
      pull-requests : write
    steps :
      - uses : actions/checkout@v3
      - uses : gvasilei/[email protected]
        env :
          NODE_OPTIONS : ' --experimental-fetch '
        with :
          github_token : ${{ secrets.GITHUB_TOKEN }}
          openai_api_key : ${{ secrets.OPENAI_API_KEY }}
          exclude_files : ' *.json, *.md, *.yml ' # optionally exclude files based on a wildcard expression. 

輸入參數

範圍	必需的	預設	描述
github_token	真的		與 GitHub 通訊所必需的。由 GHA 自動產生
openai_api_key	真的		OpenAI API 金鑰
型號名稱	錯誤的	GPT-3.5-渦輪	OpenAI 聊天模型。目前支援gpt-4和gpt-3.5-turbo
模型溫度	錯誤的	0	OpenAI模型溫度
排除文件	錯誤的		提供通配符表達式以從程式碼審查中排除檔案。例如， *.md將排除所有 Markdown 檔案。透過逗號支援多個表達式，例如*.js, *.cjs

？好處

使用我們的 GitHub 操作有很多好處，例如：

• 更快的程式碼審查
• 更一致的回饋
• 提高生產力
• 提高程式碼品質

？限制

• 此 GitHub Action 仍處於早期開發階段。
• 雖然該操作同時支援gpt-4和gpt-3.5-turbo ， gpt-4提供了更好的建議。

？貢獻

如果您對我們的 GitHub 操作有任何想法或改進，請隨時提交 PR。我們歡迎所有貢獻！