GitHubにPR-Agentを導入する際、事前にやっておくべきこと

2024/06/16に公開

遭遇した問題

ネットの記事を参考に PR-Agent を導入しようとした際、個人的にハマったポイントについて。

OPENAI_KEY を取得・リポジトリに登録し、公式が用意しているテンプレート(GitHub - PR-Agent Documentation)通りに .github/workflows/pr-agent.yml を作成したのにも関わらず、PR上で以下のようなエラーが発生してしまう...。

Failed to generate code suggestions for PR

解決方法

シンプルに OpenAI API の課金設定をしていなかったことが原因でした。
ChatGPT の有料版の契約とは別に、OpenAI API のダッシュボードで課金設定をしなければ PR-Agent を介して ChatGPT を使うことができません(考えればめっちゃ当たり前なのになかなか気づけなかった...)。

課金設定をするには、まず OpenAI API のダッシュボードにアクセスし、

https://platform.openai.com/

さらに Settings > Organization > Billing のページに遷移。

このページの「Payment methods」よりクレジットカードの情報を登録します。

課金の設定後、GitHub Actions の job を Re-run してみたところ、さっそく PR-Agent がちゃんと機能するようになりました!

Discussion