メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://factory-docs-auto-sync-jp-docs.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

GitHubまたはGitLabリポジトリの自動コードレビューを設定します。Droidがプルリクエストとマージリクエストを分析し、問題を特定して、インラインコメントとしてフィードバックを投稿します。GitHubリポジトリでは、セットアップフローがレビュー自動化の設定の一部としてFactory Droid GitHub Appのインストールを確認します。
見つかった問題を含むコードレビューサマリーを投稿するFactory Droidボット
特定の行にインラインコードレビューコメントを投稿するFactory Droidボット

セットアップ

GitHubまたはGitLabの自動コードレビューを設定するには、/install-code-reviewコマンドを使用します:
droid
> /install-code-review
ガイド付きフローでは以下を行います:
  1. SCMプラットフォーム(GitHubまたはGitLab)を検出
  2. 前提条件(CLIツール、権限)を確認
  3. レビュー設定(深度、セキュリティ、トリガー)の設定をガイド
  4. ワークフローファイルとともにPR/MRを作成

動作の仕組み

有効化すると、Droid Reviewワークフローは:
  1. プルリクエストイベント(開始、同期、再開、レビュー準備完了)でトリガー
  2. 開発中のノイズを避けるため下書きPRをスキップ
  3. PR差分と既存のコメントを取得
  4. バグ、セキュリティ問題、正確性の問題についてコード変更を分析
  5. 問題のある行にインラインコメントを投稿
  6. 問題が見つからない場合は承認を送信

レビューの深度

review_depth 入力は各レビューの徹底さとコストを制御します。/install-code-review セットアップ時に深度を選択するか、ワークフローで直接設定します。
  • deep(デフォルト) — より高い推論努力による徹底的な分析。より微妙なバグを捉えますが、レビューあたりのコストが高くなります。本番コードやセキュリティ重要なリポジトリに最適。
  • shallow — 表面的な問題をカバーする、より高速でコスト効率の良いレビュー。大量リポジトリ、下書きPR、または支出を監視するチームに適しています。
with:
  automatic_review: true
  review_depth: deep  # or shallow
review_modelreasoning_effort を使用してモデルや推論の強度を直接オーバーライドすることもでき、これらは深度プリセットよりも優先されます。

セキュリティレビュー

セキュリティレビューは、標準的なコードレビューと並行して(またはその代わりに)STRIDEベースの分析を実行します。専用のセキュリティレビューサブエージェントを使用して、なりすまし、改ざん、否認防止、情報開示、サービス拒否、および権限昇格の脆弱性をスキャンします。

自動セキュリティレビューの有効化

ワークフローに automatic_security_review: true を追加します。automatic_reviewautomatic_security_review の両方が有効な場合、セキュリティレビューアーはコードレビューパス中に並列サブエージェントとして実行されます:
with:
  automatic_review: true
  automatic_security_review: true
セキュリティレビューの調査結果は、同じPRコメント内に含まれ、独自の重要度評価を持つセキュリティレビューサマリーセクションとして追加されます。

オンデマンドセキュリティレビュー

任意のPRにコメントすることで、セキュリティレビューを手動でトリガーすることもできます:
@droid security
専用のレポートを作成する完全なリポジトリセキュリティスキャンの場合:
@droid security --full
--full スキャンは新しいブランチ(droid/security-report-{date})を作成し、.factory/security/reports/security-report-{date}.md にレポートを生成して、発見事項を含むPRを開きます。

セキュリティ設定

入力デフォルト説明
automatic_security_reviewfalse全てのPRで自動的にセキュリティレビューを実行
security_modelreview_model から継承)セキュリティ分析用のモデル
security_severity_thresholdmediumレポートする最小重要度:criticalhighmediumlow

スケジュール化されたセキュリティスキャン

ワークフローにcronトリガーを追加して、定期的なリポジトリ全体のスキャンをスケジュール実行:
name: Security Scan
on:
  schedule:
    - cron: '0 6 * * 1'  # Every Monday at 6am

jobs:
  security-scan:
    runs-on: ubuntu-latest
    steps:
      - uses: Factory-AI/droid-action@main
        with:
          security_scan_schedule: true
          security_scan_days: 7  # Scan commits from the last 7 days

Droidがレビューする内容

自動レビューアーは明確なバグと問題に焦点を当てます:
  • デッド/到達不能コード
  • 制御フローの破綻(breakの欠如、フォールスルーバグ)
  • async/awaitの間違い
  • null/undefined参照
  • リソースリーク
  • SQL/XSSインジェクション脆弱性
  • エラーハンドリングの欠如
  • オフバイワンエラー
  • 競合状態
スタイルの問題、軽微な最適化、アーキテクチャの意見はスキップします。

ワークフローのカスタマイズ

ワークフローが作成された後、リポジトリの.github/workflows/droid-review.ymlを編集してカスタマイズできます。

トリガー条件の変更

レビューが実行されるタイミングを変更:
on:
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]
    paths:
      - 'src/**'  # Only review changes in src/
      - '!**/*.test.ts'  # Skip test files

カスタムレビューガイドライン

リポジトリ固有のレビューガイドラインを追加するには、リポジトリ内に.factory/skills/review-guidelines/SKILL.mdファイルを作成します:
<!-- .factory/skills/review-guidelines/SKILL.md -->

Additional checks for this codebase:
- React hooks rules violations
- Missing TypeScript types on public APIs
- Prisma query performance issues
これらのガイドラインは自動的に取得され、すべてのレビュー実行に注入されます。ワークフローの変更は必要ありません。

モデルを変更する

レビューに異なるモデルを使用する:
droid exec --auto high --model claude-sonnet-4-5-20250929 -f prompt.txt
# Or use a faster model for quicker feedback:
droid exec --auto high --model claude-haiku-4-5-20251001 -f prompt.txt

特定のPRをスキップする

特定のケースでレビューをスキップするための条件を追加する:
jobs:
  code-review:
    # Skip bot PRs and PRs with [skip-review] in title
    if: |
      github.event.pull_request.draft == false &&
      !contains(github.event.pull_request.user.login, '[bot]') &&
      !contains(github.event.pull_request.title, '[skip-review]')

コメント数を制限する

プロンプト内のコメントの最大数を調整します:
Guidelines:
- Submit at most 5 comments total, prioritizing the most critical issues

すべてのワークフロー入力

入力デフォルト説明
automatic_reviewfalse@droid reviewなしでPRを自動的にレビューする
review_depthdeepレビュープリセット: deep(徹底的) または shallow(高速)
review_model(depthから)コードレビュー用のモデルをオーバーライド
reasoning_effort(depthから)推論努力をオーバーライド
include_suggestionstrueコメントにコード提案ブロックを含める
automatic_security_reviewfalseすべてのPRでセキュリティレビューを実行
security_model(review_modelから)セキュリティレビュー用のモデルをオーバーライド
security_severity_thresholdmedium報告する最小重要度
security_scan_schedulefalseスケジュールされた全リポジトリスキャンを有効化
security_scan_days7スキャンするコミットの日数

関連項目