ai codereviewer

AI コードレビューアー

AI Code Reviewer は、OpenAI の GPT-4 API を活用して、プル リクエストに対するインテリジェントなフィードバックと提案を提供する GitHub アクションです。この強力なツールは、コード レビュー プロセスを自動化することでコードの品質を向上させ、開発者の時間を節約します。

特徴

• OpenAI の GPT-4 API を使用してプル リクエストをレビューします。
• コードを改善するためのインテリジェントなコメントと提案を提供します。
• 指定された除外パターンに一致するファイルをフィルターで除外します。
• セットアップが簡単で、GitHub ワークフローに統合できます。

設定

1. この GitHub アクションを使用するには、OpenAI API キーが必要です。 API キーをお持ちでない場合は、OpenAI でサインアップしてください。

2. OpenAI API キーをOPENAI_API_KEYという名前で GitHub Secret としてリポジトリに追加します。 GitHub Secret の詳細については、こちらをご覧ください。

3. リポジトリに.github/workflows/main.ymlファイルを作成し、次のコンテンツを追加します。

 name : AI Code Reviewer

on :
  pull_request :
    types :
      - opened
      - synchronize
permissions : write-all
jobs :
  review :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout Repo
        uses : actions/checkout@v3

      - name : AI Code Reviewer
        uses : your-username/ai-code-reviewer@main
        with :
          GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
          OPENAI_API_KEY : ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_MODEL : " gpt-4 " # Optional: defaults to "gpt-4"
          exclude : " **/*.json, **/*.md " # Optional: exclude patterns separated by commas

4. your-username 、AI Code Reviewer リポジトリが配置されている GitHub ユーザー名または組織名に置き換えます。

5. 特定のファイル パターンをレビューから無視する場合は、 exclude入力をカスタマイズします。

6. 変更をリポジトリにコミットすると、AI Code Reviewer が今後のプル リクエストの処理を開始します。

仕組み

AI Code Reviewer GitHub アクションは、プル リクエストの差分を取得し、除外されたファイルをフィルターで除外し、コード チャンクを OpenAI API に送信します。次に、AI の応答に基づいてレビュー コメントを生成し、プル リクエストに追加します。

貢献する

貢献は大歓迎です! AI Code Reviewer GitHub Action を改善するために、お気軽に問題やプル リクエストを送信してください。

メンテナに最終パッケージ ( yarn build & yarn package ) を生成させます。

ライセンス

このプロジェクトは MIT ライセンスに基づいてライセンスされています。詳細については、LICENSE ファイルを参照してください。