Skip to content

Commit 3783951

Browse files
authored
Update gitStream documentation and remove explicit trigger (#762)
configurations from CMs based on new feature that skips execution with Action-Level Execution Control
1 parent 8b2483e commit 3783951

File tree

6 files changed

+23
-34
lines changed

6 files changed

+23
-34
lines changed

docs/downloads/automation-library/integrations/LinearBAI/code-review.cm

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@ manifest:
33

44
automations:
55
linearb_ai_review:
6-
# Trigger it only when PR is created or has new commits
7-
on:
8-
- pr_created
9-
- commit
6+
# Triggers only when PR is created or has new commits, see docs
7+
# https://docs.gitstream.cm/execution-model/#action-level-execution-control
108
if:
119
- {{ not pr.draft }}
1210
- {{ not (is.bot_author or is.bot_branch) }}

docs/downloads/automation-library/integrations/LinearBAI/describe-pr.cm

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,9 @@ manifest:
33

44
automations:
55
linearb_ai_description:
6-
# Trigger it only when PR is created or has new commits
7-
# Note: explicit triggers are ignored for GitLab or Bitbucket
8-
on:
9-
- pr_created
10-
- commit
11-
# skip description for Draft PRs and PRs from bots
6+
# Triggers only when PR is created or has new commits, see docs
7+
# https://docs.gitstream.cm/execution-model/#action-level-execution-control
8+
# Skip description for Draft PRs and PRs from bots
129
if:
1310
- {{ not pr.draft }}
1411
- {{ not (is.bot_author or is.bot_branch) }}

docs/downloads/automation-library/integrations/ai-assistance/comment_ai_prompt.cm

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ manifest:
66
triggers:
77
on:
88
- pr_created
9-
9+
1010
automations:
1111
comment_ai_assistance_prompt:
1212
# Post a comment for all PRs to prompt the PR author to indicate whether they used AI to assist coding in this PR
@@ -22,14 +22,14 @@ automations:
2222
2323
- [ ] GitHub Copilot
2424
- [ ] Cursor
25+
- [ ] Zed
2526
- [ ] Tabnine
2627
- [ ] JetBrains AI Assistant
2728
- [ ] VSCode IntelliCode
2829
- [ ] ChatGPT
29-
- [ ] Claude
30+
- [ ] Claude Code
3031
- [ ] Gemini
3132
- [ ] Other AI tool
3233
- [ ] No AI tools were used
3334
3435
Tip: If you want to avoid this comment in the future, you can add a label of the format `🤖 ai-*` when creating your PR.
35-

docs/downloads/gitstream.cm

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,21 @@ manifest:
66

77

88
automations:
9+
910
# Use LinearB's AI service to review the changes
1011
linearb_ai_review:
11-
on:
12-
- pr_created
13-
- commit
1412
if:
15-
- {{ not pr.draft }}
16-
- {{ not is.bot }}
13+
- {{ not (pr.draft or is.bot) }}
1714
run:
1815
- action: code-review@v1
1916
args:
2017
approve_on_LGTM: {{ calc.safe_changes }}
2118

19+
2220
# Use LinearB's AI service to add a description to the PR
2321
linearb_ai_description:
24-
on:
25-
- pr_created
26-
- commit
2722
if:
28-
- {{ not pr.draft }}
29-
- {{ not is.bot }}
23+
- {{ not (pr.draft or is.bot) }}
3024
run:
3125
- action: describe-changes@v1
3226
args:
@@ -41,6 +35,7 @@ automations:
4135
args:
4236
label: "{{ calc.etr }} min review"
4337
color: {{ colors.red if (calc.etr >= 20) else ( colors.yellow if (calc.etr >= 5) else colors.green ) }}
38+
4439
# Inform PR authors when they fail to reference Jira tickets in the PR title or description.
4540
label_missing_jira_info:
4641
if:
@@ -55,12 +50,9 @@ automations:
5550
comment: |
5651
This PR is missing a Jira ticket reference in the title or description.
5752
Please add a Jira ticket reference to the title or description of this PR.
53+
5854
# Post a comment that lists the best experts for the files that were modified.
5955
explain_code_experts:
60-
on:
61-
- pr_created
62-
- pr_ready_for_review
63-
- commit
6456
if:
6557
- true
6658
run:

docs/downloads/sales_demo.cm

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ manifest:
66

77

88
automations:
9+
910
# Add a label that indicates how many minutes it will take to review the PR.
1011
estimated_time_to_review:
1112
if:
@@ -15,6 +16,7 @@ automations:
1516
args:
1617
label: "{{ calc.etr }} min review"
1718
color: {{ colors.red if (calc.etr >= 20) else ( colors.yellow if (calc.etr >= 5) else colors.green ) }}
19+
1820
# Inform PR authors when they fail to reference Jira tickets in the PR title or description.
1921
label_missing_jira_info:
2022
if:
@@ -29,21 +31,19 @@ automations:
2931
comment: |
3032
This PR is missing a Jira ticket reference in the title or description.
3133
Please add a Jira ticket reference to the title or description of this PR.
34+
35+
# Detect PRs that contain the text '#copilot#' in the title, description, comments, or commit messages
3236
label_copilot:
33-
# Detect PRs that contain the text '#copilot#' in the title, description, comments, or commit messages
3437
if:
3538
- {{ copilot_tag.pr_title or copilot_tag.pr_desc or copilot_tag.pr_comments or copilot_tag.commit_messages }}
3639
# Apply a label indicating the user has adopted Copilot
3740
run:
3841
- action: add-label@v1
3942
args:
4043
label: '🤖 Copilot'
44+
4145
# Post a comment that lists the best experts for the files that were modified.
4246
explain_code_experts:
43-
on:
44-
- pr_created
45-
- pr_ready_for_review
46-
- commit
4747
if:
4848
- true
4949
run:

docs/execution-model.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Trigger Control
22

3-
!!! warning "GitHub Only Feature :fontawesome-brands-github:"
4-
Explicit triggers (using `on`, `triggers.on`, `triggers.include`, and `triggers.exclude` parameters) are only supported on GitHub. Using explicit triggers in GitLab or Bitbucket will cause the automation to fail with an error. For GitLab and Bitbucket, simply omit trigger configuration to use implicit triggers automatically.
3+
!!! warning "Platform Limitations"
4+
**Explicit triggers** (using `on`, `triggers.on`, `triggers.include`, and `triggers.exclude` parameters) are only supported on GitHub :fontawesome-brands-github:. Using explicit triggers in GitLab or Bitbucket will cause the automation to fail with an error. For GitLab and Bitbucket, simply omit trigger configuration to use implicit triggers automatically.
5+
6+
However, other execution control concepts covered in this document, such as action-level execution control, apply to all supported platforms (GitHub, GitLab, and Bitbucket).
57

68
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.
79

0 commit comments

Comments
 (0)