Skip to content

docs: update code review guide to use /install-gh-app #529

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-ben merged 2 commits into from
Dec 17, 2025
Merged

docs: update code review guide to use /install-gh-app #529

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77f51f5
docs: update code review guide to use /install-gh-app
factory-ben Dec 17, 2025
4bc4e3a
docs: update code review screenshots
factory-ben Dec 17, 2025
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
68 changes: 54 additions & 14 deletions docs/cli/features/install-github-app.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,31 +207,71 @@ The Factory Droid GitHub App requires these permissions:
</Accordion>
</AccordionGroup>

## Example workflow
## Example usage

```bash
# Start droid in your repository
cd my-project
droid

# Run the installation command
> /install-gh-app
```

# Preflight checks pass automatically if gh is configured
# Select: Use current repository (my-org/my-project)
# Browser opens to install the GitHub App
# Select both workflows: @Droid and Droid Review
# PR is created with workflow files

# After the flow completes:
# 1. Add FACTORY_API_KEY secret to repository
# 2. Merge the PR
# 3. Tag @droid in an issue to test!
After completing the guided flow, Droid creates a PR with workflow files. Here's what the generated Droid Review workflow looks like:

<Accordion title="Generated Droid Review Workflow">
```yaml
name: Droid Code Review

on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]

concurrency:
group: droid-review-${{ github.event.pull_request.number }}
cancel-in-progress: true

permissions:
pull-requests: write
contents: read
issues: write

jobs:
code-review:
runs-on: ubuntu-latest
timeout-minutes: 15
if: github.event.pull_request.draft == false

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
ref: ${{ github.event.pull_request.head.sha }}

- name: Install Droid CLI
run: |
curl -fsSL https://app.factory.ai/cli | sh
echo "$HOME/.local/bin" >> $GITHUB_PATH

- name: Configure git identity
run: |
git config user.name "Droid Agent"
git config user.email "droidagent@factory.ai"

- name: Perform automated code review
env:
FACTORY_API_KEY: ${{ secrets.FACTORY_API_KEY }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
droid exec --auto high --model claude-sonnet-4-5-20250929 -f prompt.txt
```
</Accordion>

To customize the workflow after installation, see the [Automated Code Review guide](/guides/droid-exec/code-review#customizing-the-workflow).

## See also

- [GitHub Actions setup guide](https://github.com/Factory-AI/droid-action/blob/main/docs/setup.md) - Manual setup instructions
- [Automated Code Review](/guides/droid-exec/code-review) - Customizing the code review workflow
- [Factory GitHub App](https://github.com/apps/factory-droid) - Direct link to install the app
- [API keys](https://app.factory.ai/settings/api-keys) - Generate your Factory API key
- [Code Review](/cli/features/code-review) - Local code review with `/review` command
Expand Down
Loading