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 アクションはまだ開発初期段階です。
• このアクションはgpt-4とgpt-3.5-turboの両方をサポートしていますが、 gpt-4方がはるかに優れた提案を提供します。

?貢献する

GitHub のアクションに関してアイデアや改善点がある場合は、お気軽に PR を送信してください。皆様のご投稿をお待ちしております。