Skip to content

Document user filtering in execution model#819

Merged
vim-zz merged 3 commits intomainfrom
trigger-with-user-fitler
Nov 30, 2025
Merged

Document user filtering in execution model#819
vim-zz merged 3 commits intomainfrom
trigger-with-user-fitler

Conversation

@vim-zz
Copy link
Copy Markdown
Collaborator

@vim-zz vim-zz commented Nov 30, 2025

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

Screenshot 2025-11-12 at 16 28 39 Screenshot 2025-11-30 at 9 18 40

✨ PR Description

Purpose: Add user filtering capability to gitStream execution model documentation to support targeting automations by specific users.
Main changes:

  • Added documentation for triggers.include.user and triggers.exclude.user options
  • Updated examples to show filtering out bot users instead of using branch patterns
  • Added detailed explanation of user identification and common use cases for user filtering

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

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
Copy link
Copy Markdown

@orca-security-us orca-security-us Bot left a comment

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

Copy link
Copy Markdown
Collaborator

@MishaKav MishaKav left a comment

Choose a reason for hiding this comment

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

lg

@gitstream-cm gitstream-cm Bot requested a review from a team November 30, 2025 07:25
gitstream-cm[bot]
gitstream-cm Bot previously approved these changes Nov 30, 2025
gitstream-cm[bot]
gitstream-cm Bot previously approved these changes Nov 30, 2025
@gitstream-cm gitstream-cm Bot dismissed stale reviews from themself November 30, 2025 07:25

Review dismissed

Copy link
Copy Markdown
Contributor

@gitstream-cm gitstream-cm Bot left a comment

Choose a reason for hiding this comment

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

✨ 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

Comment thread docs/execution-model.md
Comment on lines +264 to +265
- dependabot[bot]
- renovate[bot]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 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.

Suggested change
- 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

@vim-zz vim-zz merged commit 1183354 into main Nov 30, 2025
11 checks passed
@vim-zz vim-zz deleted the trigger-with-user-fitler branch November 30, 2025 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants