Skip to content

Document bots field in frontmatter reference #13454

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
pelikhan merged 2 commits into from
Feb 3, 2026
Merged

Document bots field in frontmatter reference #13454

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48862d3
Initial plan
Copilot Feb 3, 2026
8b812cf
Add documentation for bots field in frontmatter reference
Copilot Feb 3, 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
24 changes: 24 additions & 0 deletions docs/src/content/docs/reference/frontmatter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,30 @@ roles: all # Allow any user (⚠️ use with caution)

Available roles: `admin`, `maintainer`, `write`, `read`, `all`. Workflows with unsafe triggers (`push`, `issues`, `pull_request`) automatically enforce permission checks. Failed checks cancel the workflow with a warning.

### Bot Filtering (`bots:`)

Configure which GitHub bot accounts can trigger workflows. Useful for allowing specific automation bots while maintaining security controls.

```yaml wrap
bots:
- "dependabot[bot]"
- "renovate[bot]"
- "agentic-workflows-dev[bot]"
```

**Behavior**:
- When specified, only the listed bot accounts can trigger the workflow
- The bot must be active (installed) on the repository to trigger the workflow
- Combine with `roles:` for comprehensive access control
- Applies to all workflow triggers (`pull_request`, `issues`, etc.)
- When `roles: all` is set, bot filtering is not enforced

**Common bot names**:
- `dependabot[bot]` - GitHub Dependabot for dependency updates
- `renovate[bot]` - Renovate bot for automated dependency management
- `github-actions[bot]` - GitHub Actions bot
- `agentic-workflows-dev[bot]` - Development bot for testing workflows

### Strict Mode (`strict:`)

Enables enhanced security validation for production workflows. **Enabled by default**.
Expand Down
Loading