Skip to content

Rename execution model documentation to trigger control #685

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
merged 1 commit into from
Apr 10, 2025
+10 −7
Merged

Rename execution model documentation to trigger control #685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 9 additions & 6 deletions docs/execution-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Execution Model
# Trigger Control

gitStream is triggered on new pull requests (PRs) for repositories that have gitStream installed. Upon triggering, gitStream collects context variables and evaluates the automation rules to determine which ones are relevant.

Expand All @@ -10,12 +10,12 @@ When a central `cm` repository is set with the CI/CD runner, the events for PRs

Free accounts have a monthly limit on the number of PRs that can trigger automations. Once this limit is reached:

- PRs will still be created, but gitStream will skip automations for them.
- The gitStream check on these PRs will be concluded as `Skipped`, to ensure that gitStream will not block the PR from merging.
- A warning is displayed in PR comments when the organization reaches 90% of its quota.
- The limit resets at the start of each month.
- PRs will still be created, but gitStream will skip automations for them.
- The gitStream check on these PRs will be concluded as `Skipped`, to ensure that gitStream will not block the PR from merging.
- A warning is displayed in PR comments when the organization reaches 90% of its quota.
- The limit resets at the start of each month.

To remove automation limits, <a href="https://linearb.io/contact-us" target="_blank">Contact LinearB</a> and upgrade to a paid plan.
To remove automation limits, <a href="https://linearb.io/contact-us" target="_blank">Contact LinearB</a> and upgrade to a paid plan.
🔗 Learn more: [Automation Limits](limits.md)

## Triggering Mechanism
Expand Down Expand Up @@ -71,6 +71,9 @@ The table below lists supported explicit triggers, categorized into those enable
Explicit triggers are set independently per each automation block and can be configured at the file level, specific to each automation separately or in combination. If triggers are listed at the file level **and** specific automation, the automation will be triggered according to both triggers.
If an automation block does not have explicit triggers configured, it will be triggered according to the default (implicit) triggers.

!!! Note
The `on` parameter can be used within individual automation blocks, while `triggers.include` and `triggers.exclude` can only be defined at the file level.

**Note on Matching:**

- When using a `String` as the matching type, the values in `triggers.include.*` and `triggers.exclude.*` require exact matches. This means that the names of branches or repositories must exactly match the specified string to either trigger or prevent triggering the automation.
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ nav:
- Integrations: integrations/README.md
- Reference:
- Configuration: cm-file.md
- Execution: execution-model.md
- Trigger Control: execution-model.md
- Automation Limits: limits.md
- Context variables: context-variables.md
- Filter functions: filter-functions.md
Expand Down