このActionsはプルリクエスト内の差分ファイルに対し、Azure OpenAI Serviceを用いてコードレビューを行います。 主に以下の機能を提供します。
api-key
- Azure OpenAI サービスにアクセスするためのキーを参照します。endpoint-url
- Azure OpenAI サービスのURLを参照します。
Note Inputsの値はSecretsに保存した値を呼び出すようにしてください。
Azure OpenAI リソースの作成
モデルのデプロイ
探索
をクリックし、Azure OpenAI Studioへアクセスします。
デプロイ
タブに切り替え、新しいデプロイの作成
をクリックします。
gpt-35-turbo
モデルを選択し、デプロイします。
Secretの設定
Resource
タブに切り替え、Endpoint
、Key
の値を控えておきます。
先ほどの Endpoint 、Key をそれぞれ以下の表の通りにSecretsに登録します。 |
Name | Secret |
---|---|---|
ENDPOINT_URL | Endpoint |
|
API_KEY | Key |
ワークフローの作成
.github/workflows/<任意の名前>.yml
を作成します。name: <任意のワークフロー名>
on:
pull_request:
types: [opened, reopened]
jobs:
<任意のジョブ名>:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- name: PullRequest Code Reviewer for Azure
uses: alterbooth/pullrequest-code-reviewer-for-azure@v1
with:
api-key: {{ secrets.API_KEY }}
endpoint-url: {{ secrets.ENDPOINT_URL }}
レビュー対象定義ファイルの作成
.reviewfiles
を作成します。.py
.java
.json
.config
Warning
.reviewfiles
には拡張子以外の記述を行わないでください。
このプロジェクトはMIT Licenseの下で配布されています。