PR-Agent はパブリックリポジトリで無料でも使えることを知ったので、個人のパブリックリポジトリに導入してみました。
PR-Agent とは
PR-Agent は LLM を使った、pull request (PR) の作成支援や効率的なレビュー、改善等ができるツールです。
導入方法は 2 種類あります。
🔗 Installation - Qodo Merge (and open-source PR-Agent)
- Self-hosted PR-Agent
- GitHub Actions や GitLab Pipeline に自分で導入する
- パブリックリポジトリとプライベートリポジトリの両方で、無料で利用できる
- Qodo Merge
- GitHub や Bitbucket にアプリをインストールする
- パブリックリポジトリでは無料で、プライベートリポジトリでは有料で利用できる
- ドキュメント中の💎の機能が使える(後述)
Qodo Merge をパブリックリポジトリに導入する
🔗 💎 Qodo Merge - Qodo Merge (and open-source PR-Agent)
GitHub の場合は Qodo Merge Pro for Open Source という GitHub App を当該パブリックリポジトリにインストールするだけです。
Qodo Merge の動作例
下記は個人のパブリックリポジトリに導入し、動作している様子です。PR を In Review にすると、PR Description が自動的に設定され、PR Reviewer Guide と PR Code Suggestions がコメントされます。
- 例: https://github.com/masutaka/github-nippou/pull/240
- Markers template を使うために、PR template を若干カスタマイズ しています。
PR-Agent のリポジトリにも導入されているので、こちらも参考になるかもしれません。
PR コメントを使った手動トリガー
PR に以下のようにコメントすることで、手動でトリガーすることができます。詳しくは Tools をご覧ください。
/describe
- PR の description や label を設定する
- PR を In Review した時もトリガーされる
/review
- PR に関するフィードバックをコメントする
- PR を In Review した時もトリガーされる
/improve
- PR の改善提案をコメントする
- PR を In Review した時もトリガーされる
/ask ...
- 当該 PR に関する質問をする(例 )
Qodo Merge のカスタマイズ方法
🔗 Configuration File - Qodo Merge (and open-source PR-Agent)
リポジトリの Wiki ページ .pr_agent.toml
や、リポジトリルートの .pr_agent.toml
というファイルなどで、カスタマイズが可能です。
現在の設定は PR に /config
とコメントすると確認できます(例
)。
PR-Agent のリポジトリには設定ファイル とともにデフォルト設定が定義されているので、ドキュメント とともに参考になると思います。
Qodo Merge のプライベートリポジトリへの導入方法
🔗 💎 Qodo Merge - Qodo Merge (and open-source PR-Agent)
ついでに GitHub プライベートリポジトリへの導入方法も紹介しますが、Qodo Merge Pro というアプリをインストールするだけです。
前述の Self-hosted PR-Agent でもプライベートリポジトリに導入できますが、ドキュメントで💎が付いた機能は使えません。以下は例です。
- 💎 Auto Best Practices
- Code Suggestions で受け入れた commit はリポジトリの Wiki ページ
.pr_agent_accepted_suggestions
に蓄積される - Qodo Merge はこれを毎月分析し Wiki ページ
.pr_agent_auto_best_practices
に保存する .pr_agent_auto_best_practices
は次回の Code Suggestions で参考にされる
- Code Suggestions で受け入れた commit はリポジトリの Wiki ページ
- 💎 Analyze
- PR に
/analyze
とコメントすると、PR による変更の包括的な分析をする - 例: https://github.com/masutaka/masutaka-feed/pull/65#issuecomment-2677632196
- PR に
Qodo Merge Pro には 2 週間の試用期間が提供されています。
🔗 Codium is now Qodo | CodiumAI Plans & Pricing
まとめ
パブリックリポジトリに無料版の PR-Agent (Qodo Merge Pro for Open Source ) を導入しつつ、他の導入方法をまとめました。
- パブリックリポジトリには、Self-hosted PR-Agent または Qodo Merge Pro for Open Source を導入する
- プライベートリポジトリには、Self-hosted PR-Agent または Qodo Merge Pro を導入する
- ドキュメント の💎は、Self-hosted PR-Agent で利用できない機能である
個人的にはドキュメントの💎が、有料版である Qodo Merge Pro とそれ以外の違いだと誤って理解していたため、今回修正できました。