Codex GitHub 統合
Codex は GitHub と深く統合されており、プルリクエスト内で直接コードレビューを行うことができます。このセクションでは、GitHub 統合の設定方法と使用方法を詳しく説明します。
機能概要
GitHub 統合を使用すると、次のことができます：
- PR コメントで直接 Codex にレビューを依頼できます
- すべてのプルリクエストを自動でレビューできます
- Codex に CI 失敗の問題を修正させることができます
- コード変更を確認し、提案を提供できます
GitHub から離れることなく、Codex がチームメイトのようにレビュー意見を返信します。
GitHub 統合の設定
前提条件
- Codex Cloud サブスクリプション
- GitHub アカウント
設定手順
- 設定Codex Cloud
- 移動先：Codex 設定
- リポジトリに対して有効化Code review機能
- Codex にリポジトリへのアクセスを許可する
Codex にリポジトリの読み取りとプルリクエストの作成権限を付与する必要があります。
コードレビューの依頼
手動でのレビュー実行
プルリクエストのコメントでメンションする@codex review：
レビューを依頼
# PR コメントに入力
@codex review
# またはレビュー重点を指定
@codex review for security regressions
@codex review
# またはレビュー重点を指定
@codex review for security regressions
Codex の応答
Codex は次のことを行います：
- PR にリアクションします（👀）
- コード変更を分析します
- レビュー意見を投稿します
- 発見した問題をマークします（P0 および P1）
Codex は人間のレビュアーのように PR にレビュー意見を投稿します。
自動レビュー
設定で有効にするAutomatic reviews：
- 移動先：Codex 設定
- 有効にするAutomatic reviews
- 新しい PR が開かれたときに自動的にレビューを投稿
レビュー内容のカスタマイズ
リポジトリのレビューガイドラインを設定
リポジトリのAGENTS.mdにレビューガイドラインを追加：
レビューガイドラインを追加
## Review guidelines
- PII（個人特定情報）をログに記録しない
- Verify that authentication middleware wraps every route
- Check for SQL injection vulnerabilities
- Ensure error messages don't leak sensitive information
- PII（個人特定情報）をログに記録しない
- Verify that authentication middleware wraps every route
- Check for SQL injection vulnerabilities
- Ensure error messages don't leak sensitive information
モジュール固有のルール
サブディレクトリに、より具体的なレビュールールを配置：
モジュール固有のルール
# src/payment/ モジュールのレビュールール
## Payment-specific reviews
- Verify payment processing follows PCI compliance
- Check for proper amount validation
- Ensure transaction logging
## Payment-specific reviews
- Verify payment processing follows PCI compliance
- Check for proper amount validation
- Ensure transaction logging
より具体的なルールは、対応するモジュールのコード変更に自動的に適用されます。
一回限りのレビュー重点
コメントでレビュー重点を指定：
レビュー重点を指定
# コメント例
@codex review for security issues
@codex review for performance regressions
@codex review for documentation completeness
@codex review for security issues
@codex review for performance regressions
@codex review for documentation completeness
Codex に他のタスクを依頼
コメントでメンションする@codex（review ではない）はクラウドタスクを開始します：
他のタスク
# CI 失敗を修正
@codex fix the CI failures
# テストを追加
@codex add tests for the new API endpoints
# コードをリファクタリング
@codex refactor this function to use async/await
@codex fix the CI failures
# テストを追加
@codex add tests for the new API endpoints
# コードをリファクタリング
@codex refactor this function to use async/await
Codex の他の機能を使うのは、コメントで @ するだけで簡単です。
GitHub Actions 統合
GitHub Actions でも Codex を使用できます：
GitHub Actions ワークフロー
span style="color: green;">
name: Codex Review
on: [pull_request]
jobs:
codex-review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run Codex Review
run: |
codex exec "Review code changes in this PR" --output review.md
- name: Post Review
uses: actions/github-script@v7
with:
script: |
const fs = require('fs');
const review = fs.readFileSync('review.md', 'utf8');
github.rest.pulls.createReview({
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: context.issue.number,
body: review,
event: 'COMMENT'
});
name: Codex Review
on: [pull_request]
jobs:
codex-review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run Codex Review
run: |
codex exec "Review code changes in this PR" --output review.md
- name: Post Review
uses: actions/github-script@v7
with:
script: |
const fs = require('fs');
const review = fs.readFileSync('review.md', 'utf8');
github.rest.pulls.createReview({
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: context.issue.number,
body: review,
event: 'COMMENT'
});
Codex を CI/CD パイプラインに統合すると、コードレビューを自動化できます。
ベストプラクティス
レビューガイドライン
- AGENTS.md でレビュー基準を明確に定義する
- モジュールごとに特定のルールを設定する
- 問題の優先度（P0/P1）を指定する
自動化
- 通常の PR には自動レビューを有効にする
- 大きな変更には手動トリガーを使用する
- 自動化ワークフローと組み合わせて使用する
適切な設定により、Codex のレビューをより正確かつ効率的にできます。
よくある質問
Q: Codex のレビューは有料ですか？
GitHub 統合には Codex Cloud サブスクリプションが必要です。
Q: Codex はプライベートリポジトリにアクセスできますか？
Codex にプライベートリポジトリへのアクセスを許可する必要があります。
Q: Codex がレビューするリポジトリを制限できますか？
はい、設定でリポジトリを選択的に許可できます。
Q: Codex はどのレベルの問題をマークしますか？
デフォルトでは P0（重大）および P1（重要）問題がマークされます。
その他の拡張機能