Skip to content

docs(code-review): pin examples to @main and drop unused security inputs #1039

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
factory-nizar merged 2 commits into from
Apr 28, 2026
Merged

docs(code-review): pin examples to @main and drop unused security inputs #1039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a863fa
docs(code-review): pin examples to @main and drop unused security inputs
factory-nizar Apr 28, 2026
73b2b81
docs: pin remaining droid-action examples to @main
factory-nizar Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cli/features/code-review.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ Plus an **overall assessment**:
For automated PR reviews, use the [Automated Code Review](/guides/droid-exec/code-review) workflow. It supports:

- **Review depth** (`deep` or `shallow`) to control thoroughness and cost
- **Security review** with STRIDE-based vulnerability scanning, configurable severity thresholds, and PR blocking on critical findings
- **Security review** with STRIDE-based vulnerability scanning and configurable severity thresholds
- **On-demand security scans** via `@droid security` comments on PRs, or `@droid security --full` for a full-repo scan
- **Scheduled full-repo scans** via cron-based workflow triggers

Expand Down
2 changes: 1 addition & 1 deletion docs/enterprise/github-integration-security.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Control who can trigger the action:
For enhanced security, you can restrict network access during Droid execution:

```yaml
- uses: Factory-AI/droid-action@v1
- uses: Factory-AI/droid-action@main
with:
factory_api_key: ${{ secrets.FACTORY_API_KEY }}
experimental_allowed_domains: |
Expand Down
8 changes: 1 addition & 7 deletions docs/guides/droid-exec/code-review.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,6 @@ The `--full` scan creates a new branch (`droid/security-report-{date}`), generat
| `automatic_security_review` | `false` | Run security review automatically on every PR |
| `security_model` | (inherits from `review_model`) | Model for security analysis |
| `security_severity_threshold` | `medium` | Minimum severity to report: `critical`, `high`, `medium`, `low` |
| `security_block_on_critical` | `true` | Submit `REQUEST_CHANGES` on critical findings |
| `security_block_on_high` | `false` | Submit `REQUEST_CHANGES` on high findings |
| `security_notify_team` | (empty) | GitHub team to @mention on critical findings (e.g., `@org/security-team`) |

### Scheduled security scans

Expand All @@ -115,7 +112,7 @@ jobs:
security-scan:
runs-on: ubuntu-latest
steps:
- uses: Factory-AI/droid-action@v3
- uses: Factory-AI/droid-action@main
Copy link
Copy Markdown
Contributor

@factory-droid factory-droid Bot Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] [security] Add a pinning note for droid-action@main

The example now uses a mutable ref (@main), which is easy to copy/paste but also a supply-chain footgun in GitHub Actions. Consider adding a short inline note in the snippet to encourage pinning to an immutable ref (commit SHA/release) or to make the tradeoff explicit.

Suggested change
- uses: Factory-AI/droid-action@main
- uses: Factory-AI/droid-action@main # Security note: consider pinning to a commit SHA for immutable, auditable builds.

with:
security_scan_schedule: true
security_scan_days: 7 # Scan commits from the last 7 days
Expand Down Expand Up @@ -214,9 +211,6 @@ Guidelines:
| `automatic_security_review` | `false` | Run security review on every PR |
| `security_model` | (from `review_model`) | Override model for security review |
| `security_severity_threshold` | `medium` | Minimum severity to report |
| `security_block_on_critical` | `true` | Block PRs on critical findings |
| `security_block_on_high` | `false` | Block PRs on high findings |
| `security_notify_team` | (empty) | Team to @mention on critical findings |
| `security_scan_schedule` | `false` | Enable scheduled full-repo scans |
| `security_scan_days` | `7` | Days of commits to scan |

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/github-app.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ jobs:
fetch-depth: 1

- name: Run Droid Auto Review
uses: Factory-AI/droid-action@v3
uses: Factory-AI/droid-action@main
with:
factory_api_key: ${{ secrets.FACTORY_API_KEY }}
automatic_review: true
Expand Down
2 changes: 1 addition & 1 deletion docs/jp/cli/features/code-review.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ AIは以下の基準をすべて満たす場合のみ、問題をバグとして
自動 PR レビューには、[自動コードレビュー](/jp/guides/droid-exec/code-review)ワークフローを使用してください。以下をサポートしています：

- **レビューの深度**（`deep`または`shallow`）で徹底性とコストを制御
- **セキュリティレビュー**：STRIDE ベースの脆弱性スキャン、設定可能な重要度閾値、重大な発見時の PR ブロック機能付き
- **セキュリティレビュー**：STRIDE ベースの脆弱性スキャン、設定可能な重要度閾値
- **オンデマンドセキュリティスキャン**：PR での`@droid security`コメント、または`@droid security --full`でリポジトリ全体のスキャン
- **スケジュール済み全体スキャン**：cron ベースのワークフロートリガー経由

Expand Down
2 changes: 1 addition & 1 deletion docs/jp/enterprise/github-integration-security.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ permissions:
セキュリティ強化のため、Droid実行中のネットワークアクセスを制限できます：

```yaml
- uses: Factory-AI/droid-action@v1
- uses: Factory-AI/droid-action@main
with:
factory_api_key: ${{ secrets.FACTORY_API_KEY }}
experimental_allowed_domains: |
Expand Down
8 changes: 1 addition & 7 deletions docs/jp/guides/droid-exec/code-review.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,6 @@ with:
| `automatic_security_review` | `false` | 全てのPRで自動的にセキュリティレビューを実行 |
| `security_model` | （`review_model` から継承） | セキュリティ分析用のモデル |
| `security_severity_threshold` | `medium` | レポートする最小重要度：`critical`、`high`、`medium`、`low` |
| `security_block_on_critical` | `true` | 重要な発見事項で `REQUEST_CHANGES` を送信 |
| `security_block_on_high` | `false` | 重大な発見事項で `REQUEST_CHANGES` を送信 |
| `security_notify_team` | （空） | 重要な発見事項で@メンションするGitHubチーム（例：`@org/security-team`） |

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

Expand All @@ -104,7 +101,7 @@ jobs:
security-scan:
runs-on: ubuntu-latest
steps:
- uses: Factory-AI/droid-action@v3
- uses: Factory-AI/droid-action@main
Comment thread
factory-nizar marked this conversation as resolved.
with:
security_scan_schedule: true
security_scan_days: 7 # Scan commits from the last 7 days
Expand Down Expand Up @@ -192,9 +189,6 @@ Guidelines:
| `automatic_security_review` | `false` | すべてのPRでセキュリティレビューを実行 |
| `security_model` | (`review_model`から) | セキュリティレビュー用のモデルをオーバーライド |
| `security_severity_threshold` | `medium` | 報告する最小重要度 |
| `security_block_on_critical` | `true` | 重大な発見時にPRをブロック |
| `security_block_on_high` | `false` | 高い発見時にPRをブロック |
| `security_notify_team` | (空) | 重大な発見時に@mentionするチーム |
| `security_scan_schedule` | `false` | スケジュールされた全リポジトリスキャンを有効化 |
| `security_scan_days` | `7` | スキャンするコミットの日数 |

Expand Down
2 changes: 1 addition & 1 deletion docs/jp/integrations/github-app.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ jobs:
fetch-depth: 1

- name: Run Droid Auto Review
uses: Factory-AI/droid-action@v3
uses: Factory-AI/droid-action@main
with:
factory_api_key: ${{ secrets.FACTORY_API_KEY }}
automatic_review: true
Expand Down
Loading