Skip to content

Add trigger control step to workflow documentation #729

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 2 commits into from
May 29, 2025
Merged

Add trigger control step to workflow documentation #729

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e544a48
Add trigger control step to workflow documentation
vim-zz May 29, 2025
d5376c8
Merge branch 'main' into triggers-in-mermaid
vim-zz May 29, 2025
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
2 changes: 2 additions & 0 deletions docs/how-it-works.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ Once gitStream is installed and configured, there are several services that will
Whenever a new PR is opened or an existing PR is changed (see also [Execution Model](https://docs.gitstream.cm/execution-model/)), the following process occurs:

1. The **git service provider API** notifies the **gitStream service** that an applicable change has occured to the PR which triggers a call to execute the **gitStream CI/CD script**.
1. **Trigger Control** evaluates whether to proceed with handling based on event type, branch patterns, or repository names as configured in your [Execution Model](execution-model.md).
1. The **gitStream CI/CD script** executes the GitHub Action <a href="https://github.com/linear-b/gitstream-github-action" target="_blank">`linear-b/gitstream-github-action@v2`</a> on the repository, which looks for two things:
* Valid CM files that match the filepath `.cm/*.cm`
* Any CM files that are contained in the root directory of the organization's cm repo (if applicable).
Expand All @@ -164,6 +165,7 @@ sequenceDiagram
autonumber
Git Provider API->>gitStream app: PR Notification
activate gitStream app
gitStream app->>gitStream app: Trigger Control
gitStream app->>gitStream CI/CD script: Execute CI/CD Action
activate gitStream CI/CD script
gitStream CI/CD script->>gitStream agent: CM Metadata
Expand Down