Skip to content

Commit 762835b

Browse files
authored
Merge pull request #729 from linear-b/triggers-in-mermaid
Add trigger control step to workflow documentation
2 parents 39c99a1 + d5376c8 commit 762835b

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/how-it-works.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ Once gitStream is installed and configured, there are several services that will
151151
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:
152152

153153
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**.
154+
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).
154155
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:
155156
* Valid CM files that match the filepath `.cm/*.cm`
156157
* Any CM files that are contained in the root directory of the organization's cm repo (if applicable).
@@ -164,6 +165,7 @@ sequenceDiagram
164165
autonumber
165166
Git Provider API->>gitStream app: PR Notification
166167
activate gitStream app
168+
gitStream app->>gitStream app: Trigger Control
167169
gitStream app->>gitStream CI/CD script: Execute CI/CD Action
168170
activate gitStream CI/CD script
169171
gitStream CI/CD script->>gitStream agent: CM Metadata

0 commit comments

Comments
 (0)