Skip to content
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.

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

trigggers-refinement #604

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

trigggers-refinement #604

wants to merge 3 commits into from

Conversation

PavelLinearB
Copy link
Member

workerB

Copy link

@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 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

docs/execution-model.md Outdated Show resolved Hide resolved
Copy link

@yeelali14 yeelali14 left a comment

Choose a reason for hiding this comment

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

please see comment

@gitstream-cm gitstream-cm bot requested a review from a team November 18, 2024 12:42
Copy link
Contributor

gitstream-cm bot commented Nov 18, 2024

  • Clarified description of the triggers section in gitStream to indicate its role in controlling when automations execute.
  • Explained that include and exclude lists are used to specify branch and repository patterns to trigger or bypass automation, without affecting event initiation.
  • Expanded the explanation of the on keyword, highlighting its use for defining specific events that trigger automations, either at the file level or within individual automations.
  • Added information on how multiple triggers can be stacked for flexibility in automation behavior.

Comment on lines +29 to +31
The `triggers` section in gitStream gives you precise control over when automations execute. It allows you to define conditions based on pull request events using `include` and `exclude` lists to specify branch and repository patterns. These lists determine which branches or repositories trigger or bypass automation but do not affect the events initiating automations.

The `triggers` is section specifies when automations are executed, supporting `include` and `exclude` lists for branch and repository patterns at the file level.

The `on` keyword can also be used within individual automations to define specific events that trigger those automations. Add the `on` keyword under the `triggers` key in the file and/or to a specific automation to define explicit triggers.
Additionally, the `on` keyword defines specific events that trigger automations. It can be added at the file level (under the `triggers` section) or within individual automations for greater customization. Multiple triggers can be stacked, meaning gitStream will execute the automation for each matching triggering event, allowing flexibility in defining automation behavior

Choose a reason for hiding this comment

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

The triggers section in gitStream controls when automations run. Use include and exclude lists to specify branch and repository patterns that trigger or bypass automation, without affecting event initiation.

The on keyword defines specific triggering events and can be used at the file level (in triggers) or within individual automations. Triggers are combined using an AND relation, meaning all conditions must match for the automations to execute.

Example: Run automation on pr_created and if the branch name includes the word "fix_".

Copy link
Member Author

Choose a reason for hiding this comment

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

"Triggers are combined using an AND relation, meaning all conditions must match for the automations to execute." Is not true. These are triggering events, and one of them is enough to trigger gitStream
That's why I want to avoid the use of OR/AND. It is confusing, and an explanation seems enough IMO.

Examples are available at the bottom of the file

Copy link

@yeelali14 yeelali14 left a comment

Choose a reason for hiding this comment

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

Please see suggestion

@gitstream-cm gitstream-cm bot requested a review from a team November 18, 2024 13:14
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