Skip to content

docs: document the team review as the default per-PR setup #7

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
pierrick-fonquerne merged 1 commit into from
Jun 4, 2026
Merged

docs: document the team review as the default per-PR setup #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 19 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,34 +24,37 @@ reusable workflow forwards from its `mode` input.

### Calling the reusable workflow

Default per-PR review:
Default per-PR setup, the multi-agent team review plus the PR description.
The `permissions` block is required: a reusable workflow cannot escalate
beyond the ceiling set by its caller.

```yaml
on:
pull_request:
types: [opened, synchronize]
branches: [main]

permissions:
contents: read
pull-requests: write

jobs:
review:
team:
uses: nubster-opensources/.github/.github/workflows/ai-review.yml@main
with:
pr-number: ${{ github.event.pull_request.number }}
mode: review
mode: team
secrets:
mistral-api-key: ${{ secrets.MISTRAL_API_KEY }}
```

Team mode is heavier, so trigger it on demand by adding the `ai:team` label to a
pull request:

```yaml
on:
pull_request:
types: [opened, synchronize, reopened, labeled]

jobs:
team:
if: contains(github.event.pull_request.labels.*.name, 'ai:team')
describe:
uses: nubster-opensources/.github/.github/workflows/ai-review.yml@main
with:
pr-number: ${{ github.event.pull_request.number }}
mode: team
mode: describe
secrets:
mistral-api-key: ${{ secrets.MISTRAL_API_KEY }}
```

Any other mode (`review`, `security`, `architecture`, `performance`,
`product`) can be invoked the same way by passing it as the `mode` input.