Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 31 additions & 12 deletions docs/src/content/docs/reference/frontmatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,31 +179,50 @@ engine:
- **`max-turns`** (optional): Maximum number of chat iterations per run (cost-control option)
- **`env`** (optional): Custom environment variables to pass to the agentic engine as key-value pairs

### Environment Variables and Secret Overrides

The `env` option supports overriding default secrets and environment variables used by engines:

**Basic Environment Variables:**
```yaml
engine:
id: claude
env:
AWS_REGION: us-west-2
CUSTOM_API_ENDPOINT: https://api.example.com
DEBUG_MODE: "true"
```

**Secret Override Example:**

You can override default secrets used by engines. This is particularly useful for Codex workflows when you need to use a different OpenAI API key:

```yaml
engine:
id: codex
model: gpt-4
env:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY_CI }}
```

This configuration overrides the default `OPENAI_API_KEY` secret with your custom secret, allowing you to use organization-specific API keys without duplicating secrets.

### Turn Limiting

The `max-turns` option is configured within the engine configuration to limit the number of chat iterations within a single agentic run:

```yaml
engine:
id: claude
max-turns: 5
```
0

**Behavior:**
1. Passes the limit to the AI engine (e.g., Claude Code action)
2. Engine stops iterating when the turn limit is reached
3. Helps prevent runaway chat loops and control costs
4. Only applies to engines that support turn limiting (currently Claude)

The `env` option allows you to pass custom environment variables to the agentic engine:

```yaml
engine:
id: claude
env:
- "AWS_REGION=us-west-2"
- "CUSTOM_API_ENDPOINT: https://api.example.com"
- "DEBUG_MODE: true"
```

## Tools Configuration (`tools:`)

The `tools:` section specifies which tools and MCP (Model Context Protocol) servers are available to the AI engine. This enables integration with GitHub APIs, browser automation, and other external services.
Expand Down
53 changes: 28 additions & 25 deletions pkg/cli/workflows/test-claude-missing-tool.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/cli/workflows/test-codex-add-issue-comment.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/cli/workflows/test-codex-add-issue-labels.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/cli/workflows/test-codex-command.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading