Skip to content

docs: add trigger configuration for local agents #10331

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

Open
continue wants to merge 1 commit into
base: main
Choose a base branch
from
+84 −0
Open

docs: add trigger configuration for local agents #10331

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
84 changes: 84 additions & 0 deletions docs/guides/run-agents-locally.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,97 @@ Agent files are markdown documents with YAML frontmatter. The frontmatter config
|-------|----------|-------------|
| `name` | Yes | Display name for the agent |
| `description` | Yes | Brief description of what the agent does |
| `on` | No | Trigger configuration for automated execution (see [Trigger Configuration](#trigger-configuration)) |

<Info>
The markdown body is the agent's system prompt. Write clear, specific instructions with examples for best results.
</Info>

For additional options like `rules`, `model`, and MCP tool configuration, see the [Create & Edit Agents](/agents/create-and-edit) guide.

### Trigger Configuration

The `on:` key defines when an agent runs automatically. When you push agent files with `on:` config to a connected GitHub repository, Continue creates the corresponding workflow triggers.

<Info>
Agents without an `on:` key default to triggering on GitHub pull request opened events.
</Info>

#### Supported Triggers

| Trigger | Frontmatter | Description |
|---------|-------------|-------------|
| GitHub events | `on: { github: { ... } }` | PR opened, merged, issues, comments, check failures |
| Cron schedule | `on: { schedule: { cron: "..." } }` | Run on a schedule (cron syntax) |
| Sentry | `on: { sentry: {} }` | New Sentry issues |
| Snyk | `on: { snyk: {} }` | New Snyk vulnerabilities |
| Slack | `on: { slack: {} }` | Slack messages |
| Webhook | `on: { webhook: {} }` | Generic webhook calls |

#### GitHub Trigger Examples

```yaml
# Trigger on PR opened to main branch
on:
github:
pull_request:
types: [opened]
branches: [main]
```

```yaml
# Trigger on issues with bug label
on:
github:
issues:
types: [opened]
labels: [bug]
```

**GitHub event types:**

| Event | Configuration |
|-------|---------------|
| PR opened | `pull_request: { types: [opened] }` |
| PR merged | `pull_request: { types: [merged] }` |
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot Feb 8, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

P2: pull_request does not emit a merged activity type. Merged PRs arrive as pull_request with action closed and pull_request.merged == true, so this example won’t match real GitHub events.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At docs/guides/run-agents-locally.mdx, line 141:

<comment>`pull_request` does not emit a `merged` activity type. Merged PRs arrive as `pull_request` with action `closed` and `pull_request.merged == true`, so this example won’t match real GitHub events.</comment>

<file context>
@@ -86,13 +86,97 @@ Agent files are markdown documents with YAML frontmatter. The frontmatter config
+| Event | Configuration |
+|-------|---------------|
+| PR opened | `pull_request: { types: [opened] }` |
+| PR merged | `pull_request: { types: [merged] }` |
+| Issue opened | `issues: { types: [opened] }` |
+| Issue labeled | `issues: { types: [labeled] }` |
</file context>
Suggested change
| PR merged | `pull_request: { types: [merged] }` |
| PR merged | `pull_request: { types: [closed] }` |
Fix with Cubic

| Issue opened | `issues: { types: [opened] }` |
| Issue labeled | `issues: { types: [labeled] }` |
| PR review comment | `pull_request_review_comment: {}` |
| Check failed | `check_run: { conclusion: [failure] }` |

Filters like `branches`, `paths`, and `labels` are optional.

#### Schedule Trigger

```yaml
# Run every weekday at 9am UTC
on:
schedule:
cron: "0 9 * * 1-5"
```

#### Multiple Triggers

Agents can have multiple triggers. Each creates a separate workflow:

```yaml
---
name: Code Guardian
description: Monitors PRs and responds to Sentry errors
on:
github:
pull_request:
types: [opened]
branches: [main]
sentry:
severity: [critical]
---

You are a code quality guardian...
```

This creates two workflows: one for GitHub PR events, one for Sentry alerts.

## Example: Conventional PR Title Agent

This agent updates pull request titles to follow conventional commit format:
Expand Down
Loading