Document user filtering in execution model#819
Conversation
Add support for user-based trigger filtering to control which users can trigger automations. This enables excluding bot accounts and restricting automations to specific team members. Changes include: - New `triggers.include.user` and `triggers.exclude.user` configuration - Updated matching rules and default behavior documentation - Added user filtering examples and common use cases - Refactored Dependabot/Renovate example to use user filtering instead of branch patterns - Reorganized trigger documentation with subsection headings for clarity
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Infrastructure as Code | View in Orca | ||
| SAST | View in Orca | ||
| Secrets | View in Orca | ||
| Vulnerabilities | View in Orca |
There was a problem hiding this comment.
✨ PR Review
The PR adds comprehensive documentation for user-based trigger filtering, which is well-structured and includes helpful examples. The changes successfully refactor the Dependabot/Renovate example to use the new user filtering approach instead of branch patterns, making the configuration more precise and maintainable.
1 issues detected:
🧹 Maintainability - Configuration contains duplicate exclusion logic that matches the same users, reducing clarity and maintainability 🛠️
Details: The example configurations contain redundant user exclusion patterns. In both the Dependabot/Renovate section and the user filtering examples, explicit entries like 'dependabot[bot]' and 'renovate[bot]' are listed alongside regex patterns that already match them (e.g., 'r/(bot|dependabot|renovate)/' and 'r/(bot|scanner)/'). Since these regex patterns match any username containing 'bot', the explicit entries serve no additional purpose and could confuse users who copy these examples.
File:docs/execution-model.md (264-265)
🛠️ A suggested code correction is included in the review comments.
Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using.
💡 Tip: You can customize your AI Review using Guidelines Learn how
| - dependabot[bot] | ||
| - renovate[bot] |
There was a problem hiding this comment.
🧹 Maintainability - Redundant Exclusions: Remove the redundant explicit entries when using catch-all regex patterns. Either use explicit string matching (dependabot[bot], renovate[bot]) OR comprehensive regex patterns (r/(bot|scanner)/), but avoid mixing overlapping approaches in the same example. Alternatively, split these into separate examples labeled "Explicit matching" and "Pattern matching" to clearly demonstrate each approach independently.
| - dependabot[bot] | |
| - renovate[bot] |
Is this review accurate? Use 👍 or 👎 to rate it
If you want to tell us more, use /gs feedback e.g. /gs feedback this review doesn't make sense, I disagree, and it keeps repeating over and over
Add support for user-based trigger filtering to control which users can trigger automations. This enables excluding bot accounts and restricting automations to specific team members.
Changes include: - New
triggers.include.userandtriggers.exclude.userconfiguration - Updated matching rules and default behavior documentation - Added user filtering examples and common use cases - Refactored Dependabot/Renovate example to use user filtering instead of branch patterns - Reorganized trigger documentation with subsection headings for clarity✨ PR Description
Purpose: Add user filtering capability to gitStream execution model documentation to support targeting automations by specific users.
Main changes:
Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using.
💡 Tip: You can customize your AI Description using Guidelines Learn how