Automation actions
Actions are the end results of the automation described in your .cm file.
Legend
The icons indicate the availability status of each action.
- Supported on GitHub
- Supported on GitLab
- Open beta - Feature is under development and currently available for all
Overview
send-http-request is executed immediately after the evaluation of the condition. For all other actions, gitStream executes the actions in the order they are listed per automation. If an action result fails, the following actions will not be executed.
add-commentadd-github-checkadd-labeladd-labelsadd-reviewersapprovecloseexplain-code-expertsmergerequest-changesrequire-reviewersrun-github-workflowsend-http-requestsend-slack-messageset-required-approvalsupdate-descriptionupdate-title
Note
Multiple actions can be listed in a single automation. The actions are invoked one by one.
Dynamic actions arguments
Arguments values a dynamic value is supported using expressions based on Jinja2 syntax, and includes gitStream context variables, for example:
automations:
+ pr_complexity:
+ if:
+ - true
+ run:
+ - action: add-comment@v1
+ args:
+ comment: "Estimated {{ branch | estimatedReviewTime }} minutes to review"
+Reference
add-comment
This action, once triggered, adds a comment to the PR.
This is a managed action, when a PR updates, the existing comments that were added by gitStream are re-evaluated and those that are not applicable are removed.
| Args | Usage | Type | Description |
|---|---|---|---|
comment | Required | String | Sets the comment, markdown is supported |
example
automations:
+ senior_review:
+ if:
+ - {{ files | match(term='core/') | some }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ Core service update
+ (Updates API)
+add-github-check
This action, once triggered, adds a completed check with the specified conclusion to the listed checks in the PR.
| Args | Usage | Type | Description |
|---|---|---|---|
check_name | Required | String | The check name to be added to the checks list on gitHub |
conclusion | Required | String | The conclusion of the check. The value is one of the following: action_required, cancelled, timed_out, failure, neutral, skipped, success |
example
automations:
+ # Skip UI checks if the PR doesn't have a UI code changes
+ skip_ui_check:
+ if:
+ - {{ not has.fe_code_changes }}
+ run:
+ - action: add-github-check@v1
+ args:
+ check_name: FE-tests
+ conclusion: skipped
+has:
+ fe_code_changes: {{ files | match(regex=r/frontend\//) | some }}
+add-label
This action, once triggered, adds a label to the PR.
This is a managed action, when a PR updates, the existing labels that were added by gitStream are re-evaluated and those that are not applicable are removed.
| Args | Usage | Type | Description |
|---|---|---|---|
label | Required | String | The label text any string can work |
color | Optional | String | The color in hex, for example: 'FEFEFE' (you can also add # prefix #FEFEFE) |
example
automations:
+ senior_review:
+ if:
+ - {{ files | match(term='api/') | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: api-change
+add-labels
This action, once triggered, adds a list of labels to the PR.
This is a managed action, when a PR updates existing labels that were added by gitStream are re-evaluated and those that are not applicable are removed.
| Args | Usage | Type | Description |
|---|---|---|---|
labels | Required | [String] | The list of text labels |
add-reviewers
This action, once triggered, sets a specific reviewer.
| Args | Usage | Type | Description |
|---|---|---|---|
reviewers | Required | [String] | Sets required reviewers. Supports user names and teams. Teams notated by adding a prefix with the owner name e.g. owner/team |
team_reviewers | Optional | [String] | Sets required team reviewers without a prefix team |
unless_reviewers_set | Optional | Bool | When true, the reviewers are not added if the PR has already assigned reviewers. It is set to false by default |
fail_on_error | Optional | Bool | When true, trying to assign illegal reviewers shall fail the automation, when false these errors are silently ignored. It is set to true by default |
wait_for_all_checks | Optional | Boolean | By default false. When true, the action will add reviewers only if all checks (except gitStream) are completed with neutral, skipped, or success conclusion |
example
automations:
+ senior_review:
+ if:
+ - {{ files | match(term='src/ui/') }}
+ run:
+ - action: add-reviewers@v1
+ args:
+ reviewers: [popeye, olive, acme/team-a]
+Enable Team Write Access
If you want to assign teams as PR reviewers, you need to first make sure the team has write access to the repo in via your organization's settings. For more info, refer to the GitHub instructions for managing team review settings.
explain-code-experts
This action, shall add a comment with codeExperts suggestion. If the comment already exists, the comment shall be edited.
| Args | Usage | Type | Description |
|---|---|---|---|
lt | Optional | Integer | Filter the user list, keeping those below the specified threshold |
gt | Optional | Integer | Filter the user list, keeping those above the specified threshold |
verbose | Optional | Bool | When set to false then only shows the suggestion summary and skips the per file details (true by default) |
example
automations:
+ code_experts:
+ if:
+ - true
+ run:
+ - action: explain-code-experts@v1
+ args:
+ gt: 10
+approve
This action, once triggered, approves the PR for merge.
This is a managed action, when a PR updates existing approval by gitStream is re-evaluated and removed if no longer applicable.
example
automations:
+ small_change:
+ if:
+ - {{ source.diff.files | isFormattingChange }}
+ run:
+ - action: approve@v1
+close
This action, once triggered, close the PR without merging.
example
automations:
+ close_ui_changes_by_non_ui:
+ if:
+ - {{ files | match(regex=r/src\/views/) | some }}
+ - {{ pr.author_teams | match(term='ui-team') | nope }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ Please contact a member of `ui-team` team if you need to make changes to files in `src/views`
+ - action: close@v1
+merge
Once triggered, merge the PR if possible. It can be set to wait for all checks to pass or only required ones.
| Args | Usage | Type | Description |
|---|---|---|---|
wait_for_all_checks | Optional | Boolean | By default false, so only Required checks can block merge, when true the action will merge after all checks are completed with neutral, skipped, or success conclusion (except gitStream itself) |
rebase_on_merge | Optional | Boolean | By default false, when merging use rebase mode |
squash_on_merge | Optional | Boolean | By default false, when merging use squash mode |
example
automations:
+ small_change:
+ if:
+ - {{ files | allDocs }}
+ run:
+ - action: merge@v1
+ args:
+ rebase_on_merge: true
+request-changes
This action, once triggered, requests changes on the PR. As long as request change is set, gitStream will block the PR merge.
This is a managed action, when a PR updates an existing change request by gitStream is re-evaluated and removed if no longer applicable.
| Args | Usage | Type | Description |
|---|---|---|---|
comment | Required | [String] | The desired request changes comment |
example
automations:
+ catch_deprecated:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/^[+].*oldFetch/) | some }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ You have used deprecated API `oldFetch`, use `newFetch` instead.
+Attention
To allow this action to block merge, The following settings should be set:
Enable branch protection and set gitStream as a required check
Enable the "All threads must be resolved" Merge check
require-reviewers
This action, once triggered, requires a specific reviewer approval. The PR merge is blocked till approved by either of the listed users or teams.
| Args | Usage | Type | Description |
|---|---|---|---|
reviewers | Required | [String] | Sets required reviewers. Supports user names and teams. Teams notated by adding a prefix with the owner name e.g. owner/team. Merge is blocked till approved by either of the listed users |
also_assign | Optional | Bool | true by default, also assign the specified users as reviewers |
example
automations:
+ senior_review:
+ if:
+ - {{ files | match(regex=r/src\/ui\//) | some }}
+ run:
+ - action: require-reviewers@v1
+ args:
+ reviewers: [popeye, olive, acme/team-a]
+Attention
To allow this action to block merge, you should enable branch protection, and gitStream has to be set as required check in GitHub.
run-github-workflow
This action, once triggered, will start a workflow dispatch automation with the option to add a check to the list of checks in the PR
| Args | Usage | Type | Description |
|---|---|---|---|
workflow | Required | String | The ID or name of the workflow dispatch. |
owner | Optional | String | By default, the value of repo.owner context variable. The account owner of the repository. Case insensitive. |
repo | Optional | String | By default, the value of repo.name context variable. The name of the repository without the .git extension. Case insensitive. |
ref | Optional | String | By default, the value of branch.name context variable. The account owner of the repository. Case insensitive. |
inputs | Optional | String | By default, an empty list. Key-Value list with the arguments to provide to the workflow |
check_name | Optional | String | When added, after the workflow is complete, add the check name to the checks list on GitHub |
stop_ongoing_workflow | Optional | Boolean | By default, false. In case the workflow already runs on the branch, if true: cancel the ongoing workflow before running the newly dispatched workflow. If false: wait for the old workflow to finish before dispatching a new one |
example
on:
+ - commit
+
+automations:
+ run_workflow_dispatch:
+ if:
+ - {{ has.fe_code_changes }}
+ run:
+ - action: run-github-workflow@v1
+ args:
+ owner: {{ repo.owner }}
+ repo: {{ repo.name}}
+ workflow: .github/workflows/frontend-manual.yml
+ ref: {{ branch.name }}
+ check_name: FE-tests
+has:
+ fe_code_changes: {{ files | match(regex=r/frontend\//) | some }}
+Attention
- This action will invoke the run of a workflow dispatch; thus, it might result in significant GitHub action minutes charge.
- We encourage you to use this action with custom triggers
send-http-request
The action, once triggered, sends an HTTP request to the specified URL
| Args | Usage | Type | Description |
|---|---|---|---|
url | Required | String | The request URL |
method | Optional | String | By default GET, the request method |
headers | Optional | [String] | Empty by default ([]), Key-Value list of strings, which will be sent as the HTTP headers |
user | Optional | String | Empty by default, format: 'username:password'. If used - adds a Basic-auth HTTP header, by setting the Authorization header. Using this arg will override any existing Authorization header that was set using headers |
body | Optional | String | Empty by default, the data to be sent as the request body. Only applicable for request methods PUT, POST, DELETE, and PATCH |
timeout | Optional | String | Empty by default (no timeout), the number of milliseconds before the request times out. When the time out is reached, the request will be aborted |
example
automations:
+ send_webhook:
+ if:
+ - true
+ run:
+ - action: send-http-request@v1
+ args:
+ url: "http://WEBHOOK_URL"
+ method: POST
+ headers: '{"Content-type": "application/json"}'
+ body: '{"text": "Hello, world!"}'
+send-slack-message
The action, once triggered, sends a webhook with a message content to a Slack app. To use this action, create a Slack app with Incoming Webhooks enabled. gitStream uses the webhook URL to send the message.
| Args | Usage | Type | Description |
|---|---|---|---|
message | Required | String | The message content |
webhook_url | Optional | String | The webhook URL. Use the env variable to pass secrets |
example
automations:
+ send_slack:
+ if:
+ - true
+ run:
+ - action: send-slack-message@v1
+ args:
+ message: "Hello world :tada:."
+ webhook_url: "{{ slack_webhook }}"
+
+slack_webhook: {{ env.SLACK_WEBHOOK }}
+set-required-approvals
This action, once triggered, blocks PR merge till the desired reviewers approved the PR. The actions fail the check to prevent the PR for merge.
| Args | Usage | Type | Description |
|---|---|---|---|
approvals | Required | Integer | Sets the number of required reviewer approvals for merge for that PR |
example
automations:
+ double_review:
+ if:
+ - {{ files | match(regex=r/agent\//) | some }}
+ run:
+ - action: set-required-approvals@v1
+ args:
+ approvals: 2
+Attention
To allow this action to block merge, you should enable branch protection, and gitStream has to be set as required check in GitHub.
update-description
This action, when triggered, updates the PR description with new content.
This is a managed action. When a PR updates, the existing comments that were added by gitStream are re-evaluated, and those that are not applicable are removed.
| Args | Usage | Type | Description |
|---|---|---|---|
description | Required | String | Sets the PR description |
concat_mode | Optional | String | replace by default, the mode to concatenate the new description with the existing one. Possible values: prepend, append, replace |
For example, this automation updates the PR description with the ticket info if present in the PR title.
example
automations:
+ add_jira_to_desc:
+ if:
+ - {{ has.jira_ticket_in_title and (not has.jira_ticket_in_desc) }}
+ run:
+ - action: update-description@v1
+ args:
+ concat_mode: prepend
+ description: |
+ {{ jira_ticket_from_title }}
+
+has:
+ jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
+ jira_ticket_in_desc: {{ pr.description | includes(regex=r/atlassian.net\/browse\/\w{1,}-\d{3,4}/) }}
+
+jira_ticket_from_title: {{ pr.title | capture(regex=r/\b[A-Za-z]+-\d+\b/) }}
+update-title
This action, when triggered, updates the PR title with new content.
This is a managed action. When a PR updates, the existing comments that were added by gitStream are re-evaluated, and those that are not applicable are removed.
| Args | Usage | Type | Description |
|---|---|---|---|
title | Required | String | Sets the PR title |
concat_mode | Optional | String | replace by default, the mode to concatenate the new description with the existing one. Possible values: prepend, append, replace |
For example, this automation updates the PR title with the ticket info if present in the PR title.
example
automations:
+ add_jira_to_title:
+ if:
+ - {{ has.jira_ticket_in_desc and (not has.jira_ticket_in_title) }}
+ run:
+ - action: update-title@v1
+ args:
+ concat_mode: prepend
+ title: |
+ {{ jira_ticket_from_desc }} -
+
+has:
+ jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
+ jira_ticket_in_desc: {{ pr.description | includes(regex=r/atlassian.net\/browse\/\w{1,}-\d{3,4}/) }}
+
+jira_ticket_from_desc: {{ pr.description | capture(regex=r/\b[A-Za-z]+-\d+\b/) }}
+Additional Review for Large PRs
Require 2 reviewers for PRs that have more than 10 changed files in the src directory and the estimated time to review is 30 or more minutes.
Configuration Description
Conditions (all must be true):
- There are 10 or more changed files
- The estimated time to review is 30 minutes or more.
- One or more of the changed files is inside the
srcdirectory.
Automation Actions:
- Require a minumim of 2 reviews.
- Post a comment that explains this is considered a large change that requires 2 reviews.
Additional Review for Large PRs
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ additional_review_for_large_pr:
+ if:
+ - {{ branch | estimatedReviewTime >= 30 }}
+ - {{ files | length >= 10 }}
+ - {{ files | match(regex=r/src\//) | some }}
+ run:
+ - action: set-required-approvals@v1
+ args:
+ approvals: 2
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR is a large change and requires 2 reviews.
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Assign or suggest reviewers based on level of code expertise for the code changed in a PR.
- Assign reviewers based on modified directories and files
- Assign reviewers to share knowledge based on pre-determined criteria
More Automations can be found on the Automation Library and Integrations pages.
Approve Safe Changes
Automatically approve PRs that change docs, tests, and other safe assets.
Configuration Description
Conditions (all must be true):
- The PR only contains documentation, tests, or formatting changes.
Automation Actions:
- Add a
safe-changelabel - Approve the PR
- Post a comment that explains that this is a safe change
Approve Safe Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ safe_changes:
+ # Triggered for any changes that only affect formatting, documentation, tests, or images
+ if:
+ - {{ is.formatting or is.docs or is.tests or is.image }}
+ # Apply a safe change label, approve the PR and explain why in a comment.
+ run:
+ - action: add-label@v1
+ args:
+ label: 'safe-change'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR is considered a safe change and has been automatically approved.
+
+# These custom expressions are used in the safe_changes automation
+is:
+ formatting: {{ source.diff.files | isFormattingChange }}
+ docs: {{ files | allDocs }}
+ tests: {{ files | allTests }}
+ image: {{ files | allImages }}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Approve low-risk PRs from trusted teams.
- Approve Python or JavaScript formatting changes.
- Approve Tiny Changes
- Approve JSDoc or Javadoc changes.
- Approve and Merge Dependabot PRs
More Automations can be found on the Automation Library and Integrations pages.
Approve Trusted Team
Automatically approve low-risk PRs from trusted teams.
Configuration Description
Conditions (all must be true):
- All changed files are inside the
docsdirectory - The PR author is on the
tech-writersteam.
Automation Actions:
- Approve the PR
- Post a comment that explains the approval.
Approve Expert Team
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_team_by_directory:
+ # Triggered for PRs that only include changes to files inside the docs directory,
+ # and that are authored by someone on the tech-writers team.
+ if:
+ - {{ files | match(regex=r/docs\//) | every }}
+ - {{ pr.author_teams | match(term='tech-writers') }}
+ run:
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ Docs changes from the tech-writers team are automatically approved.
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Automatically approve changes to docs, tests, and other safe assets.
- Approve Python or JavaScript formatting changes.
- Approve Tiny Changes
- Approve JSDoc or Javadoc changes.
- Approve and Merge Dependabot PRs
More Automations can be found on the Automation Library and Integrations pages.
Approve test changes
Label and approve PRs that only include tests, and post an explanation comment.
Configuration Description
Conditions (all must be true):
- The PR only contains changes to tests
Automation Actions:
- Add a tests-only label
- Approve the PR
- Post a comment that explains why the PR was approved.
Approve Tests
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_tests:
+ if:
+ # Triggered for PRs that only include changes to tests
+ - {{ files | allTests }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'tests-only'
+ - action: add-comment@v1
+ args:
+ comment: |
+ This merge has been automatically approved because it only contains changes to tests.
+ - action: approve@v1
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Automatically approve changes to docs, tests, and other safe assets.
- Approve low-risk PRs from trusted teams.
- Approve Python or JavaScript formatting changes.
- Approve Tiny Changes
- Approve JSDoc or Javadoc changes.
- Approve and Merge Dependabot PRs
More Automations can be found on the Automation Library and Integrations pages.
Approve Tiny Changes
Approve single-line changes to a single file.
Configuration Description
Conditions (all must be true):
- If the PR contains a one-line change to a single file.
Automation Actions:
- Apply a
single-linelabel. - Approve the PR.
- Post a comment explaining why the PR was approved.
name
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_tiny_change:
+ # Triggered for PRs that contain one file and one line.
+ if:
+ - {{ is.one_file and is.one_line }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'single-line'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it is only a single line
+
+changes:
+ # Sum all the lines added in the PR
+ additions: {{ branch.diff.files_metadata | map(attr='additions') | sum }}
+ # Sum all the line removed in the PR
+ deletions: {{ branch.diff.files_metadata | map(attr='deletions') | sum }}
+
+is:
+ one_file: {{ files | length == 1 }}
+ one_line: {{ changes.additions - changes.deletions <= 1 }}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Automatically approve changes to docs, tests, and other safe assets.
- Approve low-risk PRs from trusted teams.
- Approve Python or JavaScript formatting changes.
- Approve JSDoc or Javadoc changes.
- Approve and Merge Dependabot PRs
More Automations can be found on the Automation Library and Integrations pages.
Assign Reviewers by Directory
Automatically assign code reviewers based on directory structure. Optionally, you can substitue require-reviewers for add-reviewers to make review from the specified teams and individuals mandatory.
Configuration Description
Conditions (all must be true):
- The PR contains changes to JavaScript files inside the
src/uidirectory.
Automation Actions:
- Add a user named
my-teamateand a team namedmy-organization/ui-teamas reviewers. These should be customized to match your organization. - Post a comment explaining why these reviewers were assigned.
Assign Reviewers by Directory
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ review_ui:
+ # Triggered for PRs that contain any changes to JavaScript files inside the `src/ui` directory.
+ if:
+ - {{ files | match(regex=r/src\/ui\/.*/) | some}}
+ # Add a specified user and team as reviewers.
+ # Customize the reviewers to match your organization
+ run:
+ - action: add-reviewers@v1
+ args:
+ reviewers: [my-teamate, my-organization/security]
+ - action: add-comment@v1
+ args:
+ comment: |
+ The Security team has automatically been added for review because this PR contains changes to components inside `/src/ui`
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Assign additional reviewers for large PRs
- Assign or suggest reviewers based on level of code expertise for the code changed in a PR.
- Assign reviewers to share knowledge based on pre-determined criteria
More Automations can be found on the Automation Library and Integrations pages.
Assign team members as reviewers
Assign PR reviewer based on the owner team membership.
You can also omit the | first filter to assign all teams the owner is member of.
name
Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Assign additional reviewers for large PRs
- Assign or suggest reviewers based on level of code expertise for the code changed in a PR.
- Assign reviewers based on modified directories and files
- Assign reviewers to share knowledge based on pre-determined criteria
More Automations can be found on the Automation Library and Integrations pages.
gitStream Automation Library
This library of gitStream examples is meant to serve as a starting point for your automation. We encourage you to customize them for your project and organization.
How to use these examples.
These examples are all complete gitStream configuration files that you can download directly via the buttons below the examples and upload to the .cm directory of your repo. Alternatively, you can copy and paste the individual automations, but make sure you include all required declarations and any related custom expressions from the configurations to ensure they work properly.
Most Popular Automations
- Approve safe changes - Approve documentation, formatting changes, and tests.
- Provide estimated time to review - Label all PRs with an estimated number of minutes it would take someone to review.
- Explain Code Experts - Post a comment that recommends reviewers based on their expertise.
- Review sensitive files - Define a custom list of files and directories that trigger additional reviews.
- Additional review for large PRs - Require additional reviewers for complex PRs.
Improve PR Efficiency
Auto-Approve Merges
- Approve tests - Label and approve PRs that only include tests.
- Approve Tiny Changes - Approve single-line changes to a single file.
- Approve team by directory - Approve PRs from specific teams to specified directories and files.
Add PR Context With Labels and Comments
- Label PRs without tests - Apply a
missing-testslabel to any PRs that lack updates to tests. - Label percent new code - Post a comment that indicates what percentage of the PR contains new code.
- Label deleted files - Label PRs that delete files.
- Label missing project tracker - Flag PRs that are missing a reference to an associated project tracking resource.
- Automatic project tracking links - Automatically post PR comments that link to the associated project tracking resource (Jira, Shortcut, Azure Boards, and more).
- Summarize PR contents by language - Post a comment that breaks down code changes by the programming languages contained in the PR.
Improve PR Quality
Merge Routing
- Assign code experts - Identify the best experts for a PR and assign them to review.
- Assign reviewers by directory - Automatically assign code reviewers based on directory structure.
- Assign reviewers for knowledge share - Automatically assign code reviewers based on contributions between specified thresholds.
- Change missing Lambda field - Request changes if a PR creates a new Lambda function that lacks a required field.
- Close wrong team by directory - Close PRs to a specified directory if the PR author is not on an approved team.
Quality Checks
- Enforce Semantic PR Titles - Enforce PR naming conventions.
- Enforce Changelog Updates - Require changelog updates for PRs that meet specific criteria.
- Request screenshot - Request a screenshot in the PR description if none exist.
- Welcome newcomer - Post a welcome message when someone makes their first PR to a repo, and provide context to help them know what's next.
- Remove TODO comments - Detect TODO comments in PRs and ask the author to remove or fix them.
Security and Policy Compliance
These examples help you follow your team's security best practices.
- Change deprecated components - Request changes when a PR includes one or more deprecated components.
- Enforce copyright headers - Enforce the use of copyright headers when publishing open source code.
Third-party Integrations
LinearBGitHub / GitLab
Security & Compliance
OrcaProject Management
Chat & Communications
Feature Flags
Languages
Documentation
Other
Utilities
These examples provide useful components to use in other automations. These aren't intended to be used on their own; instead they act as a reference point for improving other automations.
- Colors custom expression - A custom expression that implements all of GitHub's default label colors in a custom expression.
- CM File Header - A header to copy/paste to the top of your CM files to help yourself, and others, understand the purpose of the file.
Contribute Your Idea
Have a great idea for an automation that should be included in this library?
Submit your configuration on GitHub. We'll recognize your contribution publicly (if you want) and might even send you some special swag for your contribution.
Change Deprecated Components
Request changes when a PR includes one or more deprecated components.
Configuration Description
Conditions (all must be true):
- A PR contains one or more references to functions, methods, or classes that have been designated as deprecated.
Automation Actions:
- Add a
deprecated-componentlabel to the PR - Request changes to the PR and post a comment that explains what deprecated component was included and what the alternative is.
Change Deprecated Components
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ # Request changes when a PR includes deprecated components.
+ # This requires the `item` custom expression found at the bottom of this file.
+ {% for item in deprecated %}
+ # Automation names must be unique, so this adds an iterator index to each instance
+ review_deprecated_component_{{ item.old }}:
+ # Triggered when any of the modified files use a deprecated component
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=item.regex) | some }}
+ # Apply a deprecated-component label, request changes, and post a comment with an explanation.
+ run:
+ - action: add-label@v1
+ args:
+ label: 'deprecated-component'
+ color: '#FF0000'
+ - action: request-changes@v1
+ args:
+ comment: |
+ `{{ item.old }}` component is deprecated, use `{{ item.new }}` instead
+ {% endfor %}
+
+# These are the deprecated files that are evaluated in catch_deprecated_components
+deprecated:
+ - regex: r/oldAPI/
+ old: oldAPI
+ new: newAPI
+ - regex: r/anotherOldAPI/
+ old: anotherOldAPI
+ new: anotherNewAPI
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Require changelog updates for PRs to specific branches
- Restrict portions of your code base to authorized teams only.
- Require changes when PRs include !important tags in CSS files
More Automations can be found on the Automation Library and Integrations pages.
Change Missing Lambda Field
If a PR creates a new Lambda function, but lacks a description field, gitStream will request changes and post a comment that explains why.
Configuration Description
Conditions (all must be true):
- The PR contains an update to a Lambda function.
- The affected files are missing a description field.
Automation Actions:
- Add a
lambda-missing-fieldlabel to the PR. - Request changes and post a comment that explains why.
Change Missing Lambda Field
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ # Request changes when required Lambda information is missing from the PR.
+ catch_missing_lambda_info:
+ # Triggered for new Lambda functions that are missing a description field.
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/LambdaFunction/) | some }}
+ - {{ source.diff.files | matchDiffLines(regex=r/description:/) | nope }}
+ # Apply the lambda-missing-field label and request changes to the PR.
+ run:
+ - action: add-label@v1
+ args:
+ label: 'lambda-missing-field'
+ color: '#FF0000'
+ - action: request-changes@v1
+ args:
+ comment: |
+ New `LambdaFunction` must have `description:` field.
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Require changelog updates for PRs to specific branches
- Flag the use of deprecated APIs, functions, or other components.
- Restrict portions of your code base to authorized teams only.
- Require changes when PRs include !important tags in CSS files
More Automations can be found on the Automation Library and Integrations pages.
Close Wrong Team by Directory
Close PRs to a specified directory if the PR author is not on an approved team.
Configuration Description
Conditions (all must be true):
- The PR changes one or more files inside
/src/views. Customize this value for your project. - The PR author is not a member of the
uiteam. Customize this value for your organization.
Automation Actions:
- Close the PR.
- Post a comment that explains why the PR was closed.
Close Wrong Team by Directory
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ # Close PRs to restricted sections of the codebase if the PR author isn't on the correct team.
+ close_wrong_team_by_directory:
+ # Triggered when someone who isn't on the `ui` team submits a PR to change files inside /src/views
+ if:
+ - {{ files | match(regex=r/src\/views/) | some }}
+ - {{ pr.author_teams | match(term='ui') | nope }}
+ # Close the PR and post a comment explaining the next step.
+ run:
+ - action: add-comment@v1
+ args:
+ comment: Please contact a member of the `ui` team if you need to make changes to files in `src/views`
+ - action: close@v1
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Require changelog updates for PRs to specific branches
- Flag the use of deprecated APIs, functions, or other components.
- Require changes when PRs include !important tags in CSS files
More Automations can be found on the Automation Library and Integrations pages.
Label Missing Asana
Automatically label PRs that are missing references to Asana resources.
Configuration Description
Conditions (all must be true):
- The PR is missing an Asana ticket reference in the PR title and a link to an Asana resource in the PR description.
Automation Actions:
- Apply a red
⚠️ Missing Asana Linklabel - Post a comment that asks the author to add an Asana reference to the PR.
Label Missing Asana
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ label_missing_asana:
+ if:
+ - {{not (has.asana.ticket_in_title or has.asana.ticket_in_desc)}}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Asana Link"
+ color: {{ colors.red }}
+ - action: add-comment@v1
+ args:
+ comment: Please provide a link to the associated Asana resource.
+
+has:
+ asana:
+ ticket_in_title: {{ pr.title | includes(regex=r/asana-(\d+)/) }}
+ ticket_in_desc: {{ pr.description | includes(regex=r/app\.asana.\com\/(\d+)\/(\d+)\/(\d+)\/(\d+)\/(\d+)/) }}
+
+colors:
+ red: 'b60205'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Automatically Link PRs to Related Asana Cards
Provide automatic links to Asana cards that are associated with PRs.
Configuration Description
Conditions (all must be true):
- The PR contains a reference to an Asana card in the title or branch name.
Automation Actions:
- Post a comment that provides a link to the associated Asana Card.
Automatically Link to the Related Asana Card
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+provider: asana
+
+# Configure this to match your organization. It is used in tracker.asana.baseurl.
+asanaProject: 1234
+
+{% set ticketid = "" %}
+{% for ticket in tickets %}
+{% if (ticket | includes(regex=r/.+/)) %}
+{% set ticketid = ticket %}
+{% endif %}
+{% endfor %}
+
+automations:
+ link_asana:
+ if:
+ - {{ has.ticket_in_title or has.ticket_in_branch }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: Issue Tracker Link - [{{ticketid}}]({{tracker[provider].baseurl}}{{ticketid}})
+
+has:
+ ticket_in_title: {{ pr.title | includes(regex=tracker[provider].pattern) }}
+ ticket_in_branch: {{ branch.name | includes(regex=tracker[provider].pattern) }}
+
+tracker:
+ asana:
+ baseurl: https://app.asana.com/0/[asanaProject]/0/
+ pattern: r/asana-(\d+)/
+
+tickets:
+ - {{branch.name | capture(regex=tracker[provider].pattern)}}
+ - {{pr.title | capture(regex=tracker[provider].pattern)}}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Label Missing Azure Boards Info
Automatically label PRs that are missing references to Azure Boards resources.
Configuration Description
Conditions (all must be true):
- The PR is missing one of the following:
- An Azure Boards ticket reference in the PR title.
- A link to an Azure Boards resource in the PR description.
Automation Actions:
- Apply a red
⚠️ Missing Azure Boards Linklabel - Post a comment that asks the author to add an Azure Boards reference to the PR.
Label Missing Azure Boards
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ label_missing_azure:
+ if:
+ - {{not (has.azure.ticket_in_title or has.azure.ticket_in_desc)}}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Azure Boards Link"
+ color: {{ colors.red }}
+ - action: add-comment@v1
+ args:
+ comment: Please provide a link to the associated resource in Azure Boards.
+
+has:
+ azure:
+ ticket_in_title: {{ pr.title | includes(regex=r/(\w+)-(\w+)-(\d+)/) }}
+ ticket_in_desc: {{ pr.description | includes(regex=r/(dev\.azure\.com|(\w+)\.visualstudio\.com)\/(\w+)\/(\w+)\/_workitems\/edit\/(\d+)/) }}
+
+colors:
+ red: 'b60205'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Automatically Link PRs to Related Azure Boards Resources
Provide automatic links to Azure Boards resources that are associated with PRs.
Configuration Description
Conditions (all must be true):
- The PR contains a reference to an Azure Boards resource in the title or branch name.
Automation Actions:
- Post a comment that provides a link to the associated Azure Boards Resource.
Automatically Link to the Related Azure Boards Resource
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+# Configure these to match your organization.
+provider: azure
+# The name of your Azure organization
+orgName: org
+# The name of your Azure project
+azureProject: my_project
+
+{% set ticketid = "" %}
+{% for ticket in tickets %}
+{% if (ticket | includes(regex=r/.+/)) %}
+{% set ticketid = ticket %}
+{% endif %}
+{% endfor %}
+
+automations:
+ link_azure_boards:
+ if:
+ - {{ has.ticket_in_title or has.ticket_in_branch }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: Issue Tracker Link - [{{ticketid}}]({{tracker[provider].baseurl}}{{ticketid}})
+
+has:
+ ticket_in_title: {{ pr.title | includes(regex=tracker[provider].pattern) }}
+ ticket_in_branch: {{ branch.name | includes(regex=tracker[provider].pattern) }}
+
+tracker:
+ azure:
+ baseurl: https://dev.azure.com/[orgName]/[azureProject]/_workitems/
+ pattern: r/(\w+)-(\w+)-(\d+)/
+
+tickets:
+ - {{branch.name | capture(regex=tracker[provider].pattern)}}
+ - {{pr.title | capture(regex=tracker[provider].pattern)}}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Automatically Label GitHub Copilot PRs
Automatically apply labels to PRs that are assisted by GitHub Copilot. You can apply labels based on a known list of Copilot users, PR tags, or by prompting the PR author to indicate if they used Copilot.
Prompt PR authors to indicate if they used Copilot for the PR and automatically label the PR if they did. This requires two separate automation files to handle posting the prompt and labeling accordingly.
Configuration Description
Conditions:
- A PR is created
Automation Actions:
- Post a comment prompting the author to indicate if Copilot assisted the author with writing the code in the PR.
Ask the PR author about Copilot usage.
-*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+on:
+ - pr_created
+
+automations:
+ comment_copilot_prompt:
+ # Post a comment for all PRs to prompt the PR author to indicate whether they used Copilot to assist coding in this PR
+ if:
+ - true
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ Please mark whether you used Copilot to assist coding in this PR
+
+ - [ ] Copilot Assisted
+ - [ ] Not Copilot Assisted
+Configuration Description
Conditions:
- A PR is updated or merged where the author indicates they used Copilot via a prompt.
Automation Actions:
- Apply a
🤖 Copilotlabel to the PR
Label PRs where the user indicated Copilot usage
-*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ # You should use this automation in conjunction with comment_copilot_prompt.cm
+ label_copilot_pr:
+ # If the PR author has indicated that they used Copilot to assist coding in this PR,
+ # apply a label indicating the PR was supported by Copilot
+ if:
+ - {{ pr.comments | filter(attr='commenter', term='gitstream-cm') | filter (attr='content', regex=r/\- \[x\] Copilot Assisted/) | some}}
+ run:
+ - action: add-label@v1
+ args:
+ label: '🤖 Copilot'
+Automatically apply labels to PRs that are created by known users of generative AI coding tools.
Configuration Description
Conditions:
- The PR author is one of a specified list of contributors
Automation Actions:
- Apply a
🤖 Copilotlabel to the PR
Label by Contributors
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ label_genai:
+ # For all PRs authored by someone who is specified in the genai_contributors list
+ if:
+ - {{ pr.author | match(list=genai_contributors) | some }}
+ # Apply a label indicating the user has adopted Copilot
+ run:
+ - action: add-label@v1
+ args:
+ label: '🤖 Copilot'
+
+genai_contributors:
+ - username1
+ - username2
+ - etc
+Look for a specific tag in the PR title, description, comments or commit messages and if found add a label to the PR
Configuration Description
Conditions:
- The
#copilot#tag is found in any of the PR title, description, comments or commit messages for commits in the PR
Automation Actions:
- Apply a
🤖 Copilotlabel to the PR
Label Copilot by Tag
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+on:
+ - comment_added
+ - commit
+ - pr_created
+
+automations:
+ label_copilot:
+ # Detect PRs that contain the text '#copilot#' in the title, description, comments, or commit messages
+ if:
+ - {{ copilot_tag.pr_title or copilot_tag.pr_desc or copilot_tag.pr_comments or copilot_tag.commit_messages }}
+ # Apply a label indicating the user has adopted Copilot
+ run:
+ - action: add-label@v1
+ args:
+ label: '🤖 Copilot'
+
+copilot_tag:
+ pr_title: {{ pr.title | includes(regex=r/#copilot#/) }}
+ pr_desc: {{pr.description | includes(regex=r/#copilot#/) }}
+ pr_comments: {{ pr.comments | map(attr='content') | match(regex=r/#copilot#/) | some }}
+ commit_messages: {{ branch.commits.messages | match(regex=r/#copilot#/) | some }}
+Approve and Merge Dependabot Changes
Auto-merge Dependabot PRs
Required gitStream Plugins
This example requires you to install the extractDependabotVersionBump and compareSemver plugins.
Configuration Description
Conditions (all must be true):
- The PR author is Dependabot.
- The branch name includes 'dependabot'
- The dependency change is a patch or minor update.
Automation Actions:
- Approve the PR
- Apply an
approved-dependabotlabel to the PR - Merge the PR if all status checks pass.
Configuration Example
manifest:
+ version: 1.0
+
+automations:
+ merge_dependabot_minor:
+ if:
+ - {{ bump == 'minor' }}
+ - {{ branch.name | includes(term="dependabot") }}
+ - {{ branch.author | includes(term="dependabot") }}
+ run:
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ Dependabot `minor` version bumps are approved automatically.
+ merge_dependabot_minor_patch:
+ if:
+ - {{ bump == 'patch' }}
+ - {{ branch.name | includes(term="dependabot") }}
+ - {{ branch.author | includes(term="dependabot") }}
+ run:
+ - action: approve@v1
+ - action: merge@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ Dependabot `patch` version bumps are approved and merged automatically.
+
+bump: {{ pr.description | extractDependabotVersionBump | compareSemver }}
+Configuration Description
Conditions (all must be true):
- The PR author is Dependabot.
- The branch name includes 'dependabot'
Automation Actions:
- Approve the PR
- Apply an
approved-dependabotlabel to the PR - Merge the PR if all status checks pass.
Configuration Example
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_dependabot:
+ if:
+ - {{ branch.name | includes(term="dependabot") }}
+ - {{ branch.author | includes(term="dependabot") }}
+ run:
+ - action: approve@v1
+ - action: add-label@v1
+ args:
+ label: "approved-dependabot"
+ - action: merge@v1
+ args:
+ wait_for_all_checks: true
+ squash_on_merge: true
+Label DevCycle Feature Flags
Automatically label code that contians specified feature flags.
Configuration Description
Conditions (all must be true):
- The PR adds one or more feature flag keys.
Automation Actions:
- Label the PR for each feature flag key introduced in the PR.
Label PRs Based on Feature Flags
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+
+ {% for item in feature_flags %}
+ label_ff_devcycle_{{ item.name }}:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/key = '/) | some }}
+ - {{ source.diff.files | matchDiffLines(regex=item.regex) | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: {{ item.name }}
+ color: {{ colors.yellow }}
+ {% endfor %}
+
+feature_flags:
+ - name: engineering_rollback_plan_activated
+ regex: r/engineering_rollback_plan_activated/
+ - name: marketing_premium_plan_features_unlocked
+ regex: r/marketing_premium_plan_features_unlocked/
+ - name: mobile_push_notifications_enabled
+ regex: r/mobile_push_notifications_enabled/
+
+colors:
+ yellow: 'ffb300'
+Label Flagr Feature Flags
Automatically label code that contians specified feature flags.
Configuration Description
Conditions (all must be true):
- The PR adds one or more feature flag keys.
Automation Actions:
- Label the PR for each feature flag key introduced in the PR.
Label PRs Based on Feature Flags
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+
+ {% for item in feature_flags %}
+ label_ff_flagr_{{ item.name }}:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/evaluation_result.variant_id ==/) | some }}
+ - {{ source.diff.files | matchDiffLines(regex=item.regex) | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: {{ item.name }}
+ color: {{ colors.yellow }}
+ {% endfor %}
+
+feature_flags:
+ - name: engineering_rollback_plan_activated
+ regex: r/engineering_rollback_plan_activated/
+ - name: marketing_premium_plan_features_unlocked
+ regex: r/marketing_premium_plan_features_unlocked/
+ - name: mobile_push_notifications_enabled
+ regex: r/mobile_push_notifications_enabled/
+
+colors:
+ yellow: 'ffb300'
+Label Flagsmith Feature Flags
Automatically label code that contians specified feature flags.
Configuration Description
Conditions (all must be true):
- The PR adds one or more feature flag keys.
Automation Actions:
- Label the PR for each feature flag key introduced in the PR.
Label PRs Based on Feature Flags
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+
+ {% for item in feature_flags %}
+ label_ff_flagsmith_{{ item.name }}:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/flagsmith.hasFeature\(/) | some }}
+ - {{ source.diff.files | matchDiffLines(regex=item.regex) | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: {{ item.name }}
+ color: {{ colors.yellow }}
+ {% endfor %}
+
+feature_flags:
+ - name: engineering_rollback_plan_activated
+ regex: r/engineering_rollback_plan_activated/
+ - name: marketing_premium_plan_features_unlocked
+ regex: r/marketing_premium_plan_features_unlocked/
+ - name: mobile_push_notifications_enabled
+ regex: r/mobile_push_notifications_enabled/
+
+colors:
+ yellow: 'ffb300'
+Dispatch GitHub Actions
Automatically trigger GitHub Actions based on PR content like changed resources, source or target branch, slash commands, and more.
Configuration Description
Conditions (all must be true):
- The PR source or target branch matches a specified format.
Automation Actions:
- Trigger a manual dispatch for the specified CI pipeline.
Dispatch GitHub Actions by Branch
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+on:
+ - pr_created
+ - commit
+
+automations:
+ {% for item in pipelines %}
+ # Change pr.target to branch.name if you want to trigger on the source branch rather then the target branch.
+ dispatch_github_action_{{ item.name }}:
+ if:
+ - {{ pr.target | includes(term=item.branch_prefix) }}
+ run:
+ - action: run-github-workflow@v1
+ args:
+ workflow: .github/workflows/{{ item.workflow }}
+ check_name: {{ item.name }}
+ - action: add-label@v1
+ args:
+ label: {{ item.label }}
+ {% endfor %}
+
+
+pipelines:
+ - name: mobile_ci
+ label: Mobile CI
+ branch_prefix: 'mobile-'
+ workflow: mobile.yml
+ - name: backend_ci
+ label: Backend CI
+ branch_prefix: 'backend-'
+ workflow: 'backend.yml'
+Configuration Description
Conditions (all must be true):
- The PR has one or more specified labels applied to it.
Automation Actions:
- Trigger a manual dispatch for the specified CI pipeline.
Dispatch GitHub Actions Using Labels
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+on:
+ - label_added
+ - label_removed
+
+automations:
+ {% for item in pipelines %}
+ dispatch_github_action_{{ item.name }}:
+ if:
+ - {{ pr.labels | match(term=item.label) | some }}
+ run:
+ - action: run-github-workflow@v1
+ args:
+ workflow: .github/workflows/{{ item.workflow }}
+ check_name: {{ item.name }}
+ {% endfor %}
+
+pipelines:
+ - name: mobile-ci
+ label: Mobile CI
+ workflow: mobile.yml
+ - name: backend-ci
+ label: Backend CI
+ workflow: 'backend.yml'
+Configuration Description
Conditions (all must be true):
- The PR modifies one or more specified resources.
Automation Actions:
- Trigger a manual dispatch for the specified CI pipeline.
Dispatch GitHub Actions Based on Modified Resources
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+on:
+ - pr_created
+ - commit
+
+automations:
+ {% for item in pipelines %}
+ dispatch_github_action_{{ item.name }}:
+ if:
+ - {{ files | match(list=item.resources) | some }}
+ run:
+ - action: run-github-workflow@v1
+ args:
+ workflow: .github/workflows/{{ item.workflow }}
+ check_name: {{ item.name }}
+ - action: add-label@v1
+ args:
+ label: {{ item.label }}
+ {% endfor %}
+
+
+pipelines:
+ - name: mobile-ci
+ label: Mobile CI
+ resources:
+ - 'src/android/'
+ - 'src/ios/'
+ workflow: mobile.yml
+ - name: backend-ci
+ label: Backend CI
+ resources:
+ - 'src/api/'
+ - 'src/services'
+ workflow: 'backend.yml'
+ - name: frontend-ci
+ label: Frontend CI
+ resources:
+ - 'src/app/'
+ workflow: 'frontend.yml'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Automatically approve changes to docs, tests, and other safe assets.
- Approve low-risk PRs from trusted teams.
- Approve Python or JavaScript formatting changes.
- Approve Tiny Changes
- Approve JSDoc or Javadoc changes.
- Approve and Merge Dependabot PRs
More Automations can be found on the Automation Library and Integrations pages.
Skip Required GitHub Actions
Automatically skip GitHub Actions based on branch names, modified resource, slash commands, and more.
Prerequisite Config for Required Statuses
If you want to skip a required status check, you will need to make sure that your branch protection is configured to allow gitStream to bypass status check requirements.
Configuration Description
Conditions (all must be true):
- The target branch name includes a specified keyword. Optionally, you can modify this to detect the source branch name.
Automation Actions:
- Skip the specified CI pipelines.
Automatically Skip GitHub Actions by Branch
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+on:
+ - pr_created
+ - commit
+
+# Optionally, you can change pr.target to branch.name
+# if you want to trigger based on the source branch name rather then the target branch name.
+automations:
+ skip_github_action_branch:
+ if:
+ - {{ pr.target | includes(term='release') }}
+ run:
+ - action: add-github-check@v1
+ args:
+ check_name: staging-ci
+ conclusion: skipped
+ - action: add-comment@v1
+ args:
+ comment: |
+ [gitStream](https://docs.gitstream.cm) automatically skipped staging CI pipelines because this PR targets the release branch.
+Configuration Description
Conditions (all must be true):
- Someone applies one or more specified labels to a PR.
Automation Actions:
- Skip the specified CI pipelines.
Use Labels to Automatically Skip GitHub Actions
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+on:
+ - label_added
+ - label_removed
+
+automations:
+ skip_github_action_label:
+ if:
+ - {{ pr.labels | match(term='experimental') | some }}
+ run:
+ - action: add-github-check@v1
+ args:
+ check_name: production-ci
+ conclusion: skipped
+ - action: add-comment@v1
+ args:
+ comment: |
+ [gitStream](https://docs.gitstream.cm) automatically skipped production CI pipelines because this is labeled for experimental release.
+Configuration Description
Conditions (all must be true):
- A PR modifies specific files or directories.
Automation Actions:
- Skip a specified GitHub Action.
Automatically Skip GitHub Actions Based on Modified Resources
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+on:
+ - pr_created
+ - commit
+
+automations:
+ skip_github_action_resource:
+ if:
+ - {{ files | match(term='docs/') | every }}
+ run:
+ - action: add-github-check@v1
+ args:
+ check_name: release-ci
+ conclusion: skipped
+ - action: add-github-check@v1
+ args:
+ check_name: mobile-ci
+ conclusion: skipped
+ - action: add-comment@v1
+ args:
+ comment: |
+ [gitStream](https://docs.gitstream.cm) automatically skipped production CI pipelines because this PR only contains docs changes.
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Automatically approve changes to docs, tests, and other safe assets.
- Approve low-risk PRs from trusted teams.
- Approve Python or JavaScript formatting changes.
- Approve Tiny Changes
- Approve JSDoc or Javadoc changes.
- Approve and Merge Dependabot PRs
More Automations can be found on the Automation Library and Integrations pages.
Review Godoc for Large Changes
Require more extensive reviews for large Golang changes that lack Godoc updates.
Configuration Description
Conditions (all must be true):
- The PR changes more than 100 lines of Golang code.
Automation Actions:
- Post a comment asking the author to review all relevant Godoc to identify necessary updates.
- Require a review from the
ORG/tech-writersteam. - Apply a yellow
⚠️ Missing GodocLabel
Review Godoc
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ #Require more extensive reviews for large Golang changes that lack Godoc updates.
+ review_godoc_large:
+ if:
+ - {{ changes.additions > 100}}
+ - {{ source.diff.files | matchDiffLines(regex=r/^\/\/.*/) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Godoc"
+ color: {{ colors.yellow }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR makes major changes to Golang classes, but is missing updates to Godoc. Please double check for any necessary Godoc updates.
+ - action: add-reviewers@v1
+ args:
+ reviewers: [fourth-organization/tech-writers]
+
+changes:
+ # Sum all the lines added/edited in the PR
+ additions: {{ branch.diff.files_metadata | map(attr='additions') | sum }}
+
+colors:
+ yellow: 'fbca04'
+Require Godoc for New Golang Classes
Require Godoc for all new Golang classes.
Configuration Description
Conditions (all must be true):
- The PR creates a new Golang class.
- The PR lacks Godoc content.
Automation Actions:
- Request changes and post a comment explaining that Godoc is required
- Apply a yellow
⚠️ Missing Godoclabel.
Enforce Godoc for New Golang Classes
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ review_godoc_new_class:
+ if:
+ - {{ is.go and is.new }}
+ - {{ source.diff.files | match(attr='diff', regex=r/\/*[\s\S]*?\//) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing godoc"
+ color: {{ colors.yellow }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ godoc is required for all Golang classes. Please add godoc to all new classes in this PR.
+
+is:
+ go: {{ files | extensions | match(regex=r/go/) | every }}
+ new: {{ source.diff.files | map(attr='original_file') | match(regex=r/^$/) | some }}
+
+colors:
+ yellow: 'fbca04'
+Review Godoc Changes
Approve PRs that only contain changes to Godoc and assign optional reviewers.
Configuration Description
Conditions (all must be true):
- The PR only contains changes to Godoc content.
Automation Actions:
- Assign the org/tech-writers team for optional review.
- Apply a green
📓 Godoc Onlylabel - Approve the PR
Review Godoc
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ #Assign PRs that only affect godocs to the technical writing team and add docs label
+ review_godoc:
+ if:
+ - {{ source.diff.files | match(attr='diff', regex=r/^\/\/.*/) | every }}
+ - {{ files | extensions | match(regex=r/go/) | every }}
+
+ run:
+ - action: add-label@v1
+ args:
+ label: "📓godoc Only"
+ color: {{ colors.green }}
+ - action: add-reviewers@v1
+ args:
+ reviewers: [org/tech-writers]
+ - action: approve@v1
+
+colors:
+ green: '0e8a16'
+Review Java Input Parameters for Javadoc Changes
If a PR modifies the input parameters for a Java method, but not the associated Javadocs, notify reviewers to check for Javadoc updates.
Configuration Description
Conditions (all must be true):
- The PR changes one or more input parameters in Java methods.
- Note: This may not trigger for methods with annotations, methods that throw exceptions, multi-line method definitions, and other non-standard use cases.
- The PR lacks changes to ‘@param’ declarations.
Automation Actions:
- Post a comment warning the user to review the method’s Javadoc to identify necessary updates.
Review Javadoc
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ review_javadoc_input_parameters:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/\*\s@param/) | nope }}
+ - {{ source.diff.files | matchDiffLines(regex=r/\b(public|protected|private|static|final|synchronized)?\s+\w+\s+\w+\s*\(([^)]*)\)\s*\{/) | some }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR modifies method input parameters, but is missing Javadoc changes. Please check to ensure no Javadoc changes are necessary.
+Review Javadoc for Large Changes
Require more extensive reviews for large Java changes that lack Javadoc updates.
Configuration Description
Conditions (all must be true):
- The PR changes more than 25% of a Java class.
- The PR lacks Javadoc changes.
Automation Actions:
- Post a comment asking the author to review all relevant Javadoc to identify necessary updates.
- Require a review from the
my-organization/tech-writersteam. - Apply a yellow
⚠️ Missing JavadocLabel
Review Javadoc for Large Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ #Require more extensive reviews for large Java changes that lack Javadoc updates.
+ review_javadoc_large:
+ if:
+ - {{ changes.ratio > 25}}
+ - {{ source.diff.files | matchDiffLines(regex=r/\/*\*([\s\S]*?)\//) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Javadoc"
+ color: {{ colors.yellow }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR makes major changes to Java classes, but is missing updates to Javadoc. Please double check for any necessary Javadoc updates.
+ - action: add-reviewers@v1
+ args:
+ reviewers: [fourth-organization/tech-writers]
+
+changes:
+ # Sum all the lines added/edited in the PR
+ additions: {{ branch.diff.files_metadata | map(attr='additions') | sum }}
+ # Sum all the line removed in the PR
+ deletions: {{ branch.diff.files_metadata | map(attr='deletions') | sum }}
+ # Calculate the ratio of new code
+ ratio: {{ (changes.additions / (changes.additions + changes.deletions)) * 100 | round(2) }}
+
+colors:
+ yellow: 'fbca04'
+Review Javadoc Changes
Unblock PRs that only change Javadoc content.
Configuration Description
Conditions (all must be true):
- The PR only contains changes to Javadoc content.
Automation Actions:
- Assign the
org/tech-writersteam for optional review. - Apply a green
📓 Javadoc Onlylabel - Approve the PR
Review Javadoc Changes
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ # Assign PRs that only affect JavaDocs to the technical writing team and add docs label
+ review_javadoc:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/\/*\*([\s\S]*?)\//) | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/\b(public|protected|private|static|final|synchronized)?\s+\w+\s+\w+\s*\(([^)]*)\)\s*\{/) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "📓 Javadoc Only"
+ color: {{ colors.green }}
+ - action: add-reviewers@v1
+ args:
+ reviewers: [org/tech-writers]
+ - action: approve@v1
+
+colors:
+ green: '0e8a16'
+Enforce Javadoc Requirements for New Classes
Automatically request changes when someone creates a new Java class that lacks Javadoc content.
Configuration Description
Conditions (all must be true):
- The PR creates a new Java class.
- The PR lacks Javadoc content.
Automation Actions:
- Apply a
⚠️ Missing Javadoclabel. - Request changes, and post a comment explaining that Javadoc is required
Review Javadoc Requirements for New Classes
manifest:
+ version: 1.0
+
+automations:
+ review_new_class_javadoc:
+ # Triggered for new Java files that lack Javadoc content.
+ if:
+ - {{ is.java and is.new }}
+ - {{ source.diff.files | matchDiffLines(regex=r/\/*\*([\s\S]*?)\//) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Javadoc"
+ color: {{ colors.yellow }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ This PR creates new Java classes, but is missing updates to Javadoc. Please double check for any necessary Javadoc updates.
+
+is:
+ java: {{ files | extensions | match(term='java') | every }}
+ new: {{ source.diff.files | map(attr='original_file') | match(regex=r/^$/) | some }}
+
+colors:
+ yellow: 'fbca04'
+Configure Jira for gitStream Integrations
If you want to build gitStream automations to interact with the Jira API or Jira webhooks, you'll need to complete some setup in Jira, GitHub, and gitStream. This section outlines the setup process depending on the type of automation you want to build.
These guides are for sending HTTP requests to Jira
If the gitStream automations you want to use don't make any HTTP requests to a Jira API or webhook, you can ignore this section.
Use Webhooks to Trigger Jira Automations
Jira automations are the preferred method for gitStream to trigger actions within Jira, so you should use them whenever possible. If webhooks don't provide access to the data you need, or acheive the functionality you want, use the Jira API instead.
First, create a Jira automation that uses an incoming webhook as the trigger and add whatever automation components you want after this trigger. Save the webhook URL in a secure place, you'll need it later.
Here is an example of an automation that uses the webhookData property of the incoming data payload to create a new task. It expects the incoming data payload to contain title and pr_url fields to set the task summary and a pr_url custom field our demo environment already has configured.
Learn more about working with incoming webhooks in the Jira docs
Next, in GitHub, create an organization secret to store your Jira webhook URL and pass it to gitStream's env context variable by adding a line to .github/workflows/gitstream.yml inside your repo. Make sure to give this a unique name, such as JIRA_CREATE_ISSUE_WEBHOOK: ${{ secrets.JIRA_CREATE_ISSUE_WEBHOOK }}.
Once finished, you can use the env.JIRA_CREATE_ISSUE_WEBHOOK context variable inside CM files to send HTTP requests to Jira from your GitHub repo. For an example of how to do this, check out the create Jira issue automation.
Connect to the Jira API
The Jira API is useful in situations where you need to retreive data from Jira or need to access capabilities that aren't available via Jira Automations. The Jira API uses an account-based token system that follows a basic auth model; this means you'll need an individual account to connect to Jira's APIs and will pass the account email address and API token in the headers of your API requests.
Here's the process to grant gitStream access to the Jira API:
- Create an API token for your Jira account, and give it a unique name. Copy the API token, you'll need it in the next step.
- Create a GitHub organization secret to store the token and make the secret available to gitStream's
envcontext variable. - Add
env.MY_API_TOKENto any of your CM automations to access the API token and pass it to plugins and automation actions.
Check out the hasJiraIssue filter plugin for an example of how to use Jira API tokens.
Automatically Create Jira Issues from PRs
Automatically create Jira tickets for new pull/merge requests.
Jira API & Webhook Integration Required.
This automation requires you to connect to the Jira API and incoming webooks.
Required gitStream Plugins
This example requires you to install the hasJiraIssue plugin.
Configuration Description
Conditions (all must be true):
- The PR description contains the text
- [x] Auto-create Jira Issue - No existing Jira issues reference the PRs URL.
Automation Actions:
- Send an HTTP request to create a new Jira issue.
Automatically Create Jira Issues
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+
+###### ** Configure This Section ** ######
+
+# Configure this for your Jira instance and the email associated with your API key.
+# You can safely use these values because only your API key is sensitive.
+jiraSpaceName: "my-company" # e.g. my-company.atlassian.net
+email: "my.email@example.com"
+# If you're concerned about exposing this information,
+# we recommend using environment variables for your production environment.
+
+# -----------
+
+# Pass the API token associated with the email above to gitStream via an environment variable.
+jiraAuth: {{ env.JIRA_API_TOKEN }}
+# Learn more about env: https://docs.gitstream.cm/context-variables/#env
+
+# -----------
+
+# Change this to the Jira field you want to match the input string against.
+jiraField: "myField"
+# If you want to search a custom field, you should provide the ID like so:
+# jiraField: "cf[XXXXX]"
+# Replace XXXXX with the ID of the custom field you want to search.
+# More information:
+# Using JQL to search the Jira API: https://support.atlassian.com/jira-service-management-cloud/docs/jql-fields/
+# How to find the ID of a custom field: https://confluence.atlassian.com/jirakb/how-to-find-any-custom-field-s-ids-744522503.html
+
+# -----------
+
+###### ** Automation ** ######
+# You may want to update the text in the comment gitStream posts;
+# otherwise, this section shouldn't need to be changed.
+prUrl: "https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"
+has_jira_issue: {{ prUrl | hasJiraIssue(jiraAuth, jiraField, jiraSpaceName, email) }}
+
+automations:
+ automatic_jira_task:
+ if:
+ - {{ not has_jira_issue }}
+ - {{ pr.description | includes(regex=r/\- \[x\] Auto-create Jira Task/)}}
+ run:
+ - action: send-http-request@v1
+ args:
+ url: {{ env.JIRA_WEBHOOK }}
+ method: POST
+ headers: '{"Content-type": "application/json"}'
+ body: '{"data":{"pr_url": "{{ prUrl }}","title":"{{ pr.title }}"}}'
+ - action: add-comment@v1
+ args:
+ comment: "gitStream automatically created a Jira task for this PR"
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Automatically Create Jira Tickets
Automatically create Jira tickets for new PRs.
Required gitStream Plugins
This example requires you to install the hasJiraTicket plugin.
Configuration Description
Conditions (all must be true):
- A Jira ticket does not yet exist with the same title as the PR.
Automation Actions:
- Send an HTTP request to create a new Jira ticket.
Plugin:
- hasJiraTicket
Create Jira Ticket
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+has_jira_ticket: {{ pr.title | hasJiraTicket(env.JIRA_API_TOKEN) }}
+
+automations:
+ add_jira:
+ if:
+ - {{ not has_jira_ticket }}
+ run:
+ - action: send-http-request@v1
+ args:
+ url: env.JIRA_WEBHOOK_URL
+ method: POST
+ headers: '{"Content-type": "application/json"}'
+ body: '{"data":{"pr_url": "https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"}}'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Automatically Assign Jira Tickets
Automatically assign Jira tickets based on code review actions.
Jira Webhook Integration Required
You need to configure an incoming Jira webhook to use this automation.
Configuration Description
Conditions (all must be true):
- The PR description contains the slash command:
/gitstream assign-jirafollowed by a Jira username.
Automation Actions:
- Trigger a Jira webhook to update the assignee field with the username provided in the slash command.
Automatically Assign Jira Tickets
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+assigneeRegex: r/(?<=\/gitstream assign-jira ).*(?=<br \/>)/
+
+{% set ticketid = "" %}
+{% for ticket in tickets %}
+{% if (ticket | includes(regex=r/.+/)) %}
+{% set ticketid = ticket %}
+{% endif %}
+{% endfor %}
+
+automations:
+ jira_assign:
+ if:
+ - {{ pr.description | includes(regex=assigneeRegex) }}
+ run:
+ - action: send-http-request@v1
+ args:
+ url: "{{ env.JIRA_WEBHOOK }}}"
+ method: POST
+ headers: '{"Content-type": "application/json"}'
+ body: '{"issues":["{{ticketid}}"],"data":{"assignee":"{{pr.description | capture(regex=assigneeRegex)}}"}}'
+
+has:
+ jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
+ jira_ticket_in_branch: {{ branch.name | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
+
+tickets:
+ - {{branch.name | capture(regex=r/\b[A-Za-z]+-\d+\b/)}}
+ - {{pr.title | capture(regex=r/\b[A-Za-z]+-\d+\b/)}}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Automatic Jira Status Updates
Automatically update the status of Jira tickets when a PR is opened.
Jira Webhook Integration Required
You need to configure an incoming Jira webhook to use this automation.
Configuration Description
Conditions (all must be true):
- A PR is created that references a Jira ticket in the title or description.
Automation Actions:
- Make an HTTP request to a Jira webhook that is pre-configured to update the ticket status.
Automatic Jira Status Updates
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+on:
+ - pr_created
+
+{% set ticketid = "\b[A-Za-z]+-\d+\b" %}
+{% for ticket in tickets %}
+{% if (ticket | includes(regex=r/.+/)) %}
+{% set ticketid = ticket %}
+{% endif %}
+{% endfor %}
+
+automations:
+ jira_change_status:
+ if:
+ - {{ has.jira_ticket_in_title or has.jira_ticket_in_desc }}
+ run:
+ - action: send-http-request@v1
+ args:
+ url: "{{ env.JIRA_CHANGE_STATUS_WEBHOOK }}"
+ method: POST
+ headers: '{"Content-type": "application/json"}'
+ body: '{"issues":["{{ticketid}}"],"data":{"pr_url":"https://github.com/{{repo.owner}}/{{repo.name}}/pull/{{pr.number}}"}}'
+
+has:
+ jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
+ jira_ticket_in_branch: {{ branch.name | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
+
+tickets:
+ - {{branch.name | capture(regex=r/\b[A-Za-z]+-\d+\b/)}}
+ - {{pr.title | capture(regex=r/\b[A-Za-z]+-\d+\b/)}}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Automatic Jira Updates
Automatically update Jira tickets with pull request information. You can modify this to send any PR metadata to Jira.
Jira Webhook Integration Required
You need to configure an incoming Jira webhook to use this automation.
Configuration Description
Conditions (all must be true):
- A PR is created that contains a Jira ticket reference in the title or branch name.
Automation Actions:
- Send a webhook to Jira containing metadata to add to the Issue.
Automatic Jira Updates
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+on:
+ - pr_created
+
+{% set ticketid = "\b[A-Za-z]+-\d+\b" %}
+{% for ticket in tickets %}
+{% if (ticket | includes(regex=r/.+/)) %}
+{% set ticketid = ticket %}
+{% endif %}
+{% endfor %}
+
+automations:
+ jira_update_field:
+ if:
+ - {{ has.jira_ticket_in_title or has.jira_ticket_in_branch }}
+ run:
+ - action: send-http-request@v1
+ args:
+ url: "{{ env.JIRA_UPDATE_PR_FIELD_WEBHOOK }}"
+ method: POST
+ headers: '{"Content-type": "application/json"}'
+ body: '{"issues":["{{ticketid}}"],"data":{"pr_url":"https://github.com/{{repo.owner}}/{{repo.name}}/pull/{{pr.number}}"}}'
+
+has:
+ jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
+ jira_ticket_in_branch: {{ branch.name | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Label Missing Jira Info
Label PRs that don't reference a Jira ticket in the title or description. This uses regex to detect Jira ticket formats in the title (e.g. ABC-1234), and URLs to Jira tickets in the description.
Configuration Description
Conditions (all must be true):
- The PR lacks a Jira ticket number in the title, or a link to a Jira ticket in the PR description.
Automation Actions:
- Apply a
missing-jiralabel.
Label Missing Jira Info
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ label_missing_jira_info:
+ # Triggered for PRs that don't have either a Jira ticket number in the title,
+ # or a link to a Jira ticket in the PR description.
+ if:
+ - {{ not (has.jira_ticket_in_title or has.jira_ticket_in_desc) }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "missing-jira"
+ color: 'F6443B'
+
+has:
+ jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
+ jira_ticket_in_desc: {{ pr.description | includes(regex=r/atlassian.net\/browse\/\w{1,}-\d{3,4}/) }}
+Automatically Link PRs to Related Jira Issues
Provide automatic links to Jira issues that are associated with PRs.
Configuration Description
Conditions (all must be true):
- The PR contains a reference to an Jira card in the title or branch name.
Automation Actions:
- Post a comment that provides a link to the associated Jira Card.
Automatically Link to the Related Jira Card
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+provider: jira
+
+# Change this to the name of your Jira organization
+orgName: org
+
+{% set ticketid = "" %}
+{% for ticket in tickets %}
+{% if (ticket | includes(regex=r/.+/)) %}
+{% set ticketid = ticket %}
+{% endif %}
+{% endfor %}
+
+automations:
+ link_jira:
+ if:
+ - {{ has.ticket_in_title or has.ticket_in_branch }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: Issue Tracker Link - [{{ticketid}}]({{tracker[provider].baseurl}}{{ticketid}})
+
+has:
+ ticket_in_title: {{ pr.title | includes(regex=tracker[provider].pattern) }}
+ ticket_in_branch: {{ branch.name | includes(regex=tracker[provider].pattern) }}
+
+tracker:
+ jira:
+ baseurl: https://[orgName].atlassian.net/browse/
+ pattern: r/\b[A-Za-z]+-\d+\b/
+
+tickets:
+ - {{branch.name | capture(regex=tracker[provider].pattern)}}
+ - {{pr.title | capture(regex=tracker[provider].pattern)}}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Label Jit Alerts
Label the number of high, medium, and low risk vulnerabilities Jit reports for PRs.
Configuration Description
Conditions (all must be true):
- Jit reports one or more high, medium, or low risk security vulnerabilities for the PR.
Automation Actions:
- Apply labels to indicate the number of each type of vulnerability
Label Jit Alerts
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ {% for item in reports %}
+ label_jit_{{ item.name }}:
+ if:
+ - {{ item.count > 0}}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'Jit: {{ item.count }} {{ item.name }} vulnerabilities'
+ color: {{ colors.red if (item.name == 'high') else (colors.orange if (item.name == 'medium' ) else colors.yellow) }}
+ {% endfor %}
+
+jit: {{ pr | extractJitFindings }}
+
+reports:
+ - name: high
+ count: {{ jit.metrics.HIGH }}
+ - name: medium
+ count: {{ jit.metrics.MEDIUM }}
+ - name: low
+ count: {{ jit.metrics.LOW }}
+
+colors:
+ red: 'b60205'
+ orange: 'd93f0b'
+ yellow: 'fbca04'
+Review Jit Security Alerts
Manage review assignment for high and medium risk Jit security alerts.
Configuration Description
**Review Jit High Alerts**
+
+* Conditions (all must be true):
+ * Jit reports one or more high vulnerabilities for the PR
+* Automation Actions:
+ * Require a review from the organization’s security team.
+ * Require 2 reviewers.
+ * Post a comment explaining why this action was taken.
+
+**Review Jit Medium Alerts**
+
+* Conditions (all must be true):
+ * Jit reports one or more medium vulnerabilities for the PR
+* Automation Actions:
+ * Require 2 reviewers
+ * Post a comment explaining why this action was taken.
+Review Jit Security Alerts
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ review_jit_high_alerts:
+ if:
+ - {{ jit.metrics.HIGH > 0 }}
+ run:
+ - action: require-reviewers@v1
+ args:
+ reviewers: [my-organization/security-team]
+ - action: set-required-approvals@v1
+ args:
+ approvals: 2
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR requires additional review because Jit reported one or more high risk vulnerabilities.
+ review_jit_medium_alerts:
+ if:
+ - {{ jit.metrics.MEDIUM > 0 }}
+ run:
+ - action: set-required-approvals@v1
+ args:
+ approvals: 2
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR requires additional reviewers because Jit reported one or more medium risk vulnerabilities.
+
+
+jit: {{ pr | extractJitFindings }}
+Review Jit Ignore and Accept
Notify your Security team when someone ignores a Jit vulnerability report and accepts the risk.
Configuration Description
Conditions (all must be true):
- Someone ignores and accepts a Jit finding
Automation Actions:
- Request review from the organization’s security team.
- Label the PR to indicate someone accepted the risk of a Jit security alert.
- Post a comment explaining why this action was taken.
Review Jit Ignore and Accept
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ review_jit_ignore_accept:
+ if:
+ - {{ pr.conversations | reject(attr='commenter', term='jit-ci') | filter(attr='content', term='#jit_ignore_accept') | some }}
+ run:
+
+ - action: add-reviewers@v1
+ args:
+ reviewers: [my-organziation/security]
+ - action: add-label@v1
+ args:
+ label: '❕ Jit: Ignore - Accept Risk'
+ - action: add-comment@v1
+ args:
+ comment: |
+ The security team has been assigned for optional review because this PR ignores a Jit alert and accepts the associated risks.
+
+jit: {{ pr | extractJitFindings }}
+Review Jit Secret Detection
Close PRs where Jit detects a secret and post a comment explaining steps to remedy the situation.
Configuration Description
Conditions (all must be true):
- Jit detects a secret in the PR.
Automation Actions:
- Close the PR
- Post a comment explaining why this action was taken and to outline the necessary steps to remedy the situation.
Review Jit Security Control
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ review_jit_secret:
+ if:
+ - true
+ - {{ jit.vulnerabilities | match(attr='security_control', term='Secret Detection') | some }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ Jit detects secrets in this PR. Please complete the following steps:
+ 1. Undo the commit with git reset and remove all secrets from the files you modified.
+ 2. Deactivate the secret in any locations its used and replace it with a new key
+ 3. Commit your changes and resubmit your PR.
+ - action: close@v1
+
+
+jit: {{ pr | extractJitFindings }}
+Review JSDoc Input Parameters
Warn PR authors when they change JavaScript function or constructor input parameters without updating JSDoc content.
Configuration Description
Conditions (all must be true):
- The PR changes an input parameter in one or more JavaScript methods.
- The PR lacks changes to ‘@param’ declarations.
Automation Actions:
- Post a comment warning the user to review the method’s JSDoc to identify necessary updates.
Review JSDoc Input Parameters
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ review_jsdoc_input:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/.*\s@param/) | nope }}
+ - {{ source.diff.files | matchDiffLines(regex=r/\((?:.*\:.*\))/) | some }}
+
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR appears to modify method input parameters, but is missing JSDoc changes. Please check to ensure no JSDoc changes are necessary.
+Review JSDoc for Large Changes
Require more extensive reviews for large JavaScript changes that lack JSDoc updates.
Configuration Description
Conditions (all must be true):
- The PR changes more than 25% of a JavaScript class.
Automation Actions:
- Post a comment asking the author to review all relevant JSDoc to identify necessary updates.
- Require a review from the
ORG/tech-writersteam. - Apply a yellow
⚠️ Missing JSDocLabel
Review JSDoc
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ #Require more extensive reviews for large Javascript changes that lack JSDoc updates.
+ review_jsdoc_large:
+ if:
+ - {{ changes.ratio > 25}}
+ - {{ source.diff.files | matchDiffLines(regex=r/\/*\*([\s\S]*?)\//) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ No JSDoc"
+ color: {{ colors.yellow }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR makes major changes to JavaScript classes, but is missing updates to JSDoc. Please double check for any necessary JSDoc updates.
+
+ - action: add-reviewers@v1
+ args:
+ reviewers: [fourth-organization/tech-writers]
+
+changes:
+ # Sum all the lines added/edited in the PR
+ additions: {{ branch.diff.files_metadata | map(attr='additions') | sum }}
+ # Sum all the line removed in the PR
+ deletions: {{ branch.diff.files_metadata | map(attr='deletions') | sum }}
+ # Calculate the ratio of new code
+ ratio: {{ (changes.additions / (changes.additions + changes.deletions)) * 100 | round(2) }}
+
+colors:
+ yellow: 'fbca04'
+Enforce JSDoc for New JavaScript Classes
Require JSDoc for all new JavaScript classes.
Configuration Description
Conditions (all must be true):
- The PR creates a new JavaScript class.
- The PR lacks JSDoc content.
Automation Actions:
- Request changes and post a comment explaining that JSDoc is required
- Apply a yellow
⚠️ Missing JSDoclabel.
Enforce JSDoc for New JavaScript Classes
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ review_jsdoc_new_class:
+ if:
+ - {{ is.javascript and is.new }}
+ - {{ source.diff.files | matchDiffLines(regex=r/\/*\*([\s\S]*?)\//) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing JSDoc"
+ color: {{ colors.yellow }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ JSDoc is required for all JavaScript classes. Please add JSDoc to all new classes in this PR.
+
+is:
+ javascript: {{ files | extensions | match(list=['js', 'ts']) | every }}
+ new: {{ source.diff.files | map(attr='original_file') | match(regex=r/^$/) | some }}
+
+colors:
+ yellow: 'fbca04'
+Review JSDoc Changes
Approve PRs that only contain changes to JSDoc and assign optional reviewers.
Configuration Description
Conditions (all must be true):
- The PR only affects JavaScript and TypeScript files
- The PR only contains changes to JSDoc content.
Automation Actions:
- Assign the
ORG/tech-writersteam. - Apply a green
📓 JSDoc Only label - Approve the PR
Review JSDoc
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ #Assign PRs that only affect JSDocs to the technical writing team and add docs label
+ review_jsdoc:
+ if:
+ - {{ source.diff.files | match(attr='diff', regex=r/\/*\*[\s\S]*?\//) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "📓JSDoc Only"
+ color: {{ colors.green }}
+ - action: add-reviewers@v1
+ args:
+ reviewers: [fourth-organization/tech-writers]
+ - action: approve@v1
+
+colors:
+ green: '0e8a16'
+Label LaunchDarkly Feature Flags
Automatically label code that contians specified feature flags.
Configuration Description
Conditions (all must be true):
- The PR adds one or more feature flag keys.
Automation Actions:
- Label the PR for each feature flag key introduced in the PR.
Label PRs Based on Feature Flags
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+
+ {% for item in feature_flags %}
+ label_ff_launchdarkly_{{ item.name }}:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/var flagValue = ldclient/) | some }}
+ - {{ source.diff.files | matchDiffLines(regex=item.regex) | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: {{ item.name }}
+ color: {{ colors.yellow }}
+ {% endfor %}
+
+feature_flags:
+ - name: engineering_rollback_plan_activated
+ regex: r/engineering_rollback_plan_activated/
+ - name: marketing_premium_plan_features_unlocked
+ regex: r/marketing_premium_plan_features_unlocked/
+ - name: mobile_push_notifications_enabled
+ regex: r/mobile_push_notifications_enabled/
+
+colors:
+ yellow: 'ffb300'
+Auto-Label Orca Scan Results
Automatically apply labels to PRs that indicate the result of Orca Security scans.
Required gitStream Plugin
This example requires you to install the extractOrcaFindings plugin.
Configuration Description
Conditions (all must be true):
- Orca Security detects one or more issues with the code in the PR.
Automation Actions:
- Apply a label that indicates which issue was identified.
Auto-Label Orca Scan Results
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ {% for item in reports %}
+ label_orca_{{ item.name }}:
+ if:
+ - {{ item.count > 0 }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'orca:{{ item.name }}'
+ {% endfor %}
+
+orca: {{ pr | extractOrcaFindings }}
+
+reports:
+ - name: introduced-cves
+ count: {{ orca.vulnerabilities.count }}
+ - name: iac-misconfigurations
+ count: {{ orca.infrastructure_as_code.count }}
+ - name: exposed-secrets
+ count: {{ orca.secrets.count }}
+
+colors:
+ red: 'b60205'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Require Security Review for Orca Alerts
Automatically require review from your SecOps team for Orca Security violations in pull requests.
Configuration Description
Conditions (all must be true):
- The PR contains a vulnerability, IAC problem, or secret that is flagged as High or Medium.
Automation Actions:
- Require review from your organization's security team.
- Post a comment explaining the requirement.
Review Orca Security Alerts
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+automations:
+ review_orca_alerts:
+ if:
+ - {{ has.vulnerability or has.iac_violation or has.secret }}
+ run:
+ - action: require-reviewers@v1
+ args:
+ reviewers: [my-organization/security-team]
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR requires additional review because it fails to meet Orca Security safe code standards.
+
+orca: {{ pr | extractOrcaFindings }}
+
+has:
+ vulnerability: {{ orca.vulnerabilities.priority == 'High' or orca.vulnerabilities.priority == 'Medium' }}
+ iac_violation: {{ orca.infrastructure_as_code.priority == 'High' or orca.infrastructure_as_code.priority == 'Medium' }}
+ secret: {{ orca.secrets.priority == 'High' or orca.secrets.priority == 'Medium' }}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Review RDoc Input Parameters
Warn PR authors when they change Ruby function or constructor input parameters without updating RDoc content.
Configuration Description
Conditions (all must be true):
- The PR changes one or more input parameters in Ruby methods.
- The PR lacks RDoc updates.
Automation Actions:
- Post a comment warning the user to review the method’s RDoc to identify necessary updates.
Review RDoc Input Parameters
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ review_rdoc_input:
+ if:
+ - {{ source.diff.files | match(attr='diff', regex=r/(\#.*\n.*)*def/) | nope }}
+ - {{ source.diff.files | match(attr='diff', regex=r/def.*\(.*\)/ | some }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR modifies method input parameters, but is missing RDoc changes. Please check to ensure no RDoc changes are necessary.
+Review RDoc for Large Changes
Require more extensive reviews for large Ruby changes that lack RDoc updates.
Configuration Description
Conditions (all must be true):
- The PR changes more than 150 lines of Ruby code.
Automation Actions:
- Post a comment asking the author to review all relevant RDoc to identify necessary updates.
- Require a review from the
ORG/tech-writersteam. - Apply a yellow
⚠️ Missing RDocLabel
Review RDoc
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ #Require more extensive reviews for large Ruby changes that lack RDoc updates.
+ review_rdoc_large:
+ if:
+ - {{ changes.additions > 150}}
+ - {{ source.diff.files | matchDiffLines(regex=r/(\#.*\n.*)*def/) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing RDoc"
+ color: {{ colors.yellow }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR makes major changes to Ruby methods, but is missing updates to RDoc. Please double check for any necessary RDoc updates.
+ - action: add-reviewers@v1
+ args:
+ reviewers: [fourth-organization/tech-writers]
+
+changes:
+ # Sum all the lines added/edited in the PR
+ additions: {{ branch.diff.files_metadata | map(attr='additions') | sum }}
+
+
+colors:
+ yellow: 'fbca04'
+Enforce RDoc for New Ruby Classes
Require RDoc for all new Ruby classes.
Configuration Description
Conditions (all must be true):
- The PR creates a new Ruby class.
- The PR lacks RDoc content.
Automation Actions:
- Request changes and post a comment explaining that RDoc is required
- Apply a yellow
⚠️ Missing RDoclabel.
Enforce RDoc for New Ruby Classes
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ review_rdoc_new_class:
+ if:
+ - {{ is.rb and is.new }}
+ - {{ source.diff.files | match(attr='diff', regex=r/(\#.*\n.*)*def/) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing RDoc"
+ color: {{ colors.yellow }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ RDoc is required for all Ruby classes. Please add documentation for this PR.
+
+is:
+ rb: {{ files | extensions | match(regex=r/rb/) | every }}
+ new: {{ source.diff.files | map(attr='original_file') | match(regex=r/^$/) | some }}
+
+colors:
+ yellow: 'fbca04'
+Automatically Approve RDoc Changes
Approve PRs that only contain changes to RDoc and assign optional reviewers.
Configuration Description
Conditions (all must be true):
- The PR only contains changes to RDoc content.
Automation Actions:
- Assign the org/tech-writers team for optional review.
- Apply a green
📓 RDoc Onlylabel - Approve the PR
Review RDoc
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ review_rdoc:
+ if:
+ - {{ source.diff.files | match(attr='diff', regex=r/^[\s\t]*#.*/) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "📓RDoc Only"
+ color: {{ colors.green }}
+ - action: add-reviewers@v1
+ args:
+ reviewers: [org/tech-writers]
+ - action: approve@v1
+
+colors:
+ green: '0e8a16'
+Approve and Merge Renovate Changes
Auto-merge Renovate PRs
Required gitStream Plugins
This example requires you to install the extractRenovateVersionBump, compareMultiSemver and compareSemver plugins.
Configuration Description
Conditions (all must be true):
- The PR author is Renovate.
- The branch name includes 'renovate'
- The dependency change is a patch or minor update.
Automation Actions:
- Approve the PR
- Apply an
approved-renovatelabel to the PR - Merge the PR if all status checks pass.
Configuration Example
manifest:
+ version: 1.0
+
+automations:
+ merge_renovate_minor:
+ if:
+ - {{ bump == 'minor' }}
+ - {{ branch.name | includes(term="renovate") }}
+ - {{ branch.author | includes(term="renovate") }}
+ run:
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ Renovate `minor` version bumps are approved automatically.
+
+ merge_renovate_minor_patch:
+ if:
+ - {{ bump == 'patch' }}
+ - {{ branch.name | includes(term="renovate") }}
+ - {{ branch.author | includes(term="renovate") }}
+ run:
+ - action: approve@v1
+ - action: merge@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ Renovate `patch` version bumps are approved and merged automatically.
+
+bump: {{ pr.description | extractRenovateVersionBump | compareMultiSemver }}
+Configuration Description
Conditions (all must be true):
- The PR author is Renovate.
- The branch name includes 'renovate'
Automation Actions:
- Approve the PR
- Apply an
approved-renovatelabel to the PR - Merge the PR if all status checks pass.
Configuration Example
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_renovate:
+ if:
+ - {{ branch.author | includes(term="renovate") }}
+ run:
+ - action: approve@v1
+ - action: add-label@v1
+ args:
+ label: "approved-renovate"
+ - action: merge@v1
+ args:
+ wait_for_all_checks: true
+ squash_on_merge: true
+Label Missing Shortcut
Automatically label PRs that are missing references to Shortcut resources.
Configuration Description
Conditions (all must be true):
- The PR is missing one of the following:
- An Shortcut ticket reference in the PR title.
- A link to an Shortcut resource in the PR description.
Automation Actions:
- Apply a red
⚠️ Missing Shortcut Linklabel - Post a comment that asks the author to add an Shortcut reference to the PR.
Label Missing Shortcut
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ label_missing_shortcut:
+ if:
+ - {{not (has.shortcut.ticket_in_title or has.shortcut.ticket_in_desc)}}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Shortcut Link"
+ color: {{ colors.red }}
+ - action: add-comment@v1
+ args:
+ comment: Please provide a link to the associated Shortcut resource.
+
+has:
+ shortcut:
+ ticket_in_title: {{ pr.title | includes(regex=r/(\w+)\/sc-(\d+)/) }}
+ ticket_in_desc: {{ pr.description | includes(regex=r/(app\.shortcut\.com)\/(\w+)\/story\/(\d+)\/(\w+)/) }}
+
+colors:
+ red: 'b60205'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Automatically Link PRs to Related Shortcut Tasks
Provide automatic links to Shortcut tasks that are associated with PRs.
Configuration Description
Conditions (all must be true):
- The PR contains a reference to an Shortcut card in the title or branch name.
Automation Actions:
- Post a comment that provides a link to the associated Shortcut Task.
Automatically Link to the Related Shortcut Task
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+# Configure these to match your organization.
+provider: jira
+
+# Change this to match the name of your Shortcut organization. This is used in tracker.shortcut.baseurl
+orgName: org
+
+{% set ticketid = "" %}
+{% for ticket in tickets %}
+{% if (ticket | includes(regex=r/.+/)) %}
+{% set ticketid = ticket %}
+{% endif %}
+{% endfor %}
+
+automations:
+ link_shortcut:
+ if:
+ - {{ has.ticket_in_title or has.ticket_in_branch }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: Issue Tracker Link - [{{ticketid}}]({{tracker[provider].baseurl}}{{ticketid}})
+
+has:
+ ticket_in_title: {{ pr.title | includes(regex=tracker[provider].pattern) }}
+ ticket_in_branch: {{ branch.name | includes(regex=tracker[provider].pattern) }}
+
+tracker:
+ shortcut:
+ baseurl: https://app.shortcut.com/[orgName]/story/
+ pattern: r/(\w+)\/sc-(\d+)/
+
+tickets:
+ - {{branch.name | capture(regex=tracker[provider].pattern)}}
+ - {{pr.title | capture(regex=tracker[provider].pattern)}}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Automatic Slack Messages
Automatically post positive recognition messages in Slack for well-structured PRs.
Configuration Description
Conditions (all must be true):
- The PR contains updates to tests.
- The PR has fewer than 5 modified files.
- The PR branch references a Jira ticket.
- The PR has fewer than 150 lines of code changed.
Automation Actions:
- Post a Slack message that automatically recognizes the PR author and provides a link to the PR.
Automatic Slack Messages
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ slack_auto_recognition:
+ if:
+ - {{ files | match(regex=r/(test|spec)/) | some }} # this pr has at least 1 test
+ - {{ files | length <= 5 }} # this pr has 5 or less files
+ - {{ branch.name | includes(regex=r/[A-Z]{2,}-\d+.*/) }} # this branch has the Jira ticket prefix
+ - {{ branch.diff.size <= 150 }} # this branch has 150 lines of code or less changed
+ run:
+ - action: send-slack-message@v1
+ args:
+ webhook_url: "{{ env.SLACK_WEBHOOK }}"
+ message: ":tada: Congrats to {{ pr.author }} for the amazing new PR, '{{ pr.title }}'! Check it out at https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Send Slack Notifications
Automatically send Slack notifications to specific channels based on the contents of a pull request.
Configuration Description
Conditions (all must be true):
- The PR meets one or more of the specified trigger criteria for Slack notifications.
Automation Actions:
- Post a Slack message based on the contents of the PR.
Send Slack Notifications
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ send_slack_security:
+ # use your custom logic here to determine whether this needs a security review
+ if:
+ - true
+ run:
+ - action: send-slack-message@v1
+ args:
+ webhook_url: "{{ env.SLACK_WEBHOOK_SECURITY }}"
+ message: "A PR requires a security review. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"
+ send_slack_qa:
+ # use your custom logic here to determine whether this needs a qa review
+ if:
+ - {{ not (files | match(regex=r/(test|spec)/) | some) }}
+ run:
+ - action: send-slack-message@v1
+ args:
+ webhook_url: "{{ env.SLACK_WEBHOOK_QA }}"
+ message: "A PR was submitted without tests. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"
+ send_slack_docs:
+ # use your custom logic here to determine whether this needs a docs review
+ if:
+ - {{ files | match(regex=r/(docs)/) | some }}
+ run:
+ - action: send-slack-message@v1
+ args:
+ webhook_url: "{{ env.SLACK_WEBHOOK_DOCS }}"
+ message: "A PR has modified the docs. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Approve and Merge Snyk Changes
Approve PRs from Snyk
Configuration Description
Conditions (all must be true):
- The PR author is Snyk.
Automation Actions:
- Approve the PR
- Apply an
approved-snyklabel to the PR - Merge the PR if all status checks pass.
Approve Snyk
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_snyk:
+ if:
+ - {{ branch.author | includes(term="snyk") }}
+ run:
+ - action: approve@v1
+ - action: add-label@v1
+ args:
+ label: "approved-snyk"
+ - action: merge@v1
+ args:
+ wait_for_all_checks: true
+ squash_on_merge: true
+Approve Sonar Clean Code
Approve PRs that pass SonarCloud's quality gate.
Configuration Description
Conditions (all must be true):
- SonarCloud reports an 'A' rating for vulnerabilities, bugs, security hotspots, and code smells.
- There is no duplicated code.
Automation Actions:
- Apply a
Sonar: Clean Codelabel to the PR. - Approve the PR.
- Post a comment that explains why the PR was approved.
Aprove Sonar Clean Code
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+automations:
+ approve_sonar_clean_code:
+ if:
+ - {{ sonar.bugs.rating == 'A' }}
+ - {{ sonar.code_smells.rating == 'A' }}
+ - {{ sonar.vulnerabilities.rating == 'A' }}
+ - {{ sonar.security_hotspots.rating == 'A' }}
+ - {{ sonar.duplications == null or sonar.duplications == 0 }}
+ run:
+ - action: add-label@v1
+ args:
+ label: '✅ Sonar: Clean Code'
+ color: {{ colors.green }}
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR passes the SonarCloud quality gate check and as been automatically approved.
+
+sonar: {{ pr | extractSonarFindings }}
+
+colors:
+ green: '0e8a16'
+Label SonarCloud Quality Reports
Label the number of bugs, vulnerabilities, security hotspots, and code smells reported by SonarCloud.
Configuration Description
Conditions (all must be true):
- There is at least one vulnerability, code smell, security hotspot, or bug reported by SonarCloud. Uses the
extractSonarFindingsfilter function
Automation Actions:
- Apply color-coded labels to indicate the number of vulnerabilities, code smells, security hotspots, and bugs.
Label SonarCloud Quality Reports
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ {% for item in reports %}
+ label_sonar_{{ item.name }}:
+ if:
+ - {{ item.count > 0}}
+ run:
+ - action: add-label@v1
+ args:
+ label: '{{ item.icon }} sonar:{{ item.name }}-{{ item.rating }}'
+ color: {{ colors.red if (item.rating == 'E' or item.rating == 'D') else (colors.orange if (item.rating == 'C' ) else colors.yellow) }}
+ {% endfor %}
+
+sonar: {{ pr | extractSonarFindings }}
+
+reports:
+ - name: vulnerabilities
+ count: {{ sonar.vulnerabilities.count }}
+ icon: 🔓
+ rating: {{ sonar.vulnerabilities.rating }}
+ - name: code smells
+ count: {{ sonar.code_smells.count }}
+ icon: ☣️
+ rating: {{ sonar.code_smells.rating }}
+ - name: security hotspots
+ count: {{ sonar.security_hotspots.count }}
+ icon: 🛡️
+ rating: {{ sonar.security_hotspots.rating }}
+ - name: bugs
+ count: {{ sonar.bugs.count }}
+ icon: 🪲
+ rating: {{ sonar.bugs.rating }}
+
+colors:
+ red: 'b60205'
+ orange: 'd93f0b'
+ yellow: 'fbca04'
+Review Sonar Security Alerts
Require additional reviews for Sonar security alerts. gitStream will remove this requirement if the alerts are resolved.
Configuration Description
Conditions (all must be true):
- The SonarCloud quality gate check fails to pass for code smells, vulnerabilities, or security hotspots.
Automation Actions:
- Require a review from the
my-organization/security-teamteam. Customize this to match your organization. - Post a comment explaining why this PR requires additional review.
Review Sonar Alerts
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+automations:
+ review_sonar_alerts:
+ if:
+ - {{ sonar.code_smells.rating != 'A' or sonar.vulnerabilities.rating != 'A' or sonar.security_hotspots.rating != 'A'}}
+ run:
+ - action: require-reviewers@v1
+ args:
+ reviewers: [my-organization/security-team]
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR requires additional review because it fails to meet SonarCloud clean code standards.
+
+sonar: {{ pr | extractSonarFindings }}
+Review Sonar Duplications
Request changes when Sonar reports an excessive level of duplicated code.
Configuration Description
Conditions (all must be true):
- The PR contains more than 3% duplicated code.
Automation Actions:
- Apply a label that indicates how much duplicated code Sonar detected.
- Request changes and post a comment explaining why.
Review Sonar Duplications
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+automations:
+ review_sonar_duplications:
+ if:
+ - {{ sonar.duplications > 3 }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'Sonar: {{ sonar.duplications}}% duplication'
+ color: {{ colors.yellow }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Sonar reports an excessive level of code duplication. Please consider refactoring your PR to reduce duplications.
+
+sonar: {{ pr | extractSonarFindings }}
+
+colors:
+ yellow: 'fbca04'
+Approve Swimm Changes
Approve changes that only affect Swimm documentation.
Configuration Description
Conditions (all must be true):
- The PR only affects files that end in a
.swmextension.
Automation Actions:
- Add a
swimm-docs-onlylabel - Approve the PR
- Post a comment that explains that this is a Swimm docs change only.
Approve Swimm Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_swimm_changes:
+ # Triggered for any changes to Swimm documentation
+ if:
+ - {{ branch.diff.files_metadata | match(attr='file', regex=r/\.swm\//) | every }}
+ # Apply a swimm-docs-only label, approve the PR and explain why in a comment.
+ run:
+ - action: add-label@v1
+ args:
+ label: 'swimm-docs-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR is considered a safe change as it only affects Swimm Docs.
+ It has been automatically approved.
+Special thanks to Omerr for providing this example.
Automatic MS Teams Notifications
Automatically post positive recognition messages in MS Teams for well-structured PRs.
Configuration Description
Conditions (all must be true):
- The PR contains updates to tests.
- The PR has fewer than 5 modified files.
- The PR branch references a Jira ticket.
- The PR has fewer than 150 lines of code changed.
Automation Actions:
- Post an MS Teams message that automatically recognizes the PR author and provides a link to the PR.
Automatic MS Teams Notifications
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ teams_auto_recognition:
+ if:
+ - {{ files | match(regex=r/(test|spec)/) | some }} # this pr has at least 1 test
+ - {{ files | length <= 5 }} # this pr has 5 or less files
+ - {{ branch.name | includes(regex=r/[A-Z]{2,}-\d+.*/) }} # this branch has the Jira ticket prefix
+ - {{ branch.diff.size <= 150 }} # this branch has 150 lines of code or less changed
+ run:
+ - action: send-http-request@v1
+ args:
+ method: "POST"
+ headers: '{"Content-type": "application/json"}'
+ url: "{{ env.MS_TEAMS_WEBHOOK }}"
+ body: '{"text": "Congrats to {{ pr.author }} for the amazing new PR, {{ pr.title }}! Check it out at https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"}'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Automatically Notify MS Teams Channels
Automatically send Slack notifications to specific channels based on the contents of a pull request.
Configuration Description
Conditions (all must be true):
- The PR meets one or more of the specified trigger criteria for MS Teams notifications.
Automation Actions:
- Post an MS Teams message based on the contents of the PR.
Automatically Notify MS Teams Channels
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ send_teams_security:
+ if:
+ # use your custom logic here to determine whether this needs a security review
+ - true
+ run:
+ - action: send-http-request@v1
+ args:
+ method: "POST"
+ headers: '{"Content-type": "application/json"}'
+ url: "{{ env.MS_TEAMS_WEBHOOK_SECURITY }}"
+ body: '{"text": "A PR requires a security review. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"}'
+ send_teams_qa:
+ if:
+ # use your custom logic here to determine whether this needs a qa review
+ - {{ not (files | match(regex=r/(test|spec)/) | some) }}
+ run:
+ - action: send-http-request@v1
+ args:
+ method: "POST"
+ headers: '{"Content-type": "application/json"}'
+ url: "{{ env.MS_TEAMS_WEBHOOK_QA }}"
+ body: '{"text": "A PR was submitted without tests. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"}'
+ send_teams_docs:
+ if:
+ # use your custom logic here to determine whether this needs a docs review
+ - {{ files | match(regex=r/(docs)/) | some }}
+ run:
+ - action: send-http-request@v1
+ args:
+ method: "POST"
+ headers: '{"Content-type": "application/json"}'
+ url: "{{ env.MS_TEAMS_WEBHOOK_DOCS }}"
+ body: '{"text": "A PR has modified the docs. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"}'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Review New Terraform Modules
Request changes if a PR that creates a new Terraform module which do not conform to the required directory structure.
Configuration Description
Conditions (all must be true):
- The PR creates a new Terraform module
- A new sub-directory is created inside the
/modulesdirectory.
- A new sub-directory is created inside the
- The PR lacks one or more required components from the list in the terraform custom expression.
Automation Actions:
- Request changes and post a comment explaining the missing parts of the module.
- Apply Label :
⚠️ Missing Terraform Components
Review New Module
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+{% set misslist = [] %}
+{% for pattern in terraform %}
+{% if (newfilesinpr | match(term=pattern) | nope) %}
+{% set misslist = misslist + [pattern+' '] %}
+{% endif %}
+{% endfor %}
+
+automations:
+ review_new_terraform_module:
+ if:
+ - {{misslist | match(regex=r/.*/) | some}}
+ - {{is.mainfile and is.mainfilenotinroot }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ New terraform modules must contain all required components before merging. Please update your PR with the required components and gitStream will automatically remove this comment once completed.
+
+ Here are the required components, {{misslist}} should be customized appropriately:
+ my_module/
+ ├── main.tf
+ ├── outputs.tf
+ ├── providers.tf
+ - action: add-label@v1
+ args:
+ label: '⚠️ Missing Terraform Components'
+ color: '#FFA500'
+
+resources:
+ module_directory: 'modules'
+terraform:
+ - main.tf
+ - outputs.tf
+ - providers.tf
+is:
+ mainfile: {{newfilesinpr | match(term = "main.tf") | some}}
+ mainfilenotinroot: {{source.diff.files | map(attr='original_file') | match(term = "main.tf") | nope }}
+newfilesinpr:
+ {{ branch.diff.files_metadata | map(attr='new_file')}}
+Review Terraform Module Name
Request changes if a PR creates a new Terraform module that is missing a required prefix or keyword in the name.
Configuration Description
Conditions (all must be true):
- The PR creates a new Terraform module.
- The module name lacks a required name prefix, or one or more keywords.
Automation Actions:
- Request review changes on the PR with a comment explaining the structure of module name.
Review Terraform Module Name
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+# Prefix Check Logic
+{% set prefixcheck = [] %}
+{% for pattern in terraform.prefixes %}
+{% if(newfilesinpr | match(term=module_location + pattern) | some) %}
+{% set prefixcheck = prefixcheck + [true]%}
+{% else %}
+{% set prefixcheck = prefixcheck + [false] %}
+{% endif %}
+{% endfor %}
+
+automations:
+ review_new_terraform_module:
+ if:
+ - {{is.mainfile and is.mainfilenotinroot}}
+ - {{module_name_checks.prefix or module_name_checks.keyword}}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ Terraform module names must contain a required prefix and keyword:
+ * Prefixes: {{ terraform.prefixes }}
+ * Keywords: {{ terraform.keywords }}
+
+module_name_checks:
+ prefix: {{prefixcheck | match(term='true') | nope}}
+ keyword: {{newfilesinpr | match(list=terraform.keywords) | nope}}
+
+module_location: infrastructure/modules/
+terraform:
+ prefixes: ['aws', 'gcp', 'azure']
+ keywords: ['db', 'networking', 'security']
+
+is:
+ mainfile: {{newfilesinpr | match(term = "main.tf") | some}}
+ mainfilenotinroot: {{source.diff.files | map(attr='original_file') | match(term = "main.tf") | nope }}
+newfilesinpr:
+ {{ branch.diff.files_metadata | map(attr='new_file')}}
+Review Terraform Source Version
Ensure that all Terraform modules imported via a source URL specify a version.
Configuration Description
Conditions (all must be true):
- The PR contains a Terraform source declaration via URL that lacks a version reference.
- The source is not included in a whitelist custom expression that defines one or more whitelisted source locations.
Automation Actions:
- Request review changes on the PR with a comment explaining version number requirement.
Review Terraform Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ review_terraform_source_version:
+ # Check if New Content contains a source URL, the URL is not part of allow list and lacks version reference
+ if:
+ - {{ source.diff.files | match(attr='new_content', regex=r/source.*?=.*\".*(http|https).*\"/) | some }}
+ - {{ source.diff.files | match(attr='new_content', list=allowlist) | nope }}
+ - {{ source.diff.files | match(attr='new_content', regex=r/source.*?=.*\?ref=v.*/) | nope }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ You must reference a specific version when accessing Terraform module sources via URL, e.g. `?ref=v1.0.0`. Please update your Terraform files to follow this practice.
+
+allowlist:
+ - 'https://github.com/terraform-aws-modules/terraform-aws-s3-bucket.git'
+ - 'https://github.com/terraform-aws-modules/terraform-aws-vpc.git'
+ - 'https://github.com/terraform-aws-modules/terraform-aws-eks.git'
+Require Reviewers for Terraform changes
Automatically assign org/infrastructure team for reviewing changes when PR contains Terraform file changes.
Configuration Description
Conditions (all must be true):
- The PR contains changes to one or more Terraform configuration files.
Automation Actions:
- Require a review from the org/infrastructure team.
Review Terraform Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ review_terraform:
+ # Triggered for any changes to Terraform files
+ if:
+ - {{ files | match(regex=r/.*\.tf.*/) | some }}
+ # Assign infrastructure team as reviewer for change in Terraform files
+ run:
+ - action: require-reviewers@v1
+ args:
+ reviewers: [org/infrastructure]
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR affects Terraform configurations and requires a review from the Infra team.
+Label Unleash Feature Flags
Automatically label code that contians specified feature flags.
Configuration Description
Conditions (all must be true):
- The PR adds one or more feature flag keys.
Automation Actions:
- Label the PR for each feature flag key introduced in the PR.
Label PRs Based on Feature Flags
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+
+ {% for item in feature_flags %}
+ label_ff_unleash_{{ item.name }}:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/const notificationBadgeEnabled = useFlag/) | some }}
+ - {{ source.diff.files | matchDiffLines(regex=item.regex) | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: {{ item.name }}
+ color: {{ colors.yellow }}
+ {% endfor %}
+
+feature_flags:
+ - name: engineering_rollback_plan_activated
+ regex: r/engineering_rollback_plan_activated/
+ - name: marketing_premium_plan_features_unlocked
+ regex: r/marketing_premium_plan_features_unlocked/
+ - name: mobile_push_notifications_enabled
+ regex: r/mobile_push_notifications_enabled/
+
+colors:
+ yellow: 'ffb300'
+Create Project Management Tasks Via Zapier
Export new PR titles, description, and URL to Zapier.
Configuration Description
Conditions (all must be true):
- A PR is created.
Automation Actions:
- gitStream sends a webhook to Zapier that contains the PR title, description, and URL.
Create Project Management Tasks Via Zapier
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+pr_url: "https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"
+
+on:
+ - pr_created
+
+automations:
+ zapier_export_pr_description_title_url:
+ if:
+ - true
+ run:
+ - action: send-http-request@v1
+ args:
+ url: "{{ ZAPIER_WEBHOOK }}"
+ method: POST
+ headers: '{"Content-type": "application/json"}'
+ body: '{ "pr_description":"{{ pr.description }}", "pr_title":"{{ pr.title }}", "pr_url":"{{ pr_url }}" }'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Export PR Number, Title, and URL to Zapier
Export new PR titles, numbers, and URLs to Zapier.
Configuration Description
Conditions (all must be true):
- A PR is created.
Automation Actions:
- gitStream sends the PR number, title, and URL to Zapier via webhook.
Export PR Number, Title, and URL to Zapier
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+ pr_url: "https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"
+
+on:
+ - pr_created
+
+automations:
+ zapier_export_pr_number_title_url:
+ if:
+ - true
+ run:
+ - action: send-http-request@v1
+ args:
+ url: "{{ ZAPIER_WEBHOOK }}"
+ method: POST
+ headers: '{"Content-type": "application/json"}'
+ body: '{ "pr_number":"{{ pr.number }}", "pr_title":"{{ pr.title }}", "pr_url":"{{ pr_url }}" }'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Export PR Data to Zapier
This is an example of how to send data from gitStream to Zapier.
Configuration Description
Conditions (all must be true):
- A PR is created.
Automation Actions:
- gitStream sends a webhook to Zapier that contains the PR number
Export PR Number to Zapier
Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Auto-Schedule Sync Meetings via Zapier
Automatically update Zapier with a list of PR reviewers.
Configuration Description
Conditions (all must be true):
- A PR is created or updated.
Automation Actions:
- gitStream sends the list of reviewers to Zapier via webooks.
Auto-Schedule Sync Meetings via Zapier
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+pr_url: "https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"
+
+automations:
+ zapier_export_pr_reviewers:
+ if:
+ - true
+ run:
+ - action: send-http-request@v1
+ args:
+ url: "{{ env.ZAPIER_WEBHOOK }}"
+ method: "POST"
+ headers: '{"Content-type": "application/json"}'
+ body: '{ "reviewers": "{{ pr.reviewers }}" }'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Label Deleted Files
Label PRs that delete files.
Configuration Description
Conditions (all must be true):
- The PR deletes one or more files.
Automation Actions:
- Apply a
deleted-fileslabel to the PR.
Label Deleted Files
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ # Apply a label that indicates when a PR deletes files
+ # This uses the `has` custom expression found at the bottom of this file
+ label_deleted_files:
+ if:
+ - {{ has.deleted_files }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'deleted-files'
+ color: '#DF9C04'
+
+# This is used in the `label_deleted_files` automation
+has:
+ deleted_files: {{ source.diff.files | map(attr='new_file') | match(term='/dev/null') | some }}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Flag Missing Project Tracking Info
Label PRs that lack a reference to a project tracker issue (Jira, Azure Boards, Shortcut and Asana) in the PR title or description.
Configuration Description
Conditions (all must be true):
- The PR lacks a project tracker ticket number in the title, or a link to a project tracker resource in the PR description.
Automation Actions:
- Apply Label :
⚠️ Missing Project Tracker - Post a comment asking the author to reference the associated project tracker resource.
Label Missing Project Tracker
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ label_missing_project_tracker:
+ if:
+ - {{not (has[provider].ticket_in_title or has[provider].ticket_in_desc)}}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Project Tracker"
+ color: 'F6443B'
+ - action: add-comment@v1
+ args:
+ comment: Please provide a link to the associated resource in your team's project tracker.
+
+has:
+ jira:
+ ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
+ ticket_in_desc: {{ pr.description | includes(regex=r/atlassian.net\/browse\/\w{1,}-\d{3,4}/) }}
+ asana:
+ ticket_in_title: {{ pr.title | includes(regex=r/asana-(\d+)/) }}
+ ticket_in_desc: {{ pr.description | includes(regex=r/app\.asana.\com\/(\d+)\/(\d+)\/(\d+)\/(\d+)\/(\d+)/) }}
+ azure:
+ ticket_in_title: {{ pr.title | includes(regex=r/(\w+)-(\w+)-(\d+)/) }}
+ ticket_in_desc: {{ pr.description | includes(regex=r/(dev\.azure\.com|(\w+)\.visualstudio\.com)\/(\w+)\/(\w+)\/_workitems\/edit\/(\d+)/) }}
+ shortcut:
+ ticket_in_title: {{ pr.title | includes(regex=r/(\w+)\/sc-(\d+)/) }}
+ ticket_in_desc: {{ pr.description | includes(regex=r/(app\.shortcut\.com)\/(\w+)\/story\/(\d+)\/(\w+)/) }}
+
+provider: jira
+Label PRs Without Tests
Apply a missing-tests label to any PRs that don't update tests. gitStream will remove this label if the contributor adds a test change to the PR.
Configuration Description
Conditions (all must be true):
- The PR has no changes to a test.
Automation Actions:
- Apply a
missing-testslabel.
Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Approve Golang Log Output Changes
Approve changes to Golang files that only affect lines of code that invoke the logger object.
Configuration Description
Conditions (all must be true):
- All files end in
.go - The changes only affect lines of code that invoke the
logobject.
Automation Actions:
- Apply a
log-output-onlylabel - Approve the PR
- Post a comment explaining that the change only affects logging output.
Approve Golang Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_golang_log_output:
+ # Triggered for Golang changes that only affect the console.log() method
+ if:
+ - {{ files | extensions | match(term='go') | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^.*log\.Println/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Automation - Integrate gitStream with Golang
Approve Golang Log Output Changes
Approve changes to Golang files that only affect lines of code that invoke the logger object.
Configuration Description
Conditions (all must be true):
- All files end in
.go - The changes only affect lines of code that invoke the
logobject.
Automation Actions:
- Apply a
log-output-onlylabel - Approve the PR
- Post a comment explaining that the change only affects logging output.
Approve Golang Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_golang_log_output:
+ # Triggered for Golang changes that only affect the console.log() method
+ if:
+ - {{ files | extensions | match(term='go') | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^.*log\.Println/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Review Missing Golang Tests
Automatically request changes for Golang PRs that are missing tests.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Golang files
- The PR lacks new test files that match the name of the Golang files
Automation Actions:
- The PR lacks new test files that match the name of the Golang files
- Apply a red missing-tests label
Review Missing Golang Tests
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newFiles: {{ source.diff.files | filter(attr='new_file', regex=r/^(pkg|internal)\/(?!.*\_test\.go$).*\.go$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/.*\_test\.go$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+
+newFilesCount: {{ source.diff.files | filter(attr='new_file', regex=r/^(pkg|internal)\/(?!.*\_test\.go$).*\.go$/) | filter(attr='original_file', regex=r/^$/) | length }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/.*\_test\.go$/) | filter(attr='original_file', regex=r/^$/) | length }}
+
+automations:
+ review_missing_golang_tests:
+ if:
+ - {{ newFilesCount != newTestsCount }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Tests"
+ color: {{ colors.orange }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Some of your new Golang files are missing corresponding tests. Please ensure that all new files have a corresponding test file.
+
+ **New Files**: {{ newFilesCount }}
+ {{ newFiles }}
+
+ **New Tests**: {{ newTestsCount }}
+ {{ newTests }}
+colors:
+ orange: 'd93f0b'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Special thanks to Boemo W Mmopelwa for providing these examples.
Review Missing Golang Tests
Automatically request changes for Golang PRs that are missing tests.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Golang files
- The PR lacks new test files that match the name of the Golang files
Automation Actions:
- The PR lacks new test files that match the name of the Golang files
- Apply a red missing-tests label
Review Missing Golang Tests
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newFiles: {{ source.diff.files | filter(attr='new_file', regex=r/^(pkg|internal)\/(?!.*\_test\.go$).*\.go$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/.*\_test\.go$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+
+newFilesCount: {{ source.diff.files | filter(attr='new_file', regex=r/^(pkg|internal)\/(?!.*\_test\.go$).*\.go$/) | filter(attr='original_file', regex=r/^$/) | length }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/.*\_test\.go$/) | filter(attr='original_file', regex=r/^$/) | length }}
+
+automations:
+ review_missing_golang_tests:
+ if:
+ - {{ newFilesCount != newTestsCount }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Tests"
+ color: {{ colors.orange }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Some of your new Golang files are missing corresponding tests. Please ensure that all new files have a corresponding test file.
+
+ **New Files**: {{ newFilesCount }}
+ {{ newFiles }}
+
+ **New Tests**: {{ newTestsCount }}
+ {{ newTests }}
+colors:
+ orange: 'd93f0b'
+Enforce HTML Title Length Requirements
Automatically request changes for <title> tags that don't comply with best practices.
Configuration Description
Conditions (all must be true):
- The PR adds a
<title>tag that is less than 30 or greater than 90 characters.
Automation Actions:
- Request changes and post a comment asking the author to modify the title.
Enforce HTML Title Length Requirements
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ enforce_html_title_length:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/(<title>([\w\W]{1,29})<\/title>)|(<title>([\w\W]{61,})<\/title>)/) | some }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ Please ensure that all HTML titles are between 30 and 60 characters.
+Enforce Image Alt Attributes
Automatically request changes for PRs HTML files that are missing image alt attributes.
Configuration Description
Conditions (all must be true):
- The PR adds an image tag to an HTML file.
- The PR is missing alt attributes for one or more images.
Automation Actions:
- Add a
⚠️ Missing alt labellabel - Request changes and post a comment asking the author to add alt attributes to images.
Enforce Image Alt Attributes
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ enforce_image_alt:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/<img src/) | some }}
+ - {{ source.diff.files | matchDiffLines(regex=r/<img src.*alt=/) | nope}}
+
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing alt label"
+ color: {{ colors.yellow }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Please ensure that all images in HTML files have an alt attribute. For example: <img alt="Alt Message">
+
+colors:
+ yellow: 'fbca04'
+Flag Duplicate H1
Automatically request changes when PRs contain HTML files that have more than one H1 heading.
Configuration Description
Conditions (all must be true):
- The PR contains more than one H1 heading in an HTML file.
Automation Actions:
- Post a comment requesting the author to reduce H1 headings to one per file.
Flag Duplicate H1
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ flag_duplicate_h1:
+ if:
+ - {{ duplicateH1 > 0 }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ This PR contains HTML files with multiple H1 tags. Please ensure that each HTML file has only one H1 tag.
+
+duplicateH1: {{ source.diff.files | filter(attr='new_content', regex=r/<h1>(.|\n)*<h1>/) | length }}
+Flag Missing HTML Tags
Request changes for HTML files that lack the canonical and robots tag.
Configuration Description
Conditions (all must be true):
- The PR contains only new HTML files
- One or more files are missing a canonical tag
- One or more files are missing a robots meta tag
Automation Actions:
- Apply a
⚠️ Missing Required Taglabel. - Post a comment asking the user to add required tags.
Flag Missing HTML Tags
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ flag_missing_html_tags:
+ if:
+ - {{ is.html and is.new }}
+ - {{ source.diff.files | matchDiffLines(regex=r/rel="canonical"/) | nope }}
+ - {{ source.diff.files | matchDiffLines(regex=r/meta name="robots"/) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Required Tag"
+ color: {{ colors.yellow }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Please ensure new HTML files contain canonical and robots meta tags.
+
+is:
+ html: {{ files | extensions | match(term='html') | every }}
+ new: {{ source.diff.files | map(attr='original_file') | match(regex=r/^$/) | some }}
+
+colors:
+ yellow: 'fbca04'
+Automation - Integrate gitStream with HTML and CSS
Request Changes for CSS Important Tags
Flag the use of !important in CSS files and automatically request changes.
Configuration Description
Conditions (all must be true):
- The PR contains changes to CSS files.
- The changes include
!important
Automation Actions:
- Apply an orange label that says
⚠️ Includes !important tag - Request changes an post a comment asking the PR author to remove the important tage.
Review Important Tags in CSS Files
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ review_css_important:
+ if:
+ - {{ files | extensions | match(term='css') | some }}
+ - {{ source.diff.files | matchDiffLines(regex=r/!important/) | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: '⚠️ Includes !important tag'
+ color: '{{ colors.orange }}'
+ - action: request-changes@v1
+ args:
+ comment: |
+ Please remove the `!important` tag from your CSS.
+
+
+colors:
+ orange: 'd93f0b'
+Flag Missing HTML Tags
Request changes for HTML files that lack the canonical and robots tag.
Configuration Description
Conditions (all must be true):
- The PR contains only new HTML files
- One or more files are missing a canonical tag
- One or more files are missing a robots meta tag
Automation Actions:
- Apply a
⚠️ Missing Required Taglabel. - Post a comment asking the user to add required tags.
Flag Missing HTML Tags
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ flag_missing_html_tags:
+ if:
+ - {{ is.html and is.new }}
+ - {{ source.diff.files | matchDiffLines(regex=r/rel="canonical"/) | nope }}
+ - {{ source.diff.files | matchDiffLines(regex=r/meta name="robots"/) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Required Tag"
+ color: {{ colors.yellow }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Please ensure new HTML files contain canonical and robots meta tags.
+
+is:
+ html: {{ files | extensions | match(term='html') | every }}
+ new: {{ source.diff.files | map(attr='original_file') | match(regex=r/^$/) | some }}
+
+colors:
+ yellow: 'fbca04'
+Flag Duplicate H1
Automatically request changes when PRs contain HTML files that have more than one H1 heading.
Configuration Description
Conditions (all must be true):
- The PR contains more than one H1 heading in an HTML file.
Automation Actions:
- Post a comment requesting the author to reduce H1 headings to one per file.
Flag Duplicate H1
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ flag_duplicate_h1:
+ if:
+ - {{ duplicateH1 > 0 }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ This PR contains HTML files with multiple H1 tags. Please ensure that each HTML file has only one H1 tag.
+
+duplicateH1: {{ source.diff.files | filter(attr='new_content', regex=r/<h1>(.|\n)*<h1>/) | length }}
+Enforce HTML Title Length Requirements
Automatically request changes for <title> tags that don't comply with best practices.
Configuration Description
Conditions (all must be true):
- The PR adds a
<title>tag that is less than 30 or greater than 90 characters.
Automation Actions:
- Request changes and post a comment asking the author to modify the title.
Enforce HTML Title Length Requirements
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ enforce_html_title_length:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/(<title>([\w\W]{1,29})<\/title>)|(<title>([\w\W]{61,})<\/title>)/) | some }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ Please ensure that all HTML titles are between 30 and 60 characters.
+Enforce Image Alt Attributes
Automatically request changes for PRs HTML files that are missing image alt attributes.
Configuration Description
Conditions (all must be true):
- The PR adds an image tag to an HTML file.
- The PR is missing alt attributes for one or more images.
Automation Actions:
- Add a
⚠️ Missing alt labellabel - Request changes and post a comment asking the author to add alt attributes to images.
Enforce Image Alt Attributes
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ enforce_image_alt:
+ if:
+ - {{ source.diff.files | matchDiffLines(regex=r/<img src/) | some }}
+ - {{ source.diff.files | matchDiffLines(regex=r/<img src.*alt=/) | nope}}
+
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing alt label"
+ color: {{ colors.yellow }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Please ensure that all images in HTML files have an alt attribute. For example: <img alt="Alt Message">
+
+colors:
+ yellow: 'fbca04'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Special thanks to Boemo W Mmopelwa for providing these examples.
Review Important Tags in CSS Files
Flag the use of !important in CSS files and automatically request changes.
Configuration Description
Conditions (all must be true):
- The PR contains changes to CSS files.
- The changes include
!important
Automation Actions:
- Apply an orange label that says
⚠️ Includes !important tag - Request changes an post a comment asking the PR author to remove the important tage.
Review Important Tags in CSS Files
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ review_css_important:
+ if:
+ - {{ files | extensions | match(term='css') | some }}
+ - {{ source.diff.files | matchDiffLines(regex=r/!important/) | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: '⚠️ Includes !important tag'
+ color: '{{ colors.orange }}'
+ - action: request-changes@v1
+ args:
+ comment: |
+ Please remove the `!important` tag from your CSS.
+
+
+colors:
+ orange: 'd93f0b'
+Approve Java Log Output Changes
Approve changes to Java files that only affect lines of code that invoke the logger object.
Configuration Description
Conditions (all must be true):
- All files end in .java
- The changes only affect lines of code that invoke logger object.
Automation Actions:
- Apply a
log-output-onlylabel - Approve the PR
- Post a comment explaining that the change only affects logging output.
Approve Java Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_java_log_output:
+ # Triggered for Java changes that only affect the logger method
+ if:
+ - {{ files | extensions | match(term='java') | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^.*logger\.(trace|fatal|debug|info|warn|error)/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Automation - Integrate gitStream with Java
Approve Java Log Output Changes
Approve changes to Java files that only affect lines of code that invoke the logger object.
Configuration Description
Conditions (all must be true):
- All files end in .java
- The changes only affect lines of code that invoke logger object.
Automation Actions:
- Apply a
log-output-onlylabel - Approve the PR
- Post a comment explaining that the change only affects logging output.
Approve Java Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_java_log_output:
+ # Triggered for Java changes that only affect the logger method
+ if:
+ - {{ files | extensions | match(term='java') | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^.*logger\.(trace|fatal|debug|info|warn|error)/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Review Missing Java Tests
Automatically request changes for Java PRs that lack test files.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Java files
- The PR lacks new test files that match the name of the Java files
Automation Actions:
- Apply a red missing-tests label
- Request changes and post a comment listing the files that need tests.
Review Missing Java Tests
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newFiles: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!.*Test\.java$).*\.java$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/src\/.*Test\.java$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+
+newFilesCount: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!.*Test\.java$).*\.java$/) | filter(attr='original_file', regex=r/^$/) | length }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/src\/.*Test\.java$/) | filter(attr='original_file', regex=r/^$/) | length }}
+
+automations:
+ review_missing_java_tests:
+ if:
+ - {{ newFilesCount != newTestsCount }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Tests"
+ color: {{ colors.orange }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Some of your new Java files are missing corresponding tests. Please ensure that all new files have a corresponding test file.
+
+ **New Files**: {{ newFilesCount }}
+ {{ newFiles }}
+
+ **New Tests**: {{ newTestsCount }}
+ {{ newTests }}
+colors:
+ orange: 'd93f0b'
+Review Java Test Names
Automatically request changes for Java test files that fail to match the required naming convention.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Java test files
- The Java test fails to match the required naming convention.
Automation Actions:
- Request changes and post a comment that explains the Java test name requirements.
Review Java Test Name
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/test\/) }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/test\/) | length }}
+
+automations:
+ review_java_test_name:
+ if:
+ - {{ newTestsCount > 0}}
+ - {{ source.diff.files | filter(attr='new_file', regex=r/^src\/test\/) | match(attr='new_file', regex=r/Test.java$/) | nope }}
+
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ The test file name does not follow the Java test name conventions. A test file name needs to have the word Test at the end of class name. For example, if you are testing a class called Data then the test file name has to be DataTest.java.
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Special thanks to Boemo W Mmopelwa for providing these examples.
Review Java Test Name
Automatically request changes for Java test files that fail to match the required naming convention.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Java test files
- The Java test fails to match the required naming convention.
Automation Actions:
- Request changes and post a comment that explains the Java test name requirements.
Review Java Test Name
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/test\/) }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/test\/) | length }}
+
+automations:
+ review_java_test_name:
+ if:
+ - {{ newTestsCount > 0}}
+ - {{ source.diff.files | filter(attr='new_file', regex=r/^src\/test\/) | match(attr='new_file', regex=r/Test.java$/) | nope }}
+
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ The test file name does not follow the Java test name conventions. A test file name needs to have the word Test at the end of class name. For example, if you are testing a class called Data then the test file name has to be DataTest.java.
+Review Missing Java Tests
Automatically request changes for Java PRs that lack test files.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Java files
- The PR lacks new test files that match the name of the Java files
Automation Actions:
- Apply a red missing-tests label
- Request changes and post a comment listing the files that need tests.
Review Missing Java Tests
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newFiles: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!.*Test\.java$).*\.java$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/src\/.*Test\.java$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+
+newFilesCount: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!.*Test\.java$).*\.java$/) | filter(attr='original_file', regex=r/^$/) | length }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/src\/.*Test\.java$/) | filter(attr='original_file', regex=r/^$/) | length }}
+
+automations:
+ review_missing_java_tests:
+ if:
+ - {{ newFilesCount != newTestsCount }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Tests"
+ color: {{ colors.orange }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Some of your new Java files are missing corresponding tests. Please ensure that all new files have a corresponding test file.
+
+ **New Files**: {{ newFilesCount }}
+ {{ newFiles }}
+
+ **New Tests**: {{ newTestsCount }}
+ {{ newTests }}
+colors:
+ orange: 'd93f0b'
+Approve JavaScript Formatting Changes
Approve PRs that only contain formatting changes to JavaScript or TypeScript files.
Configuration Description
Conditions (all must be true):
- All of the files end in
.jsor.ts - All changes are non-functional
Automation Actions:
- Approve the PR
- Apply a
code-formattinglabel. - Post a comment that explains the automation.
Approve JavaScript Formatting Change
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_javascript_formatting:
+ if:
+ - {{ files | extensions | match(list=['js', 'ts']) | every }}
+ - {{ source.diff.files | isFormattingChange }}
+ run:
+ - action: approve@v1
+ - action: add-label@v1
+ args:
+ label: code-formatting
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR only contains formatting changes and has been approved.
+Approve JavaScript Log Output Changes
Approve changes to JavaScript files that only affect lines of code that invoke the console.log() method.
Configuration Description
Conditions (all must be true):
- All files must end in .js or .ts
- The changes only affect lines of code that invoke console.log()
Automation Actions:
- Applies a
log-output-onlylabel - Approves the PR
- Posts a comment explaining that the change only affects logging output.
Approve JavaScript Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_javascript_log_output:
+ # Triggered for JavaScript changes that only affect the console.log() method
+ if:
+ - {{ files | match(regex=r/\.js$|\.ts$/) | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^[+-].*console\.log/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Automation - Integrate gitStream with JavaScript
Auto-Approve JavaScript Log Output Changes
Approve changes to JavaScript files that only affect lines of code that invoke the console.log() method.
Configuration Description
Conditions (all must be true):
- All files must end in .js or .ts
- The changes only affect lines of code that invoke console.log()
Automation Actions:
- Applies a
log-output-onlylabel - Approves the PR
- Posts a comment explaining that the change only affects logging output.
Approve JavaScript Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_javascript_log_output:
+ # Triggered for JavaScript changes that only affect the console.log() method
+ if:
+ - {{ files | match(regex=r/\.js$|\.ts$/) | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^[+-].*console\.log/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Auto-Approve JavaScript Formatting Change
Approve PRs that only contain formatting changes to JavaScript or TypeScript files.
Configuration Description
Conditions (all must be true):
- All of the files end in
.jsor.ts - All changes are non-functional
Automation Actions:
- Approve the PR
- Apply a
code-formattinglabel. - Post a comment that explains the automation.
Approve JavaScript Formatting Change
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_javascript_formatting:
+ if:
+ - {{ files | extensions | match(list=['js', 'ts']) | every }}
+ - {{ source.diff.files | isFormattingChange }}
+ run:
+ - action: approve@v1
+ - action: add-label@v1
+ args:
+ label: code-formatting
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR only contains formatting changes and has been approved.
+Review Missing JavaScript Tests
Request changes for JavaScript PRs that lack test files.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new JavaScript files
- The PR lacks new test files that match the name of the JavaScript files
Automation Actions:
- Apply a red
missing-testslabel - Request changes and post a comment listing the files that need tests.
Review Missing JavaScript Tests
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newFiles: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!.*\.test\.js$).*\.js$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/src\/.*\.test\.js$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+
+newFilesCount: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!.*\.test\.js$).*\.js$/) | filter(attr='original_file', regex=r/^$/) | length }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/src\/.*\.test\.js$/) | filter(attr='original_file', regex=r/^$/) | length }}
+
+automations:
+ review_missing_javascript_tests:
+ if:
+ - {{ newFilesCount != newTestsCount }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Tests"
+ color: {{ colors.orange }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Some of your new JavaScript files are missing corresponding tests. Please ensure that all new files have a corresponding test file.
+
+ **New Files**: {{ newFilesCount }}
+ {{ newFiles }}
+
+ **New Tests**: {{ newTestsCount }}
+ {{ newTests }}
+colors:
+ orange: 'd93f0b'
+Review JavaScript Test Name
Automatically request changes for JavaScript test files that fail to match the required naming convention.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new JavaScript test files
- The JavaScript test fails to match the required naming convention.
Automation Actions:
- Request changes and post a comment that explains the JavaScript test name requirements.
Review JavaScript Test Name
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/^test/) }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/^test/) | length }}
+
+automations:
+ review_javascript_test_name:
+ if:
+
+ - {{ newTestsCount > 0}}
+ - {{ source.diff.files | filter(attr='new_file', regex=r/^test/) | match(attr='new_file', regex=r/.test.js$/) | nope }}
+
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ The test file name does not follow the JavaScript test name conventions. A test file name needs to have the suffix .test after class name. For example, if you are testing a class file called Data.js then the test file name has to be data.test.js.
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Review JavaScript Test Name
Automatically request changes for JavaScript test files that fail to match the required naming convention.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new JavaScript test files
- The JavaScript test fails to match the required naming convention.
Automation Actions:
- Request changes and post a comment that explains the JavaScript test name requirements.
Review JavaScript Test Name
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/^test/) }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/^test/) | length }}
+
+automations:
+ review_javascript_test_name:
+ if:
+
+ - {{ newTestsCount > 0}}
+ - {{ source.diff.files | filter(attr='new_file', regex=r/^test/) | match(attr='new_file', regex=r/.test.js$/) | nope }}
+
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ The test file name does not follow the JavaScript test name conventions. A test file name needs to have the suffix .test after class name. For example, if you are testing a class file called Data.js then the test file name has to be data.test.js.
+Review Missing JavaScript Tests
Request changes for JavaScript PRs that lack test files.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new JavaScript files
- The PR lacks new test files that match the name of the JavaScript files
Automation Actions:
- Apply a red
missing-testslabel - Request changes and post a comment listing the files that need tests.
Review Missing JavaScript Tests
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newFiles: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!.*\.test\.js$).*\.js$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/src\/.*\.test\.js$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+
+newFilesCount: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!.*\.test\.js$).*\.js$/) | filter(attr='original_file', regex=r/^$/) | length }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/src\/.*\.test\.js$/) | filter(attr='original_file', regex=r/^$/) | length }}
+
+automations:
+ review_missing_javascript_tests:
+ if:
+ - {{ newFilesCount != newTestsCount }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Tests"
+ color: {{ colors.orange }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Some of your new JavaScript files are missing corresponding tests. Please ensure that all new files have a corresponding test file.
+
+ **New Files**: {{ newFilesCount }}
+ {{ newFiles }}
+
+ **New Tests**: {{ newTestsCount }}
+ {{ newTests }}
+colors:
+ orange: 'd93f0b'
+Approve Python Formatting Changes
Approve PRs that only contain formatting changes to Python files.
Configuration Description
Conditions (all must be true):
- All of the files end in
.py. - All changes are non-functional
Automation Actions:
- Approve the PR
- Apply a
code-formattinglabel. - Post a comment that explains the automation.
Approve Python Formatting Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_python_formatting:
+ if:
+ - {{ files | extensions | match(list=['py']) | every }}
+ - {{ source.diff.files | isFormattingChange }}
+ run:
+ - action: approve@v1
+ - action: add-label@v1
+ args:
+ label: code-formatting
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR only contains formatting changes and has been approved.
+Approve Python Log Output Changes
Approve changes to Python files that only affect lines of code that invoke a specified logging object.
Configuration Description
Conditions (all must be true):
- All files must end in .py
- The changes only affect lines of code that invoke a
loggerobject. This should be customized to your environment.
Automation Actions:
- Apply a
log-output-onlylabel - Approve the PR
- Post a comment explaining that the change only affects logging output.
Approve Python Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_python_log_output:
+ # Triggered for python changes that only affect lines of code that invoke a logger object.
+ # Modify 'logger' to match your dev environment.
+ if:
+ - {{ files | match(regex=r/\.py$/) | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^[+-].*logger\.(trace|debug|info|warn|error)/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Automation - Integrate gitStream with Python
Auto-Approve Python Log Output Changes
Approve changes to Python files that only affect lines of code that invoke a specified logging object.
Configuration Description
Conditions (all must be true):
- All files must end in .py
- The changes only affect lines of code that invoke a
loggerobject. This should be customized to your environment.
Automation Actions:
- Apply a
log-output-onlylabel - Approve the PR
- Post a comment explaining that the change only affects logging output.
Approve Python Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_python_log_output:
+ # Triggered for python changes that only affect lines of code that invoke a logger object.
+ # Modify 'logger' to match your dev environment.
+ if:
+ - {{ files | match(regex=r/\.py$/) | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^[+-].*logger\.(trace|debug|info|warn|error)/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Auto-Approve Python Formatting Changes
Approve PRs that only contain formatting changes to Python files.
Configuration Description
Conditions (all must be true):
- All of the files end in
.py. - All changes are non-functional
Automation Actions:
- Approve the PR
- Apply a
code-formattinglabel. - Post a comment that explains the automation.
Approve Python Formatting Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_python_formatting:
+ if:
+ - {{ files | extensions | match(list=['py']) | every }}
+ - {{ source.diff.files | isFormattingChange }}
+ run:
+ - action: approve@v1
+ - action: add-label@v1
+ args:
+ label: code-formatting
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR only contains formatting changes and has been approved.
+Review Missing Python Tests
Automatically request changes for Python PRs that lack test files.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Python files
- The PR lacks new test files that match the name of the Python files
Automation Actions:
- Apply a red missing-tests label
- Request changes and post a comment listing the files that need tests.
Review Missing Python Tests
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newFiles: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!test_.*\.py$).*\.py$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/^tests\/test_.*\.py$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+
+newFilesCount: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!test_.*\.py$).*\.py$/) | filter(attr='original_file', regex=r/^$/) | length }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/^tests\/test_.*\.py$/) | filter(attr='original_file', regex=r/^$/) | length }}
+
+automations:
+ review_missing_python_tests:
+ if:
+ - {{ newFilesCount != newTestsCount }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Tests"
+ color: {{ colors.orange }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Some of your new Python files are missing corresponding tests. Please ensure that all new files have a corresponding test file.
+
+ **New Files**: {{ newFilesCount }}
+ {{ newFiles }}
+
+ **New Tests**: {{ newTestsCount }}
+ {{ newTests }}
+colors:
+ orange: 'd93f0b'
+Review Python Test Name
Automatically request changes for Python test files that fail to match the required naming convention.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Python test files
- The Python test fails to match the required naming convention.
Automation Actions:
- Request changes and post a comment that explains the Python test name requirements.
Review Python Test Name
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/^tests/) }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/^tests/) | length }}
+
+automations:
+ review_python_test_name:
+ if:
+ - {{ newTestsCount > 0}}
+ - {{ source.diff.files | filter(attr='new_file', regex=r/^tests/) | match(attr='new_file', regex=r/test_.*\.py$/) | nope }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ The test file name does not follow the Python test name conventions. A test file name needs to have the prefix test_ before class name. For example, if you are testing a class file called Data.py then the test file name has to be test_data.py.
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Review Missing Python Tests
Automatically request changes for Python PRs that lack test files.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Python files
- The PR lacks new test files that match the name of the Python files
Automation Actions:
- Apply a red missing-tests label
- Request changes and post a comment listing the files that need tests.
Review Missing Python Tests
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newFiles: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!test_.*\.py$).*\.py$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/^tests\/test_.*\.py$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+
+newFilesCount: {{ source.diff.files | filter(attr='new_file', regex=r/^src\/(?!test_.*\.py$).*\.py$/) | filter(attr='original_file', regex=r/^$/) | length }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/^tests\/test_.*\.py$/) | filter(attr='original_file', regex=r/^$/) | length }}
+
+automations:
+ review_missing_python_tests:
+ if:
+ - {{ newFilesCount != newTestsCount }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Tests"
+ color: {{ colors.orange }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Some of your new Python files are missing corresponding tests. Please ensure that all new files have a corresponding test file.
+
+ **New Files**: {{ newFilesCount }}
+ {{ newFiles }}
+
+ **New Tests**: {{ newTestsCount }}
+ {{ newTests }}
+colors:
+ orange: 'd93f0b'
+Review Python Test Name
Automatically request changes for Python test files that fail to match the required naming convention.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Python test files
- The Python test fails to match the required naming convention.
Automation Actions:
- Request changes and post a comment that explains the Python test name requirements.
Review Python Test Name
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/^tests/) }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/^tests/) | length }}
+
+automations:
+ review_python_test_name:
+ if:
+ - {{ newTestsCount > 0}}
+ - {{ source.diff.files | filter(attr='new_file', regex=r/^tests/) | match(attr='new_file', regex=r/test_.*\.py$/) | nope }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ The test file name does not follow the Python test name conventions. A test file name needs to have the prefix test_ before class name. For example, if you are testing a class file called Data.py then the test file name has to be test_data.py.
+Approve Ruby Log Output Changes
Approve changes to Ruby files that only affect lines of code that invoke the logger object.
Configuration Description
Conditions (all must be true):
- All files end in .rb
- The changes only affect lines of code that invoke logger object.
Automation Actions:
- Apply a
log-output-onlylabel - Approve the PR
- Post a comment explaining that the change only affects logging output.
Approve Ruby Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_ruby_log_output:
+ # Triggered for Ruby changes that only affect the logger method
+ if:
+ - {{ files | extensions | match(term='rb') | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^.*logger\.(fatal|debug|info|warn|error)/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Automation - Integrate gitStream with Ruby
Approve Ruby Log Output Changes
Approve changes to Ruby files that only affect lines of code that invoke the logger object.
Configuration Description
Conditions (all must be true):
- All files end in .rb
- The changes only affect lines of code that invoke logger object.
Automation Actions:
- Apply a
log-output-onlylabel - Approve the PR
- Post a comment explaining that the change only affects logging output.
Approve Ruby Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_ruby_log_output:
+ # Triggered for Ruby changes that only affect the logger method
+ if:
+ - {{ files | extensions | match(term='rb') | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^.*logger\.(fatal|debug|info|warn|error)/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Review Missing Ruby Tests
Automatically request changes for Ruby PRs that lack test files.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Ruby files
- The PR lacks new test files that match the name of the Ruby files
Automation Actions:
- Apply a red missing-tests label
- Request changes and post a comment listing the files that need tests.
Review Missing Ruby Tests
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newFiles: {{ source.diff.files | filter(attr='new_file', regex=r/^app\/(?!.*\_spec\.rb$).*\.rb$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/spec\/.*\_spec\.rb$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+
+newFilesCount: {{ source.diff.files | filter(attr='new_file', regex=r/^app\/(?!.*\_spec\.rb$).*\.rb$/) | filter(attr='original_file', regex=r/^$/) | length }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/spec\/.*\_spec\.rb$/) | filter(attr='original_file', regex=r/^$/) | length }}
+
+automations:
+ review_missing_ruby_tests:
+ if:
+ - {{ newFilesCount != newTestsCount }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Tests"
+ color: {{ colors.orange }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Some of your new Ruby files are missing corresponding tests. Please ensure that all new files have a corresponding test file.
+
+ **New Files**: {{ newFilesCount }}
+ {{ newFiles }}
+
+ **New Tests**: {{ newTestsCount }}
+ {{ newTests }}
+colors:
+ orange: 'd93f0b'
+Review Ruby Test Name
Automatically request changes for Ruby test files that fail to match the required naming convention.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Ruby test files
- The Ruby test fails to match the required naming convention.
Automation Actions:
- Request changes and post a comment that explains the Ruby test name requirements.
Review Ruby Test Name
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/^spec/) }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/^spec/) | length }}
+
+automations:
+ review_ruby_test_name:
+ if:
+ - {{ newTestsCount > 0}}
+ - {{ source.diff.files | filter(attr='new_file', regex=r/^spec/) | match(attr='new_file', regex=r/_spec.rb$/) | nope }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ The test file name does not follow the Ruby test name conventions. A test file name needs to have the suffix _spec after class name. For example, if you are testing a class file called data.rb then the test file name has to be data_spec.rb.
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Special thanks to Boemo W Mmopelwa for providing these examples.
Review Missing Ruby Tests
Automatically request changes for Ruby PRs that lack test files.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Ruby files
- The PR lacks new test files that match the name of the Ruby files
Automation Actions:
- Apply a red missing-tests label
- Request changes and post a comment listing the files that need tests.
Review Missing Ruby Tests
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+newFiles: {{ source.diff.files | filter(attr='new_file', regex=r/^app\/(?!.*\_spec\.rb$).*\.rb$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/spec\/.*\_spec\.rb$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }}
+
+newFilesCount: {{ source.diff.files | filter(attr='new_file', regex=r/^app\/(?!.*\_spec\.rb$).*\.rb$/) | filter(attr='original_file', regex=r/^$/) | length }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/spec\/.*\_spec\.rb$/) | filter(attr='original_file', regex=r/^$/) | length }}
+
+automations:
+ review_missing_ruby_tests:
+ if:
+ - {{ newFilesCount != newTestsCount }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Tests"
+ color: {{ colors.orange }}
+ - action: request-changes@v1
+ args:
+ comment: |
+ Some of your new Ruby files are missing corresponding tests. Please ensure that all new files have a corresponding test file.
+
+ **New Files**: {{ newFilesCount }}
+ {{ newFiles }}
+
+ **New Tests**: {{ newTestsCount }}
+ {{ newTests }}
+colors:
+ orange: 'd93f0b'
+Review Ruby Test Name
Automatically request changes for Ruby test files that fail to match the required naming convention.
Configuration Description
Conditions (all must be true):
- The PR creates one or more new Ruby test files
- The Ruby test fails to match the required naming convention.
Automation Actions:
- Request changes and post a comment that explains the Ruby test name requirements.
Review Ruby Test Name
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+newTests: {{ source.diff.files | filter(attr='new_file', regex=r/^spec/) }}
+newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/^spec/) | length }}
+
+automations:
+ review_ruby_test_name:
+ if:
+ - {{ newTestsCount > 0}}
+ - {{ source.diff.files | filter(attr='new_file', regex=r/^spec/) | match(attr='new_file', regex=r/_spec.rb$/) | nope }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ The test file name does not follow the Ruby test name conventions. A test file name needs to have the suffix _spec after class name. For example, if you are testing a class file called data.rb then the test file name has to be data_spec.rb.
+Approve Rust Log Output Changes
Approve changes to Rust files that only affect lines of code that invoke the logging marcos.
Configuration Description
Conditions (all must be true):
- All files end in
.rs - The changes only affect lines of code that invoke
print,printlnordbgmacros or use thelogcrate macros.
Automation Actions:
- Apply a
log-output-onlylabel - Approve the PR
- Post a comment explaining that the change only affects logging output.
Approve Rust Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_rust_log_output:
+ # Triggered for Rust changes that only affect the logging macros
+ if:
+ - {{ files | extensions | match(term='rs') | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^.*\b(println|print|dbg|error|warn|info|debug|trace)\b!/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Automation - Integrate gitStream with Rust
Approve Rust Log Output Changes
Approve changes to Rust files that only affect lines of code that invoke the logging marcos.
Configuration Description
Conditions (all must be true):
- All files end in
.rs - The changes only affect lines of code that invoke
print,printlnordbgmacros or use thelogcrate macros.
Automation Actions:
- Apply a
log-output-onlylabel - Approve the PR
- Post a comment explaining that the change only affects logging output.
Approve Rust Log Output Changes
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ approve_rust_log_output:
+ # Triggered for Rust changes that only affect the logging macros
+ if:
+ - {{ files | extensions | match(term='rs') | every }}
+ - {{ source.diff.files | matchDiffLines(regex=r/^.*\b(println|print|dbg|error|warn|info|debug|trace)\b!/, ignoreWhiteSpaces=true) | every }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'log-output-only'
+ - action: approve@v1
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR has been approved because it only contains changes to log output
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
Calculate the Percentage of New Code
Post a comment that indicates what percentage of the PR contains new code.
Configuration Description
Conditions (all must be true):
- Any PR
Automation Actions:
- Use the
changescustom expression to post a comment that indicates what percentage of the PR is new code.
Calculate the Percentage of New Code
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ percent_new_code:
+ if:
+ - true
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR is {{ changes.ratio }}% new code.
+
+changes:
+ # Sum all the lines added/edited in the PR
+ additions: {{ branch.diff.files_metadata | map(attr='additions') | sum }}
+ # Sum all the line removed in the PR
+ deletions: {{ branch.diff.files_metadata | map(attr='deletions') | sum }}
+ # Calculate the ratio of new code
+ ratio: {{ (changes.additions / (changes.additions + changes.deletions)) * 100 | round(2) }}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Provide Estimated Time to Review
Label all PRs with an estimated number of minutes it would take someone to review. gitStream will automatically update this label whenever a PR changes.
Configuration Description
Conditions (all must be true):
- Any new PR or change to an existing PR.
Automation Actions:
- Apply a color coded label that provides an estimated number of minutes someone will need to review the PR.
Provide Estimated Time to Review
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ estimated_time_to_review:
+ if:
+ - true
+ run:
+ - action: add-label@v1
+ args:
+ label: "{{ calc.etr }} min review"
+ color: {{ colors.red if (calc.etr >= 20) else ( colors.yellow if (calc.etr >= 5) else colors.green ) }}
+
+calc:
+ etr: {{ branch | estimatedReviewTime }}
+
+
+colors:
+ red: 'b60205'
+ yellow: 'fbca04'
+ green: '0e8a16'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Request Screenshot
If the PR lacks an image file, or link to an image in the description, apply a no-screenshot label and post a comment to request a screenshot. If the PR author updates the description, gitStream will remove the label.
Configuration Description
Conditions (all must be true):
- The PR description lacks an image or link to an image.
Automation Actions:
- Apply a
no-screenshotlabel. - Post a comment that requests a screenshot. Update this action to provide specific context for your project.
Request Screenshot
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ request_screenshot:
+ # Triggered for PRs that lack an image file or link to an image in the PR description
+ if:
+ - {{ not (has.screenshot_link or has.image_uploaded) }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'no-screenshot'
+ color: '#FF000A'
+ - action: add-comment@v1
+ args:
+ comment: |
+ Be a life saver 🛟 by adding a screenshot of the changes you made.
+
+has:
+ screenshot_link: {{ pr.description | includes(regex=r/!\[.*\]\(.*(jpg|svg|png|gif|psd).*\)/) }}
+ image_uploaded: {{ pr.description | includes(regex=r/<img.*src.*(jpg|svg|png|gif|psd).*>/) }}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
More Automations can be found on the Automation Library and Integrations pages.
Enforce Branch Naming Conventions
Automatically enforce prefixes or keywords in PR branch names.
Configuration Description
Conditions (all must be true):
- The incoming branch name is missing a required prefix
featurefixorstable - The invoming branch name fails to match a specified regex pattern. In this case
abc-followed by a number. - The incoming branch name is not listed in an
ignoreListcustom expression.
Automation Actions:
- Post a comment explaining the branch name requirements.
- Apply a red label:
❗ Incorrect Branch Name - Close the PR.
Enforce Branch Naming Conventions
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ enforce_branch_name:
+ if:
+ - {{ not has.requiredBranchPrefix }}
+ - {{ not has.requiredBranchKeyword }}
+ - {{ not ignoreList }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "❗ Incorrect Branch Name"
+ color: {{ colors.red }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ All PR branch names must be prefixed by feature, stable, or fix, and must contain a reference to a Jira ticket. E.g. 'feature-abc-1234'
+ Please move your changes to a new branch that meets these requirements and open a new PR.
+ - action: close@v1
+
+has:
+ requiredBranchPrefix: {{ branch.name | includes(regex=r/^(feature|stable|fix)/) }}
+ requiredBranchKeyword: {{ branch.name | includes(regex=r/abc+-\d+/) }}
+
+ignoreList: {{ branch.name | match(regex=r/^(development|staging)/) }}
+Manage git Branches With gitStream
Use gitStream to enforce branch naming conventions, review assignment, and other branch managment workflows.
Enforce Branch Naming Conventions - Automatically enforce prefixes or keywords in PR branch names.
Assign Reviewers Based on Target Branch - Automatically assign PR reviewers for target branches that include a specified keyword.
Enforce Branch Naming Conventions
Enforce Branch Naming Conventions
Automatically enforce prefixes or keywords in PR branch names.
Configuration Description
Conditions (all must be true):
- The incoming branch name is missing a required prefix
featurefixorstable - The invoming branch name fails to match a specified regex pattern. In this case
abc-followed by a number. - The incoming branch name is not listed in an
ignoreListcustom expression.
Automation Actions:
- Post a comment explaining the branch name requirements.
- Apply a red label:
❗ Incorrect Branch Name - Close the PR.
Enforce Branch Naming Conventions
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ enforce_branch_name:
+ if:
+ - {{ not has.requiredBranchPrefix }}
+ - {{ not has.requiredBranchKeyword }}
+ - {{ not ignoreList }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "❗ Incorrect Branch Name"
+ color: {{ colors.red }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ All PR branch names must be prefixed by feature, stable, or fix, and must contain a reference to a Jira ticket. E.g. 'feature-abc-1234'
+ Please move your changes to a new branch that meets these requirements and open a new PR.
+ - action: close@v1
+
+has:
+ requiredBranchPrefix: {{ branch.name | includes(regex=r/^(feature|stable|fix)/) }}
+ requiredBranchKeyword: {{ branch.name | includes(regex=r/abc+-\d+/) }}
+
+ignoreList: {{ branch.name | match(regex=r/^(development|staging)/) }}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Assign additional reviewers for large PRs
- Assign or suggest reviewers based on level of code expertise for the code changed in a PR.
- Assign reviewers based on modified directories and files
- Assign reviewers to share knowledge based on pre-determined criteria
More Automations can be found on the Automation Library and Integrations pages.
Enforce Copyright Headers
Automatically require copyright headers for all new source code files.
Configuration Description
Conditions (all must be true):
- The PR creates a new file inside the /src directory that lacks a specified copyright header at the top of the file.
Automation Actions:
- Request changes and post a comment that explains the copyright header requirement.
Enforce Copyright Headers
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ enforce_copyright_header:
+ if:
+ - {{ source.diff.files | filter(attr='new_file', regex=r/src\//) | map(attr='original_file') | match(regex=r/^$/) | some }}
+ - {{ source.diff.files | matchDiffLines(regex=licence.licenceRegex) | nope }}
+
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ All new files in the '/src' directory must include the required copyright header at the top of the file. For example:
+ // Copyright (c) ORG and contributors. All rights reserved.
+ // Licensed under the MIT license. See LICENSE file in the project root for details.
+
+licence:
+ licenceRegex: r/(Copyright \(c\) )|(Licensed under the MIT license)/
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Require changelog updates for PRs to specific branches
- Flag the use of deprecated APIs, functions, or other components.
- Restrict portions of your code base to authorized teams only.
- Require changes when PRs include !important tags in CSS files
More Automations can be found on the Automation Library and Integrations pages.
Enforce PR Semantic Title Names
Automatically enforce PR naming conventions; this example expects the format: <type>(<scope>): <short summary>
Configuration Description
Conditions (all must be true):
- The PR fails to follow a predefined semantic release format:
Automation Actions:
- Request changes and post a comment explaining why.
Enforce PR Semantic Title Names
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ enforce_pr_title:
+ if:
+ - {{ pr.title | match(regex=titlePolicy.titleRegex) | nope }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: |
+ All PRs must be titled according to our semantic naming policy: `<type>(<scope>): <short summary>`
+
+ Type must be one of the following:
+
+ * build
+ * ci
+ * docs
+ * feature
+ * fix
+
+ Scope must be one of the following:
+
+ * common
+ * core
+ * elements
+ * forms
+ * http
+titlePolicy:
+ titleRegex: r/\b(build|ci|docs|feature|fix)\b\s*\((common|core|elements|forms|http)\):\s*\w+.*/
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Require changelog updates for PRs to specific branches
- Flag the use of deprecated APIs, functions, or other components.
- Restrict portions of your code base to authorized teams only.
- Require changes when PRs include !important tags in CSS files
More Automations can be found on the Automation Library and Integrations pages.
Explain Code Experts
Post a comment that uses git blame and history to list the most relevant experts for all PRs. The comment will automatically update as additional commits are added to the PR.
Configuration Description
Conditions (all must be true):
- A PR is created or modified.
Automation Actions:
- Post a comment that identifies the people with the highest level of code expetise.
Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Assign additional reviewers for large PRs
- Assign reviewers based on modified directories and files
- Assign reviewers to share knowledge based on pre-determined criteria
More Automations can be found on the Automation Library and Integrations pages.
Flag Code That's Merged Without Review
Automatically send notifications to your team when code is merged without review.
Configuration Description
Conditions (all must be true):
- A PR is merged without at least one review.
Automation Actions:
- Send a Slack notification to alert your team.
- Apply a red
DCF5-merged-without-reviewlabel. - Post a comment explaining SOC II requirements.
Flag Code That's Merged Without Review
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+on:
+ - merge
+
+# https://docs.gitstream.cm/automation-actions/#send-slack-message
+slack_webhook: {{ env.SLACK_WEBHOOK }}
+
+# Update security_team to match your organization
+security_team: 'my-org/app-sec'
+
+automations:
+ flag_merged_no_review:
+ if:
+ - {{ pr.approvals | length == 0 }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "DCF5-merged-without-review"
+ color: {{ colors.red }}
+
+ - action: send-slack-message@v1
+ args:
+ message: "PR #{{ pr.number }} - {{ pr.title }} - was merged without peer reviews. SOC2 requires code reviews for every code change. _SOC2 ref: CC8.1_"
+ webhook_url: "{{ slack_webhook }}"
+
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR was merged without peer reviews. SOC2 requires code reviews for every code change.
+ _SOC2 ref: CC8.1_
+
+ @{{ security_team }}
+
+
+colors:
+ red: 'F6443B'
+Enforce Required Labels
Automatically enforce the use of required PR labels.
Configuration Description
Conditions (all must be true):
- The PR lacks one or more labels from a list of required labels.
Automation Actions:
- Apply a
Missing Required Labelslabel. - Post a comment explaining why the label was applied and which labels are required.
Enforce Required Labels
manifest:
+ version: 1.0
+
+automations:
+ enforce_required_labels:
+ if:
+ - {{ pr.labels | match(list=['Core', 'Mobile', 'UI']) | nope }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: Please ensure that your PR is labeled with either 'Core', 'Mobile', or 'UI'. These labels help us to better track and manage your contribution. Thank you.
+PR Label Management with gitStream
Use YAML to automate label management on your git repo with gitStream.
Enforce Required Labels
Enforce Required Labels
Automatically enforce the use of required PR labels.
Configuration Description
Conditions (all must be true):
- The PR lacks one or more labels from a list of required labels.
Automation Actions:
- Apply a
Missing Required Labelslabel. - Post a comment explaining why the label was applied and which labels are required.
Enforce Required Labels
manifest:
+ version: 1.0
+
+automations:
+ enforce_required_labels:
+ if:
+ - {{ pr.labels | match(list=['Core', 'Mobile', 'UI']) | nope }}
+ run:
+ - action: request-changes@v1
+ args:
+ comment: Please ensure that your PR is labeled with either 'Core', 'Mobile', or 'UI'. These labels help us to better track and manage your contribution. Thank you.
+Label Modified Resources
Label Changed Resources By Percent
Apply a label to all PRs that indicates what percentage of new lines of code modify one or more specified resources.
Configuration Description
Conditions (all must be true):
- A PR modifies resources listed in one or more specified locations.
Automation Actions:
- Apply labels that indicate what percentage of new code lines modify the specified resources.
Label Changed Resources By Percent
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ {% for item in labels %}
+ label_resource_percent_{{ item.name }}:
+ if:
+ - {{ files | match(list=item.resources) | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: '{{ item.additions | round }}% {{ item.name }}'
+ {% endfor %}
+
+resources:
+ core:
+ - src/app
+ - src/core
+ mobile:
+ - src/android
+ - src/ios
+ docs:
+ - docs/
+
+labels:
+ - name: Core
+ resources: {{ resources.core }}
+ additions: {{ branch.diff.files_metadata | filter(attr='file', list=resources.core ) | map(attr='additions') | sum / total.additions * 100 }}
+ - name: Mobile
+ resources: {{ resources.mobile }}
+ additions: {{ branch.diff.files_metadata | filter(attr='file', list=resources.mobile ) | map(attr='additions') | sum / total.additions * 100 }}
+ - name: Docs
+ resources: {{ resources.docs }}
+ additions: {{ branch.diff.files_metadata | filter(attr='file', list=resources.docs ) | map(attr='additions') | sum / total.additions * 100 }}
+
+total:
+ additions: {{ branch.diff.files_metadata | map(attr='additions') | sum }}
+Label PRs by Language
Automatically detect which programming languages are contained in PRs and automatically label the PRs appropriately.
Configuration Description
Conditions (all must be true):
- A PR is created or updated.
Automation Actions:
- Label the PR for each programming language that is included.
Label PRs by Language
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ {% for item in labels %}
+ label_{{ item.name }}_pr:
+ if:
+ - {{ files | match(regex=item.resources) | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: '{{ item.name }}'
+ {% endfor %}
+
+labels:
+ - name: Java
+ resources: r/.java$/
+ - name: Rust
+ resources: r/.rs$/
+ - name: HTML
+ resources: r/.html$/
+ - name: JavaScript
+ resources: r/.js$/
+ - name: Python
+ resources: r/.py$/
+ - name: Golang
+ resources: r/.go$/
+ - name: Ruby
+ resources: r/.rb$/
+ - name: CSS
+ resources: r/.css/
+Label the Number of Unresolved Code Review Threads
Label Unresolved Review Threads
Automatically label PRs when there are unresolved code review comments.
Configuration Description
Conditions (all must be true):
- The PR has one or more unresolved code review comments.
Automation Actions:
- Apply a label that indicates how many unresolved comments the PR has.
Label Unresolved Review Threads
Automatically Recommend Labels for New PRs
Suggest Labels
Automatically suggest labels to apply to new PRs.
Configuration Description
Conditions (all must be true):
- A PR is created or updated that has no labels.
Automation Actions:
- Post a comment that suggest labels the author can apply to the PR.
Suggest Labels
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ suggest_labels:
+ if:
+ - {{ pr.labels | length == 0}}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ All PRs must contain labels that indicate which CI/CD systems must be run. PLease update your PR to include one of the following labels: `Build: Mobile`, `Build: UI`, `Build: All`, `Build: None`
+
+ Additionally, Here are some labels you can apply to this PR that may be helpful:
+ * Suggest Reviewer - Use this if you aren't sure who to assign as the reviewer.
+ * WIP - Indicate this is a work in progress that shouldn't be merged.
+Label PRs with the Number of Approvals
Label the Number of Approvals
Automatically label PRs with the number of completed reviews that approve the PR.
Configuration Description
Conditions (all must be true):
- A PR is created or updated.
Automation Actions:
- Apply or update a label that indicates how many merge approvals have been granted.
Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
Special thanks to Boemo W Mmopelwa for help with these examples.
Label the Number of Approvals
Automatically label PRs with the number of completed reviews that approve the PR.
Configuration Description
Conditions (all must be true):
- A PR is created or updated.
Automation Actions:
- Apply or update a label that indicates how many merge approvals have been granted.
Label Based on Modified Resources
Automatically label PRs to indicate what resources are being changed.
Configuration Description
Conditions (all must be true):
- A PR is created or updated.
Automation Actions:
- Apply labels based on the branch name or modified resources.
Label Modified Resources
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ {% for item in labels %}
+ label_resource_{{ item.name }}:
+ if:
+ -{{ branch.name | includes(regex=item.branch) or files | match(list=item.resources) }}
+ run:
+ - action: add-label@v1
+ args:
+ label: {{ item.name }}
+ {% endfor %}
+
+labels:
+ - name: Core
+ resources:
+ - src/app
+ branch: r/^core-/
+ - name: mobile
+ resources:
+ - src/android
+ - src/ios
+ branch: r/^mobile-/
+Label PRs by Language
Automatically detect which programming languages are contained in PRs and automatically label the PRs appropriately.
Configuration Description
Conditions (all must be true):
- A PR is created or updated.
Automation Actions:
- Label the PR for each programming language that is included.
Label PRs by Language
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ {% for item in labels %}
+ label_{{ item.name }}_pr:
+ if:
+ - {{ files | match(regex=item.resources) | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: '{{ item.name }}'
+ {% endfor %}
+
+labels:
+ - name: Java
+ resources: r/.java$/
+ - name: Rust
+ resources: r/.rs$/
+ - name: HTML
+ resources: r/.html$/
+ - name: JavaScript
+ resources: r/.js$/
+ - name: Python
+ resources: r/.py$/
+ - name: Golang
+ resources: r/.go$/
+ - name: Ruby
+ resources: r/.rb$/
+ - name: CSS
+ resources: r/.css/
+Label Changed Resources By Percent
Apply a label to all PRs that indicates what percentage of new lines of code modify one or more specified resources.
Configuration Description
Conditions (all must be true):
- A PR modifies resources listed in one or more specified locations.
Automation Actions:
- Apply labels that indicate what percentage of new code lines modify the specified resources.
Label Changed Resources By Percent
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ {% for item in labels %}
+ label_resource_percent_{{ item.name }}:
+ if:
+ - {{ files | match(list=item.resources) | some }}
+ run:
+ - action: add-label@v1
+ args:
+ label: '{{ item.additions | round }}% {{ item.name }}'
+ {% endfor %}
+
+resources:
+ core:
+ - src/app
+ - src/core
+ mobile:
+ - src/android
+ - src/ios
+ docs:
+ - docs/
+
+labels:
+ - name: Core
+ resources: {{ resources.core }}
+ additions: {{ branch.diff.files_metadata | filter(attr='file', list=resources.core ) | map(attr='additions') | sum / total.additions * 100 }}
+ - name: Mobile
+ resources: {{ resources.mobile }}
+ additions: {{ branch.diff.files_metadata | filter(attr='file', list=resources.mobile ) | map(attr='additions') | sum / total.additions * 100 }}
+ - name: Docs
+ resources: {{ resources.docs }}
+ additions: {{ branch.diff.files_metadata | filter(attr='file', list=resources.docs ) | map(attr='additions') | sum / total.additions * 100 }}
+
+total:
+ additions: {{ branch.diff.files_metadata | map(attr='additions') | sum }}
+Label Unresolved Review Threads
Automatically label PRs when there are unresolved code review comments.
Configuration Description
Conditions (all must be true):
- The PR has one or more unresolved code review comments.
Automation Actions:
- Apply a label that indicates how many unresolved comments the PR has.
Label Unresolved Review Threads
Suggest Labels
Automatically suggest labels to apply to new PRs.
Configuration Description
Conditions (all must be true):
- A PR is created or updated that has no labels.
Automation Actions:
- Post a comment that suggest labels the author can apply to the PR.
Suggest Labels
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ suggest_labels:
+ if:
+ - {{ pr.labels | length == 0}}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ All PRs must contain labels that indicate which CI/CD systems must be run. PLease update your PR to include one of the following labels: `Build: Mobile`, `Build: UI`, `Build: All`, `Build: None`
+
+ Additionally, Here are some labels you can apply to this PR that may be helpful:
+ * Suggest Reviewer - Use this if you aren't sure who to assign as the reviewer.
+ * WIP - Indicate this is a work in progress that shouldn't be merged.
+Automatic Project Tracker Links
Post a PR comment that links the associated resource in your issue tracker, such as Jira, Azure Boards, Shortcut, Asana, and more.
Configuration Description
Conditions (all must be true):
- The PR contains a reference to project tracking tickets in the title or branch name.
Automation Actions:
- Post a comment that provides a link to the associated project tracking resource.
Link Issue Tracker
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+# Configure these to match your organization.
+provider: jira
+orgName: org
+asanaProject: 1234
+azureProject: my_project
+
+{% set ticketid = "" %}
+{% for ticket in tickets %}
+{% if (ticket | includes(regex=r/.+/)) %}
+{% set ticketid = ticket %}
+{% endif %}
+{% endfor %}
+
+automations:
+ comment_issue_tracker:
+ if:
+ - {{ has.ticket_in_title or has.ticket_in_branch }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: Issue Tracker Link - [{{ticketid}}]({{tracker[provider].baseurl}}{{ticketid}})
+
+has:
+ ticket_in_title: {{ pr.title | includes(regex=tracker[provider].pattern) }}
+ ticket_in_branch: {{ branch.name | includes(regex=tracker[provider].pattern) }}
+
+tracker:
+ jira:
+ baseurl: https://[orgName].atlassian.net/browse/
+ pattern: r/\b[A-Za-z]+-\d+\b/
+ asana:
+ baseurl: https://app.asana.com/0/[asanaProject]/0/
+ pattern: r/asana-(\d+)/
+ azure:
+ baseurl: https://dev.azure.com/[orgName]/[azureProject]/_workitems/
+ pattern: r/(\w+)-(\w+)-(\d+)/
+ shortcut:
+ baseurl: https://app.shortcut.com/[orgName]/story/
+ pattern: r/(\w+)\/sc-(\d+)/
+
+tickets:
+ - {{branch.name | capture(regex=tracker[provider].pattern)}}
+ - {{pr.title | capture(regex=tracker[provider].pattern)}}
+Assign Code Experts
When someone applies a suggest-reviewers label to a PR, use codeExperts to assign recommended reviewers and post a comment with the explainCodeExperts automation action.
Configuration Description
Conditions (all must be true):
- The PR has a suggest-reviewers label attached to it.
Automation Actions:
- Use
codeExpertsto assign recommended reviewers. - Use
explainCodeExpertsto post a comment that lists the top code experts for the PR.
Assign Code Experts
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ assign_code_experts:
+ # Triggered when someone applies a suggest-reviewer label to a PR.
+ if:
+ - {{ pr.labels | match(term='suggest-reviewer') | some }}
+ # More info about code experts
+ # https://docs.gitstream.cm/filter-functions/#codeexperts
+ run:
+ - action: add-reviewers@v1
+ args:
+ reviewers: {{ repo | codeExperts(gt=10) }}
+ - action: explain-code-experts@v1
+ args:
+ gt: 10
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Assign additional reviewers for large PRs
- Assign reviewers based on modified directories and files
- Assign reviewers to share knowledge based on pre-determined criteria
More Automations can be found on the Automation Library and Integrations pages.
Use gitStream for Automatic Code Review Assignment
Automatically assign code reviews based on changed resources, code expertise, branch, and more.
Assign Code Experts
When someone applies a suggest-reviewers label to a PR, use codeExperts to assign recommended reviewers and post a comment with the explainCodeExperts automation action.
Configuration Description
Conditions (all must be true):
- The PR has a suggest-reviewers label attached to it.
Automation Actions:
- Use
codeExpertsto assign recommended reviewers. - Use
explainCodeExpertsto post a comment that lists the top code experts for the PR.
Assign Code Experts
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ assign_code_experts:
+ # Triggered when someone applies a suggest-reviewer label to a PR.
+ if:
+ - {{ pr.labels | match(term='suggest-reviewer') | some }}
+ # More info about code experts
+ # https://docs.gitstream.cm/filter-functions/#codeexperts
+ run:
+ - action: add-reviewers@v1
+ args:
+ reviewers: {{ repo | codeExperts(gt=10) }}
+ - action: explain-code-experts@v1
+ args:
+ gt: 10
+Branch-Based Review Policies
Automatically route and manage PRs based on the target or destination branch.
Configuration Description
Conditions (all must be true):
- The target or source branch name contains a specified prefix.
Automation Actions:
- Implement custom review policies for the branch.
Review Target Branch
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ {% for item in branches %}
+ review_target_branch_{{ item.name }}:
+ if:
+ - {{ pr.target| match(regex=item.prefix) }}
+ run:
+ - action: set-required-approvals@v1
+ args:
+ approvals: {{ item.reviews }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ PRs to the {{ item.name }} branch require {{ item.reviews }} review(s).
+ - action: add-reviewers@v1
+ args:
+ reviewers: [{{ item.reviewers }}]
+ {% endfor %}
+
+branches:
+ - prefix: r/^release/
+ reviews: 4
+ name: Release
+ - prefix: r/^experimental-/
+ reviews: 1
+ name: Experimental
+Review Source Branch
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ {% for item in branches %}
+ review_source_branch{{ item.name }}:
+ if:
+ - {{ branch.name | match(regex=item.prefix) }}
+ run:
+ - action: set-required-approvals@v1
+ args:
+ approvals: {{ item.reviews }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ Reviewers from the {{ item.name }} team have automatically been assigned to this PR.
+ - action: add-reviewers@v1
+ args:
+ reviewers: [{{ item.reviewers }}]
+ {% endfor %}
+
+branches:
+ - prefix: r/^ABC/
+ reviewers: org/a-team
+ name: ABC
+ - prefix: r/^XYZ-/
+ reviewers: org/x-team
+ name: XYZ
+Review Sensitive Files
Compare the changed files to a pre-defined list of files and directories in. If any files match, require a review from the team my-organization/security.
Configuration Description
Conditions (all must be true):
- Any files match the files or directories listed in the
sensitive_filescustom expression. Customize this list for your project.
Automation Actions:
- Assign
my-organization/securityto review the PR. Customize this value to match your organization. - Require 2 approvals.
- Post a comment that explains the automation.
Review Sensitive Files
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ # Assign special teams to review sensitive files.
+ # This requires the `sensitive` custom expression found at the bottom of this file.
+ review_sensitive_files:
+ # For all files listed in the sensitive custom expression.
+ if:
+ - {{ files | match(list=sensitive_files) | some }}
+ run:
+ # Add reviewers from the dev-leads team, and require two approvals
+ # Modify `my-organization/security` to match your organization.
+ - action: add-reviewers@v1
+ args:
+ reviewers: [my-organization/security]
+ - action: set-required-approvals@v1
+ args:
+ approvals: 2
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR affects one or more sensitive files and requires review from the security team.
+
+# The `sensitive_file_review` automation requires this custom expression.
+# Modify this list to suit your security needs.
+sensitive_files:
+ - src/app/auth/
+ - src/app/routing/
+ - src/app/resources/
+Custom Team Review Policies
Automatically assign the PR author's team to review PRs.
Configuration Description
Conditions (all must be true):
- The PR author is a member of one of the teams specified in the
teamscustom expression.
Automation Actions:
- Assign that team to review the PR.
Assign the Author's Team for Review
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ {% for item in teams %}
+ review_team_{{ item.name }}:
+ if:
+ - {{ pr.author_teams | match(regex=item.regex) }}
+ run:
+ - action: add-reviewers@v1
+ args:
+ reviewers: [{{ item.team }}]
+ - action: add-comment@v1
+ args:
+ comment: |
+ This {{ item.name }} team has been automatically assigned to review this PR.
+ {% endfor %}
+
+teams:
+ - regex: r/ui-team/
+ name: UI Team
+ team: org/ui-team
+ - regex: r/mobile-team/
+ name: Mobile
+ team: org/mobile-team
+Distribute Code Reviews to Share Knowledge
Require the reviewer as a previous contributor with code expertise between set thresholds when PR contains Share Knowledge label.
Configuration Description
Conditions (all must be true):
- A
Share Knowledgelabel has been applied to the PR
Automation Actions:
- Choose a previous contributor between specified expertise thresholds and assign them as a reviewer.
- Post a comment explaining why this action was taken.
Knowledge Share
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ share_knowledge:
+ if:
+ - {{ pr.labels | match(term='Share Knowledge') | some }}
+ run:
+ - action: add-reviewers@v1
+ args:
+ reviewers: {{ repo | codeExperts(gt=30, lt=60) | random }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ gitStream has assigned a reviewer to increase knowledge sharing on this PR.
+Notify Watcher
Automatically notify code reviewers based on a resource watchlist.
Configuration Description
Conditions (all must be true):
- The PR modifies any files listed under the
watcherscustom expression.
Automation Actions:
- Post a comment that notifies the responsible team or individual of the changes.
Notify Watcher
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+## change orgName to match your git organization name.
+orgName: company
+
+automations:
+ {% for item in watchers %}
+ notify_watcher_{{ item.owner if item.owner else item.team }}:
+ if:
+ - {{ (files | match(list=item.files) | some) or (source.diff.files | match(attr="diff", list=item.diffs) | some) }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ @{{ item.owner if item.owner else (["{{ orgName }}/", item.team] | join) }} - this PR has changes you're watching
+
+ {% if files | match(list=item.files) | some -%}
+ files:
+ {%- for file in files | filter(list=item.files) %}
+ - {{ file }}
+ {%- endfor -%}
+ {%- endif %}
+
+ {% if source.diff.files | match(attr="diff", list=item.diffs) | some -%}
+ diffs:
+ {%- for diff in item.diffs -%}
+ {%- if source.diff.files | match(attr="diff", list=diff) | some %}
+ - {{ diff }}
+ {%- for file in source.diff.files | filter(attr="diff", list=diff) | map(attr="new_file") %}
+ - {{ file }}
+ {%- endfor -%}
+ {%- endif -%}
+ {%- endfor -%}
+ {%- endif %}
+ - action: add-reviewers@v1
+ args:
+ reviewers: {{ item.owner }}
+ team_reviewers: {{ item.team }}
+ {% endfor %}
+
+
+
+watchers:
+ - owner: juliaspencer
+ files:
+ - src/auth
+ - team: release
+ files:
+ - package.json
+ - yarn.lock
+Notify Watchlist
Automatically notify code reviewers based on a resource watchlist.
Configuration Description
Conditions (all must be true):
- The PR modifies any files listed under the
watcherscustom expression.
Automation Actions:
- Post a comment that notifies the responsible team or individual of the changes.
Notify Watcher
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+## change orgName to match your git organization name.
+orgName: company
+
+automations:
+ {% for item in watchers %}
+ notify_watcher_{{ item.owner if item.owner else item.team }}:
+ if:
+ - {{ (files | match(list=item.files) | some) or (source.diff.files | match(attr="diff", list=item.diffs) | some) }}
+ run:
+ - action: add-comment@v1
+ args:
+ comment: |
+ @{{ item.owner if item.owner else (["{{ orgName }}/", item.team] | join) }} - this PR has changes you're watching
+
+ {% if files | match(list=item.files) | some -%}
+ files:
+ {%- for file in files | filter(list=item.files) %}
+ - {{ file }}
+ {%- endfor -%}
+ {%- endif %}
+
+ {% if source.diff.files | match(attr="diff", list=item.diffs) | some -%}
+ diffs:
+ {%- for diff in item.diffs -%}
+ {%- if source.diff.files | match(attr="diff", list=diff) | some %}
+ - {{ diff }}
+ {%- for file in source.diff.files | filter(attr="diff", list=diff) | map(attr="new_file") %}
+ - {{ file }}
+ {%- endfor -%}
+ {%- endif -%}
+ {%- endfor -%}
+ {%- endif %}
+ - action: add-reviewers@v1
+ args:
+ reviewers: {{ item.owner }}
+ team_reviewers: {{ item.team }}
+ {% endfor %}
+
+
+
+watchers:
+ - owner: juliaspencer
+ files:
+ - src/auth
+ - team: release
+ files:
+ - package.json
+ - yarn.lock
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Assign additional reviewers for large PRs
- Assign or suggest reviewers based on level of code expertise for the code changed in a PR.
- Assign reviewers based on modified directories and files
- Assign reviewers to share knowledge based on pre-determined criteria
More Automations can be found on the Automation Library and Integrations pages.
Branch-Based Review Policies
Automatically route and manage PRs based on the target or destination branch.
Configuration Description
Conditions (all must be true):
- The target or source branch name contains a specified prefix.
Automation Actions:
- Implement custom review policies for the branch.
Review Target Branch
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ {% for item in branches %}
+ review_target_branch_{{ item.name }}:
+ if:
+ - {{ pr.target| match(regex=item.prefix) }}
+ run:
+ - action: set-required-approvals@v1
+ args:
+ approvals: {{ item.reviews }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ PRs to the {{ item.name }} branch require {{ item.reviews }} review(s).
+ - action: add-reviewers@v1
+ args:
+ reviewers: [{{ item.reviewers }}]
+ {% endfor %}
+
+branches:
+ - prefix: r/^release/
+ reviews: 4
+ name: Release
+ - prefix: r/^experimental-/
+ reviews: 1
+ name: Experimental
+Review Source Branch
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ {% for item in branches %}
+ review_source_branch{{ item.name }}:
+ if:
+ - {{ branch.name | match(regex=item.prefix) }}
+ run:
+ - action: set-required-approvals@v1
+ args:
+ approvals: {{ item.reviews }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ Reviewers from the {{ item.name }} team have automatically been assigned to this PR.
+ - action: add-reviewers@v1
+ args:
+ reviewers: [{{ item.reviewers }}]
+ {% endfor %}
+
+branches:
+ - prefix: r/^ABC/
+ reviewers: org/a-team
+ name: ABC
+ - prefix: r/^XYZ-/
+ reviewers: org/x-team
+ name: XYZ
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Assign additional reviewers for large PRs
- Assign or suggest reviewers based on level of code expertise for the code changed in a PR.
- Assign reviewers based on modified directories and files
- Assign reviewers to share knowledge based on pre-determined criteria
More Automations can be found on the Automation Library and Integrations pages.
Review Sensitive Files
Compare the changed files to a pre-defined list of files and directories in. If any files match, require a review from the team my-organization/security.
Configuration Description
Conditions (all must be true):
- Any files match the files or directories listed in the
sensitive_filescustom expression. Customize this list for your project.
Automation Actions:
- Assign
my-organization/securityto review the PR. Customize this value to match your organization. - Require 2 approvals.
- Post a comment that explains the automation.
Review Sensitive Files
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ # Assign special teams to review sensitive files.
+ # This requires the `sensitive` custom expression found at the bottom of this file.
+ review_sensitive_files:
+ # For all files listed in the sensitive custom expression.
+ if:
+ - {{ files | match(list=sensitive_files) | some }}
+ run:
+ # Add reviewers from the dev-leads team, and require two approvals
+ # Modify `my-organization/security` to match your organization.
+ - action: add-reviewers@v1
+ args:
+ reviewers: [my-organization/security]
+ - action: set-required-approvals@v1
+ args:
+ approvals: 2
+ - action: add-comment@v1
+ args:
+ comment: |
+ This PR affects one or more sensitive files and requires review from the security team.
+
+# The `sensitive_file_review` automation requires this custom expression.
+# Modify this list to suit your security needs.
+sensitive_files:
+ - src/app/auth/
+ - src/app/routing/
+ - src/app/resources/
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Assign additional reviewers for large PRs
- Assign or suggest reviewers based on level of code expertise for the code changed in a PR.
- Assign reviewers based on modified directories and files
- Assign reviewers to share knowledge based on pre-determined criteria
More Automations can be found on the Automation Library and Integrations pages.
Assign the Author's Team for Review
Automatically assign the PR author's team to review PRs.
Configuration Description
Conditions (all must be true):
- The PR author is a member of one of the teams specified in the
teamscustom expression.
Automation Actions:
- Assign that team to review the PR.
Assign the Author's Team for Review
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ {% for item in teams %}
+ review_team_{{ item.name }}:
+ if:
+ - {{ pr.author_teams | match(regex=item.regex) }}
+ run:
+ - action: add-reviewers@v1
+ args:
+ reviewers: [{{ item.team }}]
+ - action: add-comment@v1
+ args:
+ comment: |
+ This {{ item.name }} team has been automatically assigned to review this PR.
+ {% endfor %}
+
+teams:
+ - regex: r/ui-team/
+ name: UI Team
+ team: org/ui-team
+ - regex: r/mobile-team/
+ name: Mobile
+ team: org/mobile-team
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Assign additional reviewers for large PRs
- Assign or suggest reviewers based on level of code expertise for the code changed in a PR.
- Assign reviewers based on modified directories and files
- Assign reviewers to share knowledge based on pre-determined criteria
More Automations can be found on the Automation Library and Integrations pages.
Knowledge Share
Require the reviewer as a previous contributor with code expertise between set thresholds when PR contains Share Knowledge label.
Configuration Description
Conditions (all must be true):
- A
Share Knowledgelabel has been applied to the PR
Automation Actions:
- Choose a previous contributor between specified expertise thresholds and assign them as a reviewer.
- Post a comment explaining why this action was taken.
Knowledge Share
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+automations:
+ share_knowledge:
+ if:
+ - {{ pr.labels | match(term='Share Knowledge') | some }}
+ run:
+ - action: add-reviewers@v1
+ args:
+ reviewers: {{ repo | codeExperts(gt=30, lt=60) | random }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ gitStream has assigned a reviewer to increase knowledge sharing on this PR.
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Assign additional reviewers for large PRs
- Assign or suggest reviewers based on level of code expertise for the code changed in a PR.
- Assign reviewers based on modified directories and files
More Automations can be found on the Automation Library and Integrations pages.
Enforce Changelog Updates
Request changes if a PR that meets specified criteria lacks an update to the project's changelog.
Configuration Description
Conditions (All must be true):
- The branch name contains the phrase
feature - The PR lacks changes to the docs/changelog.md file
Automation Actions:
- Apply a yellow label that says
⚠️ Missing Changelog - Request changes and post a comment explaining why.
Review Changelog
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+automations:
+ # Request changes for new features that lack changelog updates.
+ review_changelog:
+ if:
+ - {{ branch.name | includes(term="feature") }}
+ - {{ files | match(regex=r/^docs\/changelog\.md$/) | nope }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "⚠️ Missing Changelog"
+ color: {{ colors.yellow }}
+ - action: add-comment@v1
+ args:
+ comment: |
+ All new features require an update to the changelog. Please modify your PR to include any relevant changelog updates.
+
+colors:
+ yellow: 'fbca04'
+Special thanks to Boemo W Mmopelwa for providing this example.
Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Flag the use of deprecated APIs, functions, or other components.
- Restrict portions of your code base to authorized teams only.
- Require changes when PRs include !important tags in CSS files
More Automations can be found on the Automation Library and Integrations pages.
Review TODO Comments
Request changes for a PR that contains a TODO statement.
Configuration Description
Conditions (all must be true):
- The PR contains a TODO statement
Automation Actions:
- Request changes and post a comment explaining why.
Review TODO Comments
Summarize Language Changes
Post a comment that summarizes which programming languages are contained in PRs.
Configuration Description
Conditions (all must be true):
- A PR is created.
Automation Actions:
- Post a comment containing a table that shows the percent of total changes for each programming language present in the PR.
Summarize Language Changes
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+on:
+ - pr_created
+
+automations:
+ summarize_language_changes:
+ if:
+ - true
+ run:
+ - action: add-comment@v1
+ args:
+ comment:
+ <h3>Summary of Changes by Language</h3>
+ <table>
+ <tr>
+ <td>Language</td>
+ <td>Language Change Percentage</td>
+ </tr>
+ <tr>
+ <td>Java</td>
+ <td>{{ total.java | round }}%</td>
+ </tr>
+ <tr>
+ <td>JavaScript</td>
+ <td>{{ total.javascript | round }}%</td>
+ </tr>
+ <td>Rust</td>
+ <td>{{ total.rust | round }}%</td>
+ </tr>
+ <tr>
+ <td>Ruby</td>
+ <td>{{ total.ruby | round }}%</td>
+ </tr>
+ <td>HTML</td>
+ <td>{{ total.html | round }}%</td>
+ </tr>
+ <td>CSS</td>
+ <td>{{ total.css | round }}%</td>
+ </tr>
+ <tr>
+ <td>Golang</td>
+ <td>{{ total.golang | round }}%</td>
+ </tr>
+ <tr>
+ <td>Python</td>
+ <td>{{ total.python | round }}%</td>
+ </tr>
+ </table>
+
+total:
+ additions: {{ branch.diff.files_metadata | map(attr='additions') | sum }}
+ java: {{ branch.diff.files_metadata | filter(attr='file', regex=r/.java$/ ) | map(attr='additions') | sum / total.additions * 100 }}
+ javascript: {{ branch.diff.files_metadata | filter(attr='file', regex=r/.js$/ ) | map(attr='additions') | sum / total.additions * 100 }}
+ rust: {{ branch.diff.files_metadata | filter(attr='file', regex=r/.rs$/ ) | map(attr='additions') | sum / total.additions * 100 }}
+ ruby: {{ branch.diff.files_metadata | filter(attr='file', regex=r/.rb$/ ) | map(attr='additions') | sum / total.additions * 100 }}
+ html: {{ branch.diff.files_metadata | filter(attr='file', regex=r/.html$/ ) | map(attr='additions') | sum / total.additions * 100 }}
+ css: {{ branch.diff.files_metadata | filter(attr='file', regex=r/.css$/ ) | map(attr='additions') | sum / total.additions * 100 }}
+ golang: {{ branch.diff.files_metadata | filter(attr='file', regex=r/.go$/ ) | map(attr='additions') | sum / total.additions * 100 }}
+ python: {{ branch.diff.files_metadata | filter(attr='file', regex=r/.py$/ ) | map(attr='additions') | sum / total.additions * 100 }}
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
More Automations can be found on the Automation Library and Integrations pages.
CM File Header
This header is useful to add to the top of any configuration files you create for your organization. This will help others who want to make improvements to your configurations in the future.
CM File Header
# -*- mode: yaml -*-
+
+# +----------------------------------------------------------------------------+
+# | WARNING: This file controls repo automations, use caution when modifying |
+# +----------------------------------------------------------------------------+
+# | This file contains one or more /:\ gitStream automations: |
+# | https:// docs.gitstream.cm |
+# | |
+# | gitStream uses YAML syntax with nunjucks templating via Jinja 2. |
+# | |
+# | Automations follow an "if this, then that" execution format. |
+# | More info here: https://docs.gitstream.cm/how-it-works/ |
+# | |
+# +----------------------------------------------------------------------------+
+
+# /:\ gitStream Reference Docs:
+# Context Variables: https://docs.gitstream.cm/context-variables/
+# Filter Functions: https://docs.gitstream.cm/filter-functions/
+# Automation Actions: https://docs.gitstream.cm/automation-actions/
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
More Automations can be found on the Automation Library and Integrations pages.
Colors Custom Expression
This automation demonstrates all of GitHub's default label colors, implemented as a colors custom expression. This is meant to help improve other automations rather than being used on its own.
Colors Custom Expression
# -*- mode: yaml -*-
+
+manifest:
+ version: 1.0
+
+# This automation demonstrates all of GitHub's default label colors.
+# This is meant to be used as a reference, not as an automation in your repo.
+automations:
+ label_colors:
+ if:
+ - true
+ run:
+ - action: add-label@v1
+ args:
+ label: "Test Label"
+ color: {{ colors.green }}
+
+# These are all of the colors in GitHub's default label color palette.
+colors:
+ red: 'b60205'
+ orange: 'd93f0b'
+ yellow: 'fbca04'
+ green: '0e8a16'
+ teal: '006b75'
+ blue: '1d76db'
+ dark-blue: '0052cc'
+ purple: '5319e7'
+ light-red: 'e99695'
+ light-orange: 'f9d0c4'
+ light-yellow: 'fef2c0'
+ light-green: 'c2e0c6'
+ light-teal: 'bfdadc'
+ light-blue: 'c5def5'
+ light-dark-blue: 'bfd4f2'
+ light-purple: 'd4c5f9'
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
More Automations can be found on the Automation Library and Integrations pages.
Welcome Newcomer
Post a welcome message when someone makes their first PR to a repo, and provide context to help them know what's next.
Configuration Description
Conditions (all must be true):
- The PR author made their first contribution to the repo during the current day.
Automation Actions:
- Add the
my-organization/mentorsteam to review the PR. Customize this to match your organization. - Apply a
new-contributorlabel to the PR. - Post a comment explaining the next steps. Customize this to match your project.
Welcome Newcomer
# -*- mode: yaml -*-
+manifest:
+ version: 1.0
+
+automations:
+ # Help newcomers find mentors to guide them.
+ welcome_newcomer:
+ # If the PR author made their first contirbution on the current day
+ if:
+ - {{ repo.author_age < 1 and repo.age > 0 }}
+ # 1. Add reviewers from the team `my_organization/mentors`. Replace this string to match your organization
+ # 2. Apply a new-contributor label.
+ # 3 Post a comment that explains the next steps.
+ run:
+ - action: add-reviewers@v1
+ args:
+ reviewers: [my_organization/mentors]
+ - action: add-label@v1
+ args:
+ label: 'new-contributor'
+ color: '#FBBD10'
+ - action : add-comment@v1
+ args:
+ comment: |
+ Hello {{ pr.author }} 👋 Thanks for making your first PR, and welcome to our project!
+ Our mentor team has automatically been assigned to review this PR and guide you through the process.
+ Please reach out to that team if you have questions about the next steps.
+Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.
/:\ gitStream Changelog
All notable changes to this project will be documented in this file.
2024.5.06
- Simplified GitLab workflow file: Using the image directly instead of docker Dind
2024.5.06
- Reorganized trigger configuration: Moved the top-level
onkeyword under a newtriggerskeyword to consolidate all trigger settings. - Enhanced repository and branch triggering:
- Moved
config.include_repositoryandconfig.ignore_repositorytotriggers.include.repositoryandtriggers.exclude.repository, aligning repository-specific triggers with the new consolidated trigger configuration. - Introduced
triggers.include.branchandtriggers.exclude.branchto specify branch-specific conditions for triggering automations.
- Moved
2024.4.16
- Added a cache option for the docker image
2024.3.28
- Supporting regular expressions in ~~
config.ignore_repositories~~triggers.include.repositoryandtriggers.exclude.repository
2024.3.14
- Added the following explicit triggers:
pr_ready_for_reviewpr_closedpr_reopened
2024.3.7
- Triggering on comment edits
- Added support for
request-changesaction in GitLab
2023.11.22
- gitStream Playground official release
gitStream Configuration Overview
Continuous Merge automation files have a .cm extension. In a repository, gitStream loads and parse the .cm directory, which can have multiple automation files, each of which is evaluated independently.
You can edit the .cm files and add your own checks and rules. Check out the Automation examples.
Automation rules
There are two types of automation rules: repository level rules and organization level rules.
Repository level rules are set by creating a special .cm directory in the repository root. Automation rules are specified in files in this directory, which can have any name but must end with .cm.
Organization level rules are defined by creating a special repository named cm in the organization or group. In this repository, you can add CM automation files, which will apply to all the repositories that gitStream app is connected.
When organization level rules are defines, repository level automation shall take precedence and override organization automation when having the same identifier.
An automation identifier is a composition of the CM file name and the automation name. For example when safe_changes is defined in gitstream.cm then the automation identifier shall be gitstream/safe_changes
Tip
You can select (include or exclude) certain repositories per automation file using the triggers.include.repository and triggers.exclude.repository
Repository automation rules
Repository automation rules are set by creating a special .cm directory in your repository root. Automation rules are specified in files in this directory, these files can have any name but must end with .cm. By default, you start with a single automation file .cm/gitstream.cm.
Every file is parsed independently, and the parsing results are combined and executed.
Specifically:
- Automation rules are allowed to have same name in different
.cmfiles - The
configsection is defined per.cmfile (exceptconfig.admin) - Any accessory expression defined in each file scope, therefore cannot be reused in another file (but it can be duplicated)
When configured correctly, your repository directory structure should look like that (for GitHub):
Repsository automation rules
.
+├─ .cm/
+│ └─ *.cm
+├─ .github/
+│ └─ workflows/
+│ └─ gitstream.yml
+Note
The .cm/gitstream.cm is special, as it allows repository-level configuration such as config.admin.
Organization automation rules
Organization automation rules are defined by creating a special repository cm in your organization or group. In this repository, you can add CM automation files, which will apply to all the repositories that gitStream app is connected.
When configured correctly, the cm repository directory structure should look like that (for GitHub):
For each PR the following automation rules are applied:
- Repository level rules
- Organization-level rules, unless with the same identifier as a repository-level automation
When organization level rules are defined, then the CI/CD will be executed on the cm repository on behalf of the PR repository.
Setting up Global Automation rules
By utilizing the following techniques, you can effectively combine and manage global and repository rules to customize the behavior of your automations to fit the specific requirements of your repositories:
- Global rules are defined in the configuration management
cmrepository and are applied to all repositories that are connected to gitStream. - To exclude or run only on specific repositories from a global rule, you can use
triggers.include.repositoryandtriggers.exclude.repositoryin thecmfile and add a list of the unwanted or wanted repositories respectfully. - To override a global rule for specific automation in a repository, you can duplicate the rule (both the file and automation name) and place it in the desired repository. The locally defined rule will then take precedence over the global rule for that specific repository.
The .cm automation file
Schema
The following sections are used in .cm file to describe the desired automations:
manifest
The first section in a gitstream.cm file is the manifest.
The only field required is version.
| Key | Required | Type | Description |
|---|---|---|---|
manifest | Y | Map | The manifest section root |
manifest.version | Y | String | Specify the .cm spec version: 0.1, 1.0 |
The manifest version field is used to parse the .cm file, in the future if breaking changes are introduced to the parser then older automation will be still supported.
config
The config section in the .cm file is optional and specifies settings that affect gitStream's operation within a given context.
| Key | Type | Default | Scope | Description |
|---|---|---|---|---|
config | Map | - | per .cm file | Root configuration section, applies to the automations defined in the current file. |
config.admin.users | [String] | [] | gitstream.cm | List of admin users, identified by Git provider usernames. |
config.ignore_files | [String] | [] | per .cm file | Files to exclude from consideration. |
config.user_mapping | [String: String] | [] | per .cm file | Map Git user details to provider account names. |
config.admin.users
When specified in gitstream.cm the config.admin.users allows adding admin rights, when a PR changes the *.cm files only, if the user is listed in config.admin.users the PR will be then approved by gitStream. For example, setting popeye as admin:
This configuration is valid only when used in .cm/gitstream.cm, when defined in other .cm files this configuration is ignored.
When you add a user to config.admin.users in your organization's cm repository, they are granted administrative privileges to CM changes across every repository in the organization. gitStream evaluates CM rules in the individual repository and your organization's cm repository to determine admin users.
config.ignore_files
The config.ignore_files supports glob pattern matching that contains a list of files to ignore.
Common usage, since some files such as lock files are intentionally not a required part of a review, they would not want to them to be counted in the estimated review time. In such cases, you can add config.ignore_files to the relevant CM file, for example:
example
config:
+ ignore_files:
+ - 'yarn.lock'
+ - 'package-lock.json'
+ - 'openapi.json'
+ - 'ui/src/**/*Model.d.ts'
+config.user_mapping
Accepts list of key value strings.
For example, when using rankByGitBlame or explainRankByGitBlame Git users are mapped to their matching Git provider accounts based on the Git details. The automatic mapping can sometimes result with the wrong account or fail to find a proper mapping, in these cases you can configure the config.user_mapping. This allows you to map confusing Git user into their specific accounts and dump some irrelevant accounts:
example
config:
+ user_mapping:
+ - 'Popeye Man <popeye@invalid.com>': 'popeye-the-salyor-man' # (1)
+ - 'Popeye Man <popeye2@invalid.com>': 'popeye-the-salyor-man' # (2)
+ - 'olive <olive@invalid.com>': null # (3)
+- Map Git user signature to the correct Git provider user name (e.g. GitHub)
- Map Git user signature to the correct Git provider user name (e.g. GitHub)
- Mapping to
nullremoves this Git user from the suggested results
When using rankByGitBlame to assign reviewers automatically with add-reviewers@v1 then mapping users to null is a way to prevent the automatic mapping in certain cases, like in your example contributors that are not longer part of the team.
On the other hand, when using explainRankByGitBlame with add-comment@v1 it still shows these users details in the PR comment suggestion as this info might be valuable by itself.
- action: add-reviewers@v1
+ args: # (1)
+ reviewers: {{ repo | rankByGitBlame(gt=25) }}
+
+- action: add-comment@v1
+ args: # (2)
+ comment: |
+ {{ repo | explainRankByGitBlame(gt=25) }}
+rankByGitBlamewill dropnullusersexplainRankByGitBlamewill NOT dropnullusers
triggers
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.
Read more here: triggers.
automations
The automations section defines the automations and their conditions.
automations:
+ mark_small_pr:
+ if:
+ - {{ checks.size.is.xsmall }}
+ run:
+ - action: add-label@v1
+ args:
+ label: xsmall
+Each automation includes its name, and few fields: if and run.
| Key | Required | Type | Description |
|---|---|---|---|
automations | Y | Map | The automations section root |
automations.NAME | Y | Map | User defined name of the automation, can be any string |
automations.NAME.if | Y | Map | List of conditions with AND relationship |
automations.NAME.run | Y | Map | Actions to run if all conditions are met, invoked one by one |
The if field includes the list of conditions. The conditions are checked when a pull request is opened or changed, if all the conditions pass, the automation is executed.
The run field includes the automation to execute. It includes the following fields:
| Key | Required | Type | Description |
|---|---|---|---|
action | Y | String | The action pointer |
engine | N | String | The action engine, default is gitstream |
args | N | List | The action inputs list |
For gitstream engine, the action is specified by: name@version
gitStream supported actions, see actions.
Reusing checks
You can define an accessory section, e.g. checks, that defines common conditions, and reuse.
size:
+ is:
+ small: {{ branch.diff.size < 20 }}
+ medium: {{ branch.diff.size >= 20 and branch.diff.size < 100 }}
+ large: {{ branch.diff.size >= 100 }}
+
+automations:
+ approve_small:
+ if:
+ - {{ size.is.small }}
+ run:
+ - action: approve@v1
+ mark_small_medium:
+ if:
+ # Check that the PR is either small or medium size
+ - {{ size.is.small or size.is.medium }}
+ # AND its less than 5 minutes review (estimated)
+ - {{ branch | estimatedReviewTime <= 5 }}
+ run:
+ - action: add-label@v1
+ args:
+ label: 'good-size'
+Context variables
Context variable are the inputs for the automation conditions or checks.
Legend
The icons indicate the availability status of each action.
- Supported on GitHub
- Supported on GitLab
- Under development and not available yet.
- Open beta - Under development and currently available for all
Overview
Context
gitStream includes a collection of variables called contexts.
Structures
The following structures are used in the context objects:
Example of a context object
Partial example of a context object for a PR that changed few lines in a README.md file:
{
+ "branch": {
+ "name": "new-feature-branch",
+ "base": "main",
+ "diff": {
+ "size": 50,
+ "files_metadata": [
+ {
+ "original_file": "README.md",
+ "new_file": "README.md",
+ "deletions": 0,
+ "additions": 2
+ }
+ ]
+ },
+ "num_of_commits": 1
+ },
+ "source": {
+ "diff": {
+ "files": [
+ {
+ "original_file": "README.md",
+ "new_file": "README.md",
+ "diff": "@@ -10,3 +10,5 @@ This project \n+\n+## Intro",
+ "original_content": "This project \n",
+ "new_content": "This project \n\n## Intro"
+ }
+ ]
+ }
+ },
+ "repo": {
+ "contributors": {
+ "popeye": "46",
+ "olive": "6"
+ },
+ "owner": "acme"
+ },
+ "files": [
+ "README.md"
+ ]
+}
+Reference
branch
The branch context contains info regarding the branch changes compared to the base branch.
Note
compared to the source context does not include actual source code.
| Values | Type | Description |
|---|---|---|
branch | Map | Includes the info related to the current branch |
branch.author | String | The branch author (the user that did first commit in the branch). The formatted like author in git-log, e.g. Popeye <popeye@acme.com> |
branch.author_name | String | The branch author name |
branch.author_email | String | The branch author email |
branch.base | String | The main branch, main |
branch.commits.messages | [String] | A list with all the commit messages in this branch |
branch.diff.size | Integer | The sum of line changed: additions, edits and deletions |
branch.diff.files_metadata | FileMetadata | List of changed files including their relative path |
branch.name | String | The current branch, feature-123-branch |
branch.num_of_commits | Integer | The number of commits in the branch |
The branch context doesn't include any source code, but only related metadata.
Example for using branch.name and branch.author to automatically approve and merge version bumps.
automations:
+ dependabot:
+ if:
+ - {{ branch.name | includes(term="dependabot") }}
+ - {{ branch.author | includes(term="dependabot") }}
+ run:
+ - action: approve@v1
+ - action: add-label@v1
+ args:
+ label: "approved-dependabot"
+ - action: merge@v1
+ args:
+ wait_for_all_checks: true
+ squash_on_merge: true
+Tip
The files context doesn't include deleted file, to identify both modified and deleted files use the branch.diff.files_metadata, for example:
env
The env context allows the user to pass data from the repo that is unavailable in the other context variables. Thus, the structure of the variable is not fixed and depends on user configuration.
To configure the env variable, add the env field to gitstream's workflow job configurations on .github/workflows/gitstream.yml. For more information, visit GitHub's guide for Using secrets in GitHub Actions
examle: add secrets to the env variable
...
+jobs:
+ gitStream:
+ timeout-minutes: 5
+ runs-on: ubuntu-latest
+ name: gitStream workflow automation
+ env:
+ SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+...
+To use the context variable, access to the env variable's fields as configured in gitstream.yml
example: use slack webhook secret
automations:
+ send_slack:
+ if:
+ - true
+ run:
+ - action: send-slack-message@v1
+ args:
+ message: "Hello world :tada:."
+ webhook_url: "{{ slack_webhook }}"
+
+slack_webhook: {{ env.SLACK_WEBHOOK }}
+files
The files context includes the list of changed files in the branch compared to the main branch.
| Values | Type | Description |
|---|---|---|
files | [String] | List of all changed files with their full path |
For example, a typical files context can look like this:
Example for checking if certain changes are made:
automations:
+ ui_review:
+ if:
+ - {{ files | match(list=ui_templates_files) | some }}
+ run:
+ - action: add-reviewers@v1
+ args:
+ reviewers: [GitHubUser1, GitHubUser2]
+
+ui_templates_files:
+ - resources/app/ui_template.yml
+ - resources/app/role_template.yml
+ - resources/app/account_template.yml
+pr
The pr context includes metadata related to the pull request.
| Values | Type | Description |
|---|---|---|
pr | Map | Includes the info related to the PR |
pr.approvals | [String] | A list of the of reviewers that approved the PR |
pr.author | String | The PR author name |
pr.author_teams | String | The teams which the PR author is member of |
pr.author_is_org_member | Bool | true if the PR author is a member of the organization where gitStream is installed |
pr.checks | [Check] | List of checks, names and status |
pr.comments | [Comment] | List of PR comments objects |
pr.conflicted_files_count | Integer | The number files in the PR with conflicts |
pr.conversations | [Conversation] | List of PR conversation objects, usually when reviewer have comments about the source code |
pr.created_at | String | The date and time the PR was created |
pr.draft | Bool | true when the PR is marked as Draft/WIP |
pr.description | String | The PR description text |
pr.labels | [String] | The labels that are attached to the PR |
pr.number | Integer | The PR or MR Id number |
pr.provider | String | The Git cloud provider name, e.g. GitHub, GitLab etc. |
pr.reviewers | [String] | The list of reviewers set for this PR |
pr.source | String | The branch from which the PR originates |
pr.status | String | The PR status: open, closed and merged |
pr.target | String | The branch the PR is intended merged into |
pr.title | String | The PR title |
pr.requested_changes | [String] | List of users that requested changes |
pr.reviews | [Review] | List of PR reviews, relevant in GitHub |
pr.unresolved_threads | Integer | The number of open review comments in the PR |
pr.updated_at | String | The date and time the PR was last updated |
Example for checking the PR title includes a Jira ticket:
automations:
+ check_jira_ticket:
+ if:
+ - {{ not has.jira_ticket }}
+ run:
+ - action: add-label@v1
+ args:
+ label: "missing-ticket"
+ color: 'F6443B'
+
+has:
+ jira_ticket: {{ pr.title | includes(regex=r/^\[?\w{3,4}-\d{1,6}\]?(\s|-|_).{20,}$/) }}
+repo
The repo context includes metadata related to the repo.
| Values | Type | Description |
|---|---|---|
repo | Map | Includes the info related to the current repo |
repo.age | Integer | Number of days since first commit (of any user) |
repo.author_age | Integer | number of days since first commit to this repo |
repo.blame | GitBlame | The percentage each user's lines in a file, the list includes all changed files in the branch. The list is sorted by the ratio field |
repo.contributors | Contributor | List of contributors in the repo |
repo.git_activity | GitActivity | Per file and user, the number of lines changed every week for the last 52 weeks |
repo.name | String | Repository name |
repo.owner | String | Repository owner account name |
repo.visibility | String | The visibility of the source branch repo. Value is one of: private, internal, or public |
source
The source context includes a list of FileDiff objects that can be used to get insights based on code changes. The changes compared to the latest main branch.
| Values | Type | Description |
|---|---|---|
source.diff.files | FileDiff | List of changed files with their code changes |
The source context include all code changes, it is not safe to share it with unknown services.
Check structure
{
+ "name": String, # The check name
+ "status": String, # The check status: `queued`, `in_progress`, `completed`
+ "conclusion": String, # The check conclusion: `action_required`, `cancelled`, `failure` `neutral`, `success`, `skipped`, `stale`, `timed_out`
+}
+Comment structure
{
+ "commenter": String, # The user that add the comment
+ "content": String, # The comment body
+ "created_at": String, # The time on which the comment was created
+ "updated_at": String, # The time on which the comment was last updated
+}
+Conversation structure
{
+ "commenter": String, # The user that add the comment
+ "content": String, # The comment body
+ "created_at": String, # The time on which the comment was created
+ "updated_at": String, # The time on which the comment was updated
+ "start_line": Integer, # The first line marked for this comment
+ "end_line": Integer, # The last line marked for this comment
+ "is_resolved": Boolean # `true` when marked as resolved
+}
+Contributor structure
The repo.contributors mapping includes a list of Contributor, where the user name is used as dynamic key:
FileDiff structure
The source.diff.files mapping includes a list of FileDiff:
{
+ "diff": String, # The content in diff format `+` for additions, `-` for deletions
+ "new_content": String, # The new content in this branch
+ "new_file": String, # The name of the file after the changes, including its path
+ "original_content": String, # The content as is in the `main` branch
+ "original_file": String, # The name of the file before the changes, including its path
+}
+FileMetadata structure
The branch.diff.files_metadata mapping includes a list of FileMetadata:
{
+ "additions": Integer, # The number of lines edited or added to the file
+ "deletions": Integer, # The number of lines removed from the file
+ "file": String, # The name of the file before the changes, including its path
+}
+For example, sum additions in javascript code files:
{{ branch.diff.files_metadata | filter(attr='new_file', regex=r/\.js$|\.ts$/) | map(attr='additions') | sum }}
+GitActivity structure
This structure include per changed file, for every user, the number of lines changed every week for the last 52 weeks.
{
+ FILE_NAME: # The file name and path
+ {
+ # The git user identifier (String)
+ GIT_USER: {
+ "week_INDEX": Integer # Number of lines changed that week
+ # ... for the last 52 weeks
+ }
+ }
+}
+For example:
{
+ "src/utils/service.js": {
+ "popeye <popeye@acme.com>": {
+ "week_1": 20,
+ "week_2": 15,
+ "week_10": 250
+ },
+ "olive <olive@acme.com>": {
+ "week_1": 3,
+ "week_3": 50,
+ "week_52": 250
+ }
+ },
+ "README.md": {
+ "popeye <popeye@acme.com>": {
+ "week_2": 15,
+ "week_3": 10
+ }
+ }
+}
+GitBlame structure
For each file, a list of user's blame ratio.
{
+ FILE_NAME: # The file name and path
+ {
+ # The git user identifier (String)
+ GIT_USER: Integer, # Precentage 0-100, ratio of user's lines / total lines in file
+ }
+}
+For example:
{
+ "src/utils/service.js": {
+ "popeye <popeye@acme.com>": 78,
+ "olive <olive@acme.com>": 22,
+ },
+ "README.md": {
+ "popeye <popeye@acme.com>": 13,
+ "olive <olive@acme.com>": 22,
+ "brutus <brutus@acme.com>": 65,
+ }
+}
+Review structure
{
+ "commenter": String, # The user that add the comment
+ "content": String, # The comment body
+ "created_at": String, # The time on which the comment was created
+ "state": String, # Either `approved`, `changes_requested`, `commented`, `pending`, `submitted`
+ "conversations": [Conversation], # Conversations that are relvant to this Review feedback
+}
+Note
This guide is for installations on self-hosted GitHub Server. If you are using the gitStream cloud service, please refer to this guide.
Custom GitHub App for Self-Hosted GitHub Server
A GitHub application serves as the link between gitStream and GitHub. It facilitates user authentication via OAuth2 and allows users to select repositories accessible by gitStream.
Prerequisites
GitHub Server v3.10 or higher
In this section, we'll guide you through creating a GitHub app for your self-hosted gitStream installation. By the end, you should have noted down the following values:
- App ID
- Private Key
Note
Throughout this document, when we refer to a GitHub account, it refers to your own GitHub Server installation.
1. Connect GitHub Server to LinearB
First login, or create a free account on the LinearB app.
In LinearB, go to Settings -> Git -> click the Connect gitStream button next to your GitHub Server integration. You’ll need to use the Webhook URL and Webhook secret later when setting up the GitHub App.
Keep this window open and complete the next steps in GitHub. Once you have the App ID and Private Key (.pem file), you can complete the connection in LinearB.
2. Create a New GitHub App
Any GitHub account can own the app, but we recommend creating it under the organization account of the team who will maintain the gitStream installation.
- Log in to GitHub and go to your organization account page (e.g.,
https://github.com/<organization account name>) - Click on Settings -> Developer Settings -> GitHub Apps -> New GitHub App as shown below
- Or go directly to
https://github.com/organizations/<organization account name>/settings/apps/new
3. Set Up URLs and General Information
Fill in the app information as shown in the screenshot below. For URLs, replace gitstream.<your-domain>.com with the actual endpoint at which you'll be hosting the gitStream application.
Warning
- Do not forget trailing slashes for the URLs
- Do not forget to disable the "Expire user authorization tokens" checkbox
- The GitHub App name must contain
gitstreamin lower case
Tip
Use the following texts:
- GitHub App name:
gitstream app - Homepage URL:
https://gitstream.cm
Tip
Use the following texts:
- Webhook URL from LinearB setup page
- Webhook secret from LinearB setup page
4. Set Up Permissions
We need the following permissions to enable all gitStream functionality:
- Write access to dedicated gitStream app files: Used to set up the gitStream workflow files
- Write access to code: To allow gitStream to approve PRs once all conditions are met
- Read access to administration, issues, and metadata: To get user team membership and branch protection settings
- Read and write access to actions, checks, pull requests, and workflows: Trigger workflows, create and update pull requests and their checks, and modify workflow files
- User email: Used to identify users |
You need to enable these under the permissions section as shown below:
Tip
Add the following Path (content paths to single files the app can access):
.cm/gitstream.cmgithub/workflows/gitstream.yml
5. Webhook Events and Scope
- Subscribe to events so gitStream is notified when a PR is created, changed, or commented on, etc
Tip
"Where can this GitHub App be installed?" choose "Any account" so other orgs in your company can use gitStream as well. For on-prem installations that work with github.com, only repositories under your company's org account can be accessed via gitStream.
6. Generate a Private Key
Once the app is created, scroll down and click Generate private key. This will create and download a .pem file for you.
Tip
Please keep this file safe, we'll need to put it back in LinearB setup.
7. Upload a Logo
Download the logo file and upload the logo to your app.
8. Get App Configuration
On your newly created app page, you can find the App ID.
Tip
Please keep the App ID, we'll need to put it back in LinearB setup.
9. Finish Setup in LinearB
To complete the integration, fill in the App ID and Private Key in the LinearB setup screen.
Tip
Use the App ID, and Private key (.pem file) to complete the LinearB setup.
10. Connect GitHub App to Your Repositories
Go to your organization settings in GitHub and in Third-party Access choose the GitHub Apps. You may need to choose the account to install the gitStream app on. Choose your org you used to create the GitHub app in the previous sections.
Choose the repositories you want to connect.
Tip
It's recommended to select All repositories, as it covers also future repositories.
11. Finish Setting Up gitStream
Follow the instructions to configure your repository using the GitHub Instructions
)/ + +{% set ticketid = "" %} +{% for ticket in tickets %} +{% if (ticket | includes(regex=r/.+/)) %} +{% set ticketid = ticket %} +{% endif %} +{% endfor %} + +automations: + jira_assign: + if: + - {{ pr.description | includes(regex=assigneeRegex) }} + run: + - action: send-http-request@v1 + args: + url: "{{ env.JIRA_WEBHOOK }}}" + method: POST + headers: '{"Content-type": "application/json"}' + body: '{"issues":["{{ticketid}}"],"data":{"assignee":"{{pr.description | capture(regex=assigneeRegex)}}"}}' + +has: + jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }} + jira_ticket_in_branch: {{ branch.name | includes(regex=r/\b[A-Za-z]+-\d+\b/) }} + +tickets: + - {{branch.name | capture(regex=r/\b[A-Za-z]+-\d+\b/)}} + - {{pr.title | capture(regex=r/\b[A-Za-z]+-\d+\b/)}} diff --git a/downloads/automation-library/integrations/jira/jira_change_status.cm b/downloads/automation-library/integrations/jira/jira_change_status.cm new file mode 100644 index 00000000..2ef50ff5 --- /dev/null +++ b/downloads/automation-library/integrations/jira/jira_change_status.cm @@ -0,0 +1,34 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +on: + - pr_created + +{% set ticketid = "\b[A-Za-z]+-\d+\b" %} +{% for ticket in tickets %} +{% if (ticket | includes(regex=r/.+/)) %} +{% set ticketid = ticket %} +{% endif %} +{% endfor %} + +automations: + jira_change_status: + if: + - {{ has.jira_ticket_in_title or has.jira_ticket_in_desc }} + run: + - action: send-http-request@v1 + args: + url: "{{ env.JIRA_CHANGE_STATUS_WEBHOOK }}" + method: POST + headers: '{"Content-type": "application/json"}' + body: '{"issues":["{{ticketid}}"],"data":{"pr_url":"https://github.com/{{repo.owner}}/{{repo.name}}/pull/{{pr.number}}"}}' + +has: + jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }} + jira_ticket_in_branch: {{ branch.name | includes(regex=r/\b[A-Za-z]+-\d+\b/) }} + +tickets: + - {{branch.name | capture(regex=r/\b[A-Za-z]+-\d+\b/)}} + - {{pr.title | capture(regex=r/\b[A-Za-z]+-\d+\b/)}} \ No newline at end of file diff --git a/downloads/automation-library/integrations/jira/jira_update_field.cm b/downloads/automation-library/integrations/jira/jira_update_field.cm new file mode 100644 index 00000000..85b009ef --- /dev/null +++ b/downloads/automation-library/integrations/jira/jira_update_field.cm @@ -0,0 +1,30 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +on: + - pr_created + +{% set ticketid = "\b[A-Za-z]+-\d+\b" %} +{% for ticket in tickets %} +{% if (ticket | includes(regex=r/.+/)) %} +{% set ticketid = ticket %} +{% endif %} +{% endfor %} + +automations: + jira_update_field: + if: + - {{ has.jira_ticket_in_title or has.jira_ticket_in_branch }} + run: + - action: send-http-request@v1 + args: + url: "{{ env.JIRA_UPDATE_PR_FIELD_WEBHOOK }}" + method: POST + headers: '{"Content-type": "application/json"}' + body: '{"issues":["{{ticketid}}"],"data":{"pr_url":"https://github.com/{{repo.owner}}/{{repo.name}}/pull/{{pr.number}}"}}' + +has: + jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }} + jira_ticket_in_branch: {{ branch.name | includes(regex=r/\b[A-Za-z]+-\d+\b/) }} diff --git a/downloads/automation-library/integrations/jira/label_missing_jira_info.cm b/downloads/automation-library/integrations/jira/label_missing_jira_info.cm new file mode 100644 index 00000000..38005c9d --- /dev/null +++ b/downloads/automation-library/integrations/jira/label_missing_jira_info.cm @@ -0,0 +1,20 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + label_missing_jira_info: + # Triggered for PRs that don't have either a Jira ticket number in the title, + # or a link to a Jira ticket in the PR description. + if: + - {{ not (has.jira_ticket_in_title or has.jira_ticket_in_desc) }} + run: + - action: add-label@v1 + args: + label: "missing-jira" + color: 'F6443B' + +has: + jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }} + jira_ticket_in_desc: {{ pr.description | includes(regex=r/atlassian.net\/browse\/\w{1,}-\d{3,4}/) }} diff --git a/downloads/automation-library/integrations/jira/link_jira.cm b/downloads/automation-library/integrations/jira/link_jira.cm new file mode 100644 index 00000000..48ab36e0 --- /dev/null +++ b/downloads/automation-library/integrations/jira/link_jira.cm @@ -0,0 +1,38 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +provider: jira + +# Change this to the name of your Jira organization +orgName: org + +{% set ticketid = "" %} +{% for ticket in tickets %} +{% if (ticket | includes(regex=r/.+/)) %} +{% set ticketid = ticket %} +{% endif %} +{% endfor %} + +automations: + link_jira: + if: + - {{ has.ticket_in_title or has.ticket_in_branch }} + run: + - action: add-comment@v1 + args: + comment: Issue Tracker Link - [{{ticketid}}]({{tracker[provider].baseurl}}{{ticketid}}) + +has: + ticket_in_title: {{ pr.title | includes(regex=tracker[provider].pattern) }} + ticket_in_branch: {{ branch.name | includes(regex=tracker[provider].pattern) }} + +tracker: + jira: + baseurl: https://[orgName].atlassian.net/browse/ + pattern: r/\b[A-Za-z]+-\d+\b/ + +tickets: + - {{branch.name | capture(regex=tracker[provider].pattern)}} + - {{pr.title | capture(regex=tracker[provider].pattern)}} diff --git a/downloads/automation-library/integrations/jit/label_jit_alerts.cm b/downloads/automation-library/integrations/jit/label_jit_alerts.cm new file mode 100644 index 00000000..66e57248 --- /dev/null +++ b/downloads/automation-library/integrations/jit/label_jit_alerts.cm @@ -0,0 +1,31 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + {% for item in reports %} + label_jit_{{ item.name }}: + if: + - {{ item.count > 0}} + run: + - action: add-label@v1 + args: + label: 'Jit: {{ item.count }} {{ item.name }} vulnerabilities' + color: {{ colors.red if (item.name == 'high') else (colors.orange if (item.name == 'medium' ) else colors.yellow) }} + {% endfor %} + +jit: {{ pr | extractJitFindings }} + +reports: + - name: high + count: {{ jit.metrics.HIGH }} + - name: medium + count: {{ jit.metrics.MEDIUM }} + - name: low + count: {{ jit.metrics.LOW }} + +colors: + red: 'b60205' + orange: 'd93f0b' + yellow: 'fbca04' \ No newline at end of file diff --git a/downloads/automation-library/integrations/jit/review_jit_alerts.cm b/downloads/automation-library/integrations/jit/review_jit_alerts.cm new file mode 100644 index 00000000..c15d9de5 --- /dev/null +++ b/downloads/automation-library/integrations/jit/review_jit_alerts.cm @@ -0,0 +1,34 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + review_jit_high_alerts: + if: + - {{ jit.metrics.HIGH > 0 }} + run: + - action: require-reviewers@v1 + args: + reviewers: [my-organization/security-team] + - action: set-required-approvals@v1 + args: + approvals: 2 + - action: add-comment@v1 + args: + comment: | + This PR requires additional review because Jit reported one or more high risk vulnerabilities. + review_jit_medium_alerts: + if: + - {{ jit.metrics.MEDIUM > 0 }} + run: + - action: set-required-approvals@v1 + args: + approvals: 2 + - action: add-comment@v1 + args: + comment: | + This PR requires additional reviewers because Jit reported one or more medium risk vulnerabilities. + + +jit: {{ pr | extractJitFindings }} diff --git a/downloads/automation-library/integrations/jit/review_jit_ignore_accept.cm b/downloads/automation-library/integrations/jit/review_jit_ignore_accept.cm new file mode 100644 index 00000000..02a5717d --- /dev/null +++ b/downloads/automation-library/integrations/jit/review_jit_ignore_accept.cm @@ -0,0 +1,23 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + review_jit_ignore_accept: + if: + - {{ pr.conversations | reject(attr='commenter', term='jit-ci') | filter(attr='content', term='#jit_ignore_accept') | some }} + run: + + - action: add-reviewers@v1 + args: + reviewers: [my-organziation/security] + - action: add-label@v1 + args: + label: '❕ Jit: Ignore - Accept Risk' + - action: add-comment@v1 + args: + comment: | + The security team has been assigned for optional review because this PR ignores a Jit alert and accepts the associated risks. + +jit: {{ pr | extractJitFindings }} diff --git a/downloads/automation-library/integrations/jit/review_jit_secret.cm b/downloads/automation-library/integrations/jit/review_jit_secret.cm new file mode 100644 index 00000000..e68e311a --- /dev/null +++ b/downloads/automation-library/integrations/jit/review_jit_secret.cm @@ -0,0 +1,22 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + review_jit_secret: + if: + - true + - {{ jit.vulnerabilities | match(attr='security_control', term='Secret Detection') | some }} + run: + - action: add-comment@v1 + args: + comment: | + Jit detects secrets in this PR. Please complete the following steps: + 1. Undo the commit with git reset and remove all secrets from the files you modified. + 2. Deactivate the secret in any locations its used and replace it with a new key + 3. Commit your changes and resubmit your PR. + - action: close@v1 + + +jit: {{ pr | extractJitFindings }} diff --git a/downloads/automation-library/integrations/jsdoc/review_jsdoc.cm b/downloads/automation-library/integrations/jsdoc/review_jsdoc.cm new file mode 100644 index 00000000..58acd587 --- /dev/null +++ b/downloads/automation-library/integrations/jsdoc/review_jsdoc.cm @@ -0,0 +1,21 @@ + +# -*- mode: yaml -*- +manifest: + version: 1.0 +automations: + #Assign PRs that only affect JSDocs to the technical writing team and add docs label + review_jsdoc: + if: + - {{ source.diff.files | match(attr='diff', regex=r/\/*\*[\s\S]*?\//) | every }} + run: + - action: add-label@v1 + args: + label: "📓JSDoc Only" + color: {{ colors.green }} + - action: add-reviewers@v1 + args: + reviewers: [fourth-organization/tech-writers] + - action: approve@v1 + +colors: + green: '0e8a16' \ No newline at end of file diff --git a/downloads/automation-library/integrations/jsdoc/review_jsdoc_input.cm b/downloads/automation-library/integrations/jsdoc/review_jsdoc_input.cm new file mode 100644 index 00000000..5f835c07 --- /dev/null +++ b/downloads/automation-library/integrations/jsdoc/review_jsdoc_input.cm @@ -0,0 +1,16 @@ + +# -*- mode: yaml -*- +manifest: + version: 1.0 +automations: + review_jsdoc_input: + if: + - {{ source.diff.files | matchDiffLines(regex=r/.*\s@param/) | nope }} + - {{ source.diff.files | matchDiffLines(regex=r/\((?:.*\:.*\))/) | some }} + + run: + - action: add-comment@v1 + args: + comment: | + This PR appears to modify method input parameters, but is missing JSDoc changes. Please check to ensure no JSDoc changes are necessary. + diff --git a/downloads/automation-library/integrations/jsdoc/review_jsdoc_large.cm b/downloads/automation-library/integrations/jsdoc/review_jsdoc_large.cm new file mode 100644 index 00000000..d99e94ed --- /dev/null +++ b/downloads/automation-library/integrations/jsdoc/review_jsdoc_large.cm @@ -0,0 +1,34 @@ + +# -*- mode: yaml -*- +manifest: + version: 1.0 +automations: + #Require more extensive reviews for large Javascript changes that lack JSDoc updates. + review_jsdoc_large: + if: + - {{ changes.ratio > 25}} + - {{ source.diff.files | matchDiffLines(regex=r/\/*\*([\s\S]*?)\//) | nope }} + run: + - action: add-label@v1 + args: + label: "⚠️ No JSDoc" + color: {{ colors.yellow }} + - action: add-comment@v1 + args: + comment: | + This PR makes major changes to JavaScript classes, but is missing updates to JSDoc. Please double check for any necessary JSDoc updates. + + - action: add-reviewers@v1 + args: + reviewers: [fourth-organization/tech-writers] + +changes: + # Sum all the lines added/edited in the PR + additions: {{ branch.diff.files_metadata | map(attr='additions') | sum }} + # Sum all the line removed in the PR + deletions: {{ branch.diff.files_metadata | map(attr='deletions') | sum }} + # Calculate the ratio of new code + ratio: {{ (changes.additions / (changes.additions + changes.deletions)) * 100 | round(2) }} + +colors: + yellow: 'fbca04' \ No newline at end of file diff --git a/downloads/automation-library/integrations/jsdoc/review_jsdoc_new_class.cm b/downloads/automation-library/integrations/jsdoc/review_jsdoc_new_class.cm new file mode 100644 index 00000000..a92a5f93 --- /dev/null +++ b/downloads/automation-library/integrations/jsdoc/review_jsdoc_new_class.cm @@ -0,0 +1,25 @@ +# -*- mode: yaml -*- +manifest: + version: 1.0 +automations: + review_jsdoc_new_class: + if: + - {{ is.javascript and is.new }} + - {{ source.diff.files | matchDiffLines(regex=r/\/*\*([\s\S]*?)\//) | nope }} + run: + - action: add-label@v1 + args: + label: "⚠️ Missing JSDoc" + color: {{ colors.yellow }} + - action: request-changes@v1 + args: + comment: | + JSDoc is required for all JavaScript classes. Please add JSDoc to all new classes in this PR. + +is: + javascript: {{ files | extensions | match(list=['js', 'ts']) | every }} + new: {{ source.diff.files | map(attr='original_file') | match(regex=r/^$/) | some }} + +colors: + yellow: 'fbca04' + diff --git a/downloads/automation-library/integrations/launch-darkly/label-ff-launch-darkly/label_ff_launch_darkly.cm b/downloads/automation-library/integrations/launch-darkly/label-ff-launch-darkly/label_ff_launch_darkly.cm new file mode 100644 index 00000000..4a4e9085 --- /dev/null +++ b/downloads/automation-library/integrations/launch-darkly/label-ff-launch-darkly/label_ff_launch_darkly.cm @@ -0,0 +1,30 @@ +# -*- mode: yaml -*- +manifest: + version: 1.0 + +automations: + + {% for item in feature_flags %} + label_ff_launchdarkly_{{ item.name }}: + if: + - {{ source.diff.files | matchDiffLines(regex=r/var flagValue = ldclient/) | some }} + - {{ source.diff.files | matchDiffLines(regex=item.regex) | some }} + run: + - action: add-label@v1 + args: + label: {{ item.name }} + color: {{ colors.yellow }} + {% endfor %} + +feature_flags: + - name: engineering_rollback_plan_activated + regex: r/engineering_rollback_plan_activated/ + - name: marketing_premium_plan_features_unlocked + regex: r/marketing_premium_plan_features_unlocked/ + - name: mobile_push_notifications_enabled + regex: r/mobile_push_notifications_enabled/ + +colors: + yellow: 'ffb300' + + diff --git a/downloads/automation-library/integrations/orca/label_orca_scan_results.cm b/downloads/automation-library/integrations/orca/label_orca_scan_results.cm new file mode 100644 index 00000000..036505ae --- /dev/null +++ b/downloads/automation-library/integrations/orca/label_orca_scan_results.cm @@ -0,0 +1,28 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + {% for item in reports %} + label_orca_{{ item.name }}: + if: + - {{ item.count > 0 }} + run: + - action: add-label@v1 + args: + label: 'orca:{{ item.name }}' + {% endfor %} + +orca: {{ pr | extractOrcaFindings }} + +reports: + - name: introduced-cves + count: {{ orca.vulnerabilities.count }} + - name: iac-misconfigurations + count: {{ orca.infrastructure_as_code.count }} + - name: exposed-secrets + count: {{ orca.secrets.count }} + +colors: + red: 'b60205' diff --git a/downloads/automation-library/integrations/orca/review_orca_alerts.cm b/downloads/automation-library/integrations/orca/review_orca_alerts.cm new file mode 100644 index 00000000..2a2c4c84 --- /dev/null +++ b/downloads/automation-library/integrations/orca/review_orca_alerts.cm @@ -0,0 +1,23 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 +automations: + review_orca_alerts: + if: + - {{ has.vulnerability or has.iac_violation or has.secret }} + run: + - action: require-reviewers@v1 + args: + reviewers: [my-organization/security-team] + - action: add-comment@v1 + args: + comment: | + This PR requires additional review because it fails to meet Orca Security safe code standards. + +orca: {{ pr | extractOrcaFindings }} + +has: + vulnerability: {{ orca.vulnerabilities.priority == 'High' or orca.vulnerabilities.priority == 'Medium' }} + iac_violation: {{ orca.infrastructure_as_code.priority == 'High' or orca.infrastructure_as_code.priority == 'Medium' }} + secret: {{ orca.secrets.priority == 'High' or orca.secrets.priority == 'Medium' }} \ No newline at end of file diff --git a/downloads/automation-library/integrations/rdoc/review_rdoc.cm b/downloads/automation-library/integrations/rdoc/review_rdoc.cm new file mode 100644 index 00000000..7b6f8d94 --- /dev/null +++ b/downloads/automation-library/integrations/rdoc/review_rdoc.cm @@ -0,0 +1,19 @@ +# -*- mode: yaml -*- +manifest: + version: 1.0 +automations: + review_rdoc: + if: + - {{ source.diff.files | match(attr='diff', regex=r/^[\s\t]*#.*/) | every }} + run: + - action: add-label@v1 + args: + label: "📓RDoc Only" + color: {{ colors.green }} + - action: add-reviewers@v1 + args: + reviewers: [org/tech-writers] + - action: approve@v1 + +colors: + green: '0e8a16' diff --git a/downloads/automation-library/integrations/rdoc/review_rdoc_input.cm b/downloads/automation-library/integrations/rdoc/review_rdoc_input.cm new file mode 100644 index 00000000..38d99930 --- /dev/null +++ b/downloads/automation-library/integrations/rdoc/review_rdoc_input.cm @@ -0,0 +1,14 @@ +# -*- mode: yaml -*- +manifest: + version: 1.0 +automations: + review_rdoc_input: + if: + - {{ source.diff.files | match(attr='diff', regex=r/(\#.*\n.*)*def/) | nope }} + - {{ source.diff.files | match(attr='diff', regex=r/def.*\(.*\)/ | some }} + run: + - action: add-comment@v1 + args: + comment: | + This PR modifies method input parameters, but is missing RDoc changes. Please check to ensure no RDoc changes are necessary. + diff --git a/downloads/automation-library/integrations/rdoc/review_rdoc_large.cm b/downloads/automation-library/integrations/rdoc/review_rdoc_large.cm new file mode 100644 index 00000000..88158cda --- /dev/null +++ b/downloads/automation-library/integrations/rdoc/review_rdoc_large.cm @@ -0,0 +1,31 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + #Require more extensive reviews for large Ruby changes that lack RDoc updates. + review_rdoc_large: + if: + - {{ changes.additions > 150}} + - {{ source.diff.files | matchDiffLines(regex=r/(\#.*\n.*)*def/) | nope }} + run: + - action: add-label@v1 + args: + label: "⚠️ Missing RDoc" + color: {{ colors.yellow }} + - action: add-comment@v1 + args: + comment: | + This PR makes major changes to Ruby methods, but is missing updates to RDoc. Please double check for any necessary RDoc updates. + - action: add-reviewers@v1 + args: + reviewers: [fourth-organization/tech-writers] + +changes: + # Sum all the lines added/edited in the PR + additions: {{ branch.diff.files_metadata | map(attr='additions') | sum }} + + +colors: + yellow: 'fbca04' diff --git a/downloads/automation-library/integrations/rdoc/review_rdoc_new_class.cm b/downloads/automation-library/integrations/rdoc/review_rdoc_new_class.cm new file mode 100644 index 00000000..5769e18b --- /dev/null +++ b/downloads/automation-library/integrations/rdoc/review_rdoc_new_class.cm @@ -0,0 +1,24 @@ +# -*- mode: yaml -*- +manifest: + version: 1.0 +automations: + review_rdoc_new_class: + if: + - {{ is.rb and is.new }} + - {{ source.diff.files | match(attr='diff', regex=r/(\#.*\n.*)*def/) | nope }} + run: + - action: add-label@v1 + args: + label: "⚠️ Missing RDoc" + color: {{ colors.yellow }} + - action: add-comment@v1 + args: + comment: | + RDoc is required for all Ruby classes. Please add documentation for this PR. + +is: + rb: {{ files | extensions | match(regex=r/rb/) | every }} + new: {{ source.diff.files | map(attr='original_file') | match(regex=r/^$/) | some }} + +colors: + yellow: 'fbca04' diff --git a/downloads/automation-library/integrations/renovate/approve_renovate.cm b/downloads/automation-library/integrations/renovate/approve_renovate.cm new file mode 100644 index 00000000..8668b096 --- /dev/null +++ b/downloads/automation-library/integrations/renovate/approve_renovate.cm @@ -0,0 +1,18 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + approve_renovate: + if: + - {{ branch.author | includes(term="renovate") }} + run: + - action: approve@v1 + - action: add-label@v1 + args: + label: "approved-renovate" + - action: merge@v1 + args: + wait_for_all_checks: true + squash_on_merge: true diff --git a/downloads/automation-library/integrations/renovate/approve_renovate_minor.cm b/downloads/automation-library/integrations/renovate/approve_renovate_minor.cm new file mode 100644 index 00000000..fdc92673 --- /dev/null +++ b/downloads/automation-library/integrations/renovate/approve_renovate_minor.cm @@ -0,0 +1,30 @@ +manifest: + version: 1.0 + +automations: + merge_renovate_minor: + if: + - {{ bump == 'minor' }} + - {{ branch.name | includes(term="renovate") }} + - {{ branch.author | includes(term="renovate") }} + run: + - action: approve@v1 + - action: add-comment@v1 + args: + comment: | + Renovate `minor` version bumps are approved automatically. + + merge_renovate_minor_patch: + if: + - {{ bump == 'patch' }} + - {{ branch.name | includes(term="renovate") }} + - {{ branch.author | includes(term="renovate") }} + run: + - action: approve@v1 + - action: merge@v1 + - action: add-comment@v1 + args: + comment: | + Renovate `patch` version bumps are approved and merged automatically. + +bump: {{ pr.description | extractRenovateVersionBump | compareMultiSemver }} diff --git a/downloads/automation-library/integrations/shortcut/label_missing_shortcut.cm b/downloads/automation-library/integrations/shortcut/label_missing_shortcut.cm new file mode 100644 index 00000000..2fa20a14 --- /dev/null +++ b/downloads/automation-library/integrations/shortcut/label_missing_shortcut.cm @@ -0,0 +1,25 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + label_missing_shortcut: + if: + - {{not (has.shortcut.ticket_in_title or has.shortcut.ticket_in_desc)}} + run: + - action: add-label@v1 + args: + label: "⚠️ Missing Shortcut Link" + color: {{ colors.red }} + - action: add-comment@v1 + args: + comment: Please provide a link to the associated Shortcut resource. + +has: + shortcut: + ticket_in_title: {{ pr.title | includes(regex=r/(\w+)\/sc-(\d+)/) }} + ticket_in_desc: {{ pr.description | includes(regex=r/(app\.shortcut\.com)\/(\w+)\/story\/(\d+)\/(\w+)/) }} + +colors: + red: 'b60205' \ No newline at end of file diff --git a/downloads/automation-library/integrations/shortcut/link_shortcut.cm b/downloads/automation-library/integrations/shortcut/link_shortcut.cm new file mode 100644 index 00000000..1e27cca4 --- /dev/null +++ b/downloads/automation-library/integrations/shortcut/link_shortcut.cm @@ -0,0 +1,39 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +# Configure these to match your organization. +provider: jira + +# Change this to match the name of your Shortcut organization. This is used in tracker.shortcut.baseurl +orgName: org + +{% set ticketid = "" %} +{% for ticket in tickets %} +{% if (ticket | includes(regex=r/.+/)) %} +{% set ticketid = ticket %} +{% endif %} +{% endfor %} + +automations: + link_shortcut: + if: + - {{ has.ticket_in_title or has.ticket_in_branch }} + run: + - action: add-comment@v1 + args: + comment: Issue Tracker Link - [{{ticketid}}]({{tracker[provider].baseurl}}{{ticketid}}) + +has: + ticket_in_title: {{ pr.title | includes(regex=tracker[provider].pattern) }} + ticket_in_branch: {{ branch.name | includes(regex=tracker[provider].pattern) }} + +tracker: + shortcut: + baseurl: https://app.shortcut.com/[orgName]/story/ + pattern: r/(\w+)\/sc-(\d+)/ + +tickets: + - {{branch.name | capture(regex=tracker[provider].pattern)}} + - {{pr.title | capture(regex=tracker[provider].pattern)}} diff --git a/downloads/automation-library/integrations/slack/slack_auto_recognition.cm b/downloads/automation-library/integrations/slack/slack_auto_recognition.cm new file mode 100644 index 00000000..2e6536bb --- /dev/null +++ b/downloads/automation-library/integrations/slack/slack_auto_recognition.cm @@ -0,0 +1,17 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + slack_auto_recognition: + if: + - {{ files | match(regex=r/(test|spec)/) | some }} # this pr has at least 1 test + - {{ files | length <= 5 }} # this pr has 5 or less files + - {{ branch.name | includes(regex=r/[A-Z]{2,}-\d+.*/) }} # this branch has the Jira ticket prefix + - {{ branch.diff.size <= 150 }} # this branch has 150 lines of code or less changed + run: + - action: send-slack-message@v1 + args: + webhook_url: "{{ env.SLACK_WEBHOOK }}" + message: ":tada: Congrats to {{ pr.author }} for the amazing new PR, '{{ pr.title }}'! Check it out at https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}" \ No newline at end of file diff --git a/downloads/automation-library/integrations/slack/slack_send_notification.cm b/downloads/automation-library/integrations/slack/slack_send_notification.cm new file mode 100644 index 00000000..113c0bd2 --- /dev/null +++ b/downloads/automation-library/integrations/slack/slack_send_notification.cm @@ -0,0 +1,33 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + send_slack_security: + # use your custom logic here to determine whether this needs a security review + if: + - true + run: + - action: send-slack-message@v1 + args: + webhook_url: "{{ env.SLACK_WEBHOOK_SECURITY }}" + message: "A PR requires a security review. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}" + send_slack_qa: + # use your custom logic here to determine whether this needs a qa review + if: + - {{ not (files | match(regex=r/(test|spec)/) | some) }} + run: + - action: send-slack-message@v1 + args: + webhook_url: "{{ env.SLACK_WEBHOOK_QA }}" + message: "A PR was submitted without tests. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}" + send_slack_docs: + # use your custom logic here to determine whether this needs a docs review + if: + - {{ files | match(regex=r/(docs)/) | some }} + run: + - action: send-slack-message@v1 + args: + webhook_url: "{{ env.SLACK_WEBHOOK_DOCS }}" + message: "A PR has modified the docs. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}" diff --git a/downloads/automation-library/integrations/snyk/approve-snyk/approve_snyk.cm b/downloads/automation-library/integrations/snyk/approve-snyk/approve_snyk.cm new file mode 100644 index 00000000..3ff5d1f8 --- /dev/null +++ b/downloads/automation-library/integrations/snyk/approve-snyk/approve_snyk.cm @@ -0,0 +1,18 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + approve_snyk: + if: + - {{ branch.author | includes(term="snyk") }} + run: + - action: approve@v1 + - action: add-label@v1 + args: + label: "approved-snyk" + - action: merge@v1 + args: + wait_for_all_checks: true + squash_on_merge: true diff --git a/downloads/automation-library/integrations/sonar/approve_sonar_clean_code.cm b/downloads/automation-library/integrations/sonar/approve_sonar_clean_code.cm new file mode 100644 index 00000000..72c8fe6d --- /dev/null +++ b/downloads/automation-library/integrations/sonar/approve_sonar_clean_code.cm @@ -0,0 +1,27 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 +automations: + approve_sonar_clean_code: + if: + - {{ sonar.bugs.rating == 'A' }} + - {{ sonar.code_smells.rating == 'A' }} + - {{ sonar.vulnerabilities.rating == 'A' }} + - {{ sonar.security_hotspots.rating == 'A' }} + - {{ sonar.duplications == null or sonar.duplications == 0 }} + run: + - action: add-label@v1 + args: + label: '✅ Sonar: Clean Code' + color: {{ colors.green }} + - action: approve@v1 + - action: add-comment@v1 + args: + comment: | + This PR passes the SonarCloud quality gate check and as been automatically approved. + +sonar: {{ pr | extractSonarFindings }} + +colors: + green: '0e8a16' \ No newline at end of file diff --git a/downloads/automation-library/integrations/sonar/label_sonar.cm b/downloads/automation-library/integrations/sonar/label_sonar.cm new file mode 100644 index 00000000..6110932d --- /dev/null +++ b/downloads/automation-library/integrations/sonar/label_sonar.cm @@ -0,0 +1,41 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + {% for item in reports %} + label_sonar_{{ item.name }}: + if: + - {{ item.count > 0}} + run: + - action: add-label@v1 + args: + label: '{{ item.icon }} sonar:{{ item.name }}-{{ item.rating }}' + color: {{ colors.red if (item.rating == 'E' or item.rating == 'D') else (colors.orange if (item.rating == 'C' ) else colors.yellow) }} + {% endfor %} + +sonar: {{ pr | extractSonarFindings }} + +reports: + - name: vulnerabilities + count: {{ sonar.vulnerabilities.count }} + icon: 🔓 + rating: {{ sonar.vulnerabilities.rating }} + - name: code smells + count: {{ sonar.code_smells.count }} + icon: ☣️ + rating: {{ sonar.code_smells.rating }} + - name: security hotspots + count: {{ sonar.security_hotspots.count }} + icon: 🛡️ + rating: {{ sonar.security_hotspots.rating }} + - name: bugs + count: {{ sonar.bugs.count }} + icon: 🪲 + rating: {{ sonar.bugs.rating }} + +colors: + red: 'b60205' + orange: 'd93f0b' + yellow: 'fbca04' diff --git a/downloads/automation-library/integrations/sonar/review_sonar_alerts.cm b/downloads/automation-library/integrations/sonar/review_sonar_alerts.cm new file mode 100644 index 00000000..25751f49 --- /dev/null +++ b/downloads/automation-library/integrations/sonar/review_sonar_alerts.cm @@ -0,0 +1,18 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 +automations: + review_sonar_alerts: + if: + - {{ sonar.code_smells.rating != 'A' or sonar.vulnerabilities.rating != 'A' or sonar.security_hotspots.rating != 'A'}} + run: + - action: require-reviewers@v1 + args: + reviewers: [my-organization/security-team] + - action: add-comment@v1 + args: + comment: | + This PR requires additional review because it fails to meet SonarCloud clean code standards. + +sonar: {{ pr | extractSonarFindings }} diff --git a/downloads/automation-library/integrations/sonar/review_sonar_duplications.cm b/downloads/automation-library/integrations/sonar/review_sonar_duplications.cm new file mode 100644 index 00000000..774c2daa --- /dev/null +++ b/downloads/automation-library/integrations/sonar/review_sonar_duplications.cm @@ -0,0 +1,22 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 +automations: + review_sonar_duplications: + if: + - {{ sonar.duplications > 3 }} + run: + - action: add-label@v1 + args: + label: 'Sonar: {{ sonar.duplications}}% duplication' + color: {{ colors.yellow }} + - action: request-changes@v1 + args: + comment: | + Sonar reports an excessive level of code duplication. Please consider refactoring your PR to reduce duplications. + +sonar: {{ pr | extractSonarFindings }} + +colors: + yellow: 'fbca04' \ No newline at end of file diff --git a/downloads/automation-library/integrations/swimm/approve_swimm.cm b/downloads/automation-library/integrations/swimm/approve_swimm.cm new file mode 100644 index 00000000..e37132f4 --- /dev/null +++ b/downloads/automation-library/integrations/swimm/approve_swimm.cm @@ -0,0 +1,21 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + approve_swimm_changes: + # Triggered for any changes to Swimm documentation + if: + - {{ branch.diff.files_metadata | match(attr='file', regex=r/\.swm\//) | every }} + # Apply a swimm-docs-only label, approve the PR and explain why in a comment. + run: + - action: add-label@v1 + args: + label: 'swimm-docs-only' + - action: approve@v1 + - action: add-comment@v1 + args: + comment: | + This PR is considered a safe change as it only affects Swimm Docs. + It has been automatically approved. diff --git a/downloads/automation-library/integrations/teams/teams_auto_recognition.cm b/downloads/automation-library/integrations/teams/teams_auto_recognition.cm new file mode 100644 index 00000000..2a6407e8 --- /dev/null +++ b/downloads/automation-library/integrations/teams/teams_auto_recognition.cm @@ -0,0 +1,19 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + teams_auto_recognition: + if: + - {{ files | match(regex=r/(test|spec)/) | some }} # this pr has at least 1 test + - {{ files | length <= 5 }} # this pr has 5 or less files + - {{ branch.name | includes(regex=r/[A-Z]{2,}-\d+.*/) }} # this branch has the Jira ticket prefix + - {{ branch.diff.size <= 150 }} # this branch has 150 lines of code or less changed + run: + - action: send-http-request@v1 + args: + method: "POST" + headers: '{"Content-type": "application/json"}' + url: "{{ env.MS_TEAMS_WEBHOOK }}" + body: '{"text": "Congrats to {{ pr.author }} for the amazing new PR, {{ pr.title }}! Check it out at https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"}' diff --git a/downloads/automation-library/integrations/teams/teams_send_notification.cm b/downloads/automation-library/integrations/teams/teams_send_notification.cm new file mode 100644 index 00000000..1f1c9eab --- /dev/null +++ b/downloads/automation-library/integrations/teams/teams_send_notification.cm @@ -0,0 +1,39 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + send_teams_security: + if: + # use your custom logic here to determine whether this needs a security review + - true + run: + - action: send-http-request@v1 + args: + method: "POST" + headers: '{"Content-type": "application/json"}' + url: "{{ env.MS_TEAMS_WEBHOOK_SECURITY }}" + body: '{"text": "A PR requires a security review. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"}' + send_teams_qa: + if: + # use your custom logic here to determine whether this needs a qa review + - {{ not (files | match(regex=r/(test|spec)/) | some) }} + run: + - action: send-http-request@v1 + args: + method: "POST" + headers: '{"Content-type": "application/json"}' + url: "{{ env.MS_TEAMS_WEBHOOK_QA }}" + body: '{"text": "A PR was submitted without tests. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"}' + send_teams_docs: + if: + # use your custom logic here to determine whether this needs a docs review + - {{ files | match(regex=r/(docs)/) | some }} + run: + - action: send-http-request@v1 + args: + method: "POST" + headers: '{"Content-type": "application/json"}' + url: "{{ env.MS_TEAMS_WEBHOOK_DOCS }}" + body: '{"text": "A PR has modified the docs. See https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}"}' diff --git a/downloads/automation-library/integrations/terraform/review_new_module.cm b/downloads/automation-library/integrations/terraform/review_new_module.cm new file mode 100644 index 00000000..7938610b --- /dev/null +++ b/downloads/automation-library/integrations/terraform/review_new_module.cm @@ -0,0 +1,44 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +{% set misslist = [] %} +{% for pattern in terraform %} +{% if (newfilesinpr | match(term=pattern) | nope) %} +{% set misslist = misslist + [pattern+' '] %} +{% endif %} +{% endfor %} + +automations: + review_new_terraform_module: + if: + - {{misslist | match(regex=r/.*/) | some}} + - {{is.mainfile and is.mainfilenotinroot }} + run: + - action: add-comment@v1 + args: + comment: | + New terraform modules must contain all required components before merging. Please update your PR with the required components and gitStream will automatically remove this comment once completed. + + Here are the required components, {{misslist}} should be customized appropriately: + my_module/ + ├── main.tf + ├── outputs.tf + ├── providers.tf + - action: add-label@v1 + args: + label: '⚠️ Missing Terraform Components' + color: '#FFA500' + +resources: + module_directory: 'modules' +terraform: + - main.tf + - outputs.tf + - providers.tf +is: + mainfile: {{newfilesinpr | match(term = "main.tf") | some}} + mainfilenotinroot: {{source.diff.files | map(attr='original_file') | match(term = "main.tf") | nope }} +newfilesinpr: + {{ branch.diff.files_metadata | map(attr='new_file')}} \ No newline at end of file diff --git a/downloads/automation-library/integrations/terraform/review_terraform.cm b/downloads/automation-library/integrations/terraform/review_terraform.cm new file mode 100644 index 00000000..ac735424 --- /dev/null +++ b/downloads/automation-library/integrations/terraform/review_terraform.cm @@ -0,0 +1,19 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + review_terraform: + # Triggered for any changes to Terraform files + if: + - {{ files | match(regex=r/.*\.tf.*/) | some }} + # Assign infrastructure team as reviewer for change in Terraform files + run: + - action: require-reviewers@v1 + args: + reviewers: [org/infrastructure] + - action: add-comment@v1 + args: + comment: | + This PR affects Terraform configurations and requires a review from the Infra team. diff --git a/downloads/automation-library/integrations/terraform/review_terraform_module_name.cm b/downloads/automation-library/integrations/terraform/review_terraform_module_name.cm new file mode 100644 index 00000000..7ea55bab --- /dev/null +++ b/downloads/automation-library/integrations/terraform/review_terraform_module_name.cm @@ -0,0 +1,42 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +# Prefix Check Logic +{% set prefixcheck = [] %} +{% for pattern in terraform.prefixes %} +{% if(newfilesinpr | match(term=module_location + pattern) | some) %} +{% set prefixcheck = prefixcheck + [true]%} +{% else %} +{% set prefixcheck = prefixcheck + [false] %} +{% endif %} +{% endfor %} + +automations: + review_new_terraform_module: + if: + - {{is.mainfile and is.mainfilenotinroot}} + - {{module_name_checks.prefix or module_name_checks.keyword}} + run: + - action: request-changes@v1 + args: + comment: | + Terraform module names must contain a required prefix and keyword: + * Prefixes: {{ terraform.prefixes }} + * Keywords: {{ terraform.keywords }} + +module_name_checks: + prefix: {{prefixcheck | match(term='true') | nope}} + keyword: {{newfilesinpr | match(list=terraform.keywords) | nope}} + +module_location: infrastructure/modules/ +terraform: + prefixes: ['aws', 'gcp', 'azure'] + keywords: ['db', 'networking', 'security'] + +is: + mainfile: {{newfilesinpr | match(term = "main.tf") | some}} + mainfilenotinroot: {{source.diff.files | map(attr='original_file') | match(term = "main.tf") | nope }} +newfilesinpr: + {{ branch.diff.files_metadata | map(attr='new_file')}} \ No newline at end of file diff --git a/downloads/automation-library/integrations/terraform/review_terraform_source_version.cm b/downloads/automation-library/integrations/terraform/review_terraform_source_version.cm new file mode 100644 index 00000000..54de0a0b --- /dev/null +++ b/downloads/automation-library/integrations/terraform/review_terraform_source_version.cm @@ -0,0 +1,22 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + review_terraform_source_version: + # Check if New Content contains a source URL, the URL is not part of allow list and lacks version reference + if: + - {{ source.diff.files | match(attr='new_content', regex=r/source.*?=.*\".*(http|https).*\"/) | some }} + - {{ source.diff.files | match(attr='new_content', list=allowlist) | nope }} + - {{ source.diff.files | match(attr='new_content', regex=r/source.*?=.*\?ref=v.*/) | nope }} + run: + - action: request-changes@v1 + args: + comment: | + You must reference a specific version when accessing Terraform module sources via URL, e.g. `?ref=v1.0.0`. Please update your Terraform files to follow this practice. + +allowlist: + - 'https://github.com/terraform-aws-modules/terraform-aws-s3-bucket.git' + - 'https://github.com/terraform-aws-modules/terraform-aws-vpc.git' + - 'https://github.com/terraform-aws-modules/terraform-aws-eks.git' \ No newline at end of file diff --git a/downloads/automation-library/integrations/unleash/label-ff-unleash/label_ff_unleash.cm b/downloads/automation-library/integrations/unleash/label-ff-unleash/label_ff_unleash.cm new file mode 100644 index 00000000..8f3a0de4 --- /dev/null +++ b/downloads/automation-library/integrations/unleash/label-ff-unleash/label_ff_unleash.cm @@ -0,0 +1,30 @@ +# -*- mode: yaml -*- +manifest: + version: 1.0 + +automations: + + {% for item in feature_flags %} + label_ff_unleash_{{ item.name }}: + if: + - {{ source.diff.files | matchDiffLines(regex=r/const notificationBadgeEnabled = useFlag/) | some }} + - {{ source.diff.files | matchDiffLines(regex=item.regex) | some }} + run: + - action: add-label@v1 + args: + label: {{ item.name }} + color: {{ colors.yellow }} + {% endfor %} + +feature_flags: + - name: engineering_rollback_plan_activated + regex: r/engineering_rollback_plan_activated/ + - name: marketing_premium_plan_features_unlocked + regex: r/marketing_premium_plan_features_unlocked/ + - name: mobile_push_notifications_enabled + regex: r/mobile_push_notifications_enabled/ + +colors: + yellow: 'ffb300' + + diff --git a/downloads/automation-library/integrations/zapier/zapier_export_pr_description_title_url.cm b/downloads/automation-library/integrations/zapier/zapier_export_pr_description_title_url.cm new file mode 100644 index 00000000..a62842e6 --- /dev/null +++ b/downloads/automation-library/integrations/zapier/zapier_export_pr_description_title_url.cm @@ -0,0 +1,21 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +pr_url: "https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}" + +on: + - pr_created + +automations: + zapier_export_pr_description_title_url: + if: + - true + run: + - action: send-http-request@v1 + args: + url: "{{ ZAPIER_WEBHOOK }}" + method: POST + headers: '{"Content-type": "application/json"}' + body: '{ "pr_description":"{{ pr.description }}", "pr_title":"{{ pr.title }}", "pr_url":"{{ pr_url }}" }' diff --git a/downloads/automation-library/integrations/zapier/zapier_export_pr_number.cm b/downloads/automation-library/integrations/zapier/zapier_export_pr_number.cm new file mode 100644 index 00000000..756b9341 --- /dev/null +++ b/downloads/automation-library/integrations/zapier/zapier_export_pr_number.cm @@ -0,0 +1,16 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + zapier_export_pr_number: + if: + - true + run: + - action: send-http-request@v1 + args: + url: "{{ ZAPIER_WEBHOOK }}" + method: POST + headers: '{"Content-type": "application/json"}' + body: '{ "pr_number":"{{ pr.number }}" }' \ No newline at end of file diff --git a/downloads/automation-library/integrations/zapier/zapier_export_pr_number_title_url.cm b/downloads/automation-library/integrations/zapier/zapier_export_pr_number_title_url.cm new file mode 100644 index 00000000..1c7236ce --- /dev/null +++ b/downloads/automation-library/integrations/zapier/zapier_export_pr_number_title_url.cm @@ -0,0 +1,21 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + + pr_url: "https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}" + +on: + - pr_created + +automations: + zapier_export_pr_number_title_url: + if: + - true + run: + - action: send-http-request@v1 + args: + url: "{{ ZAPIER_WEBHOOK }}" + method: POST + headers: '{"Content-type": "application/json"}' + body: '{ "pr_number":"{{ pr.number }}", "pr_title":"{{ pr.title }}", "pr_url":"{{ pr_url }}" }' diff --git a/downloads/automation-library/integrations/zapier/zapier_export_pr_reviewers.cm b/downloads/automation-library/integrations/zapier/zapier_export_pr_reviewers.cm new file mode 100644 index 00000000..89fdc7f4 --- /dev/null +++ b/downloads/automation-library/integrations/zapier/zapier_export_pr_reviewers.cm @@ -0,0 +1,18 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +pr_url: "https://github.com/{{ repo.owner }}/{{ repo.name }}/pull/{{ pr.number }}" + +automations: + zapier_export_pr_reviewers: + if: + - true + run: + - action: send-http-request@v1 + args: + url: "{{ env.ZAPIER_WEBHOOK }}" + method: "POST" + headers: '{"Content-type": "application/json"}' + body: '{ "reviewers": "{{ pr.reviewers }}" }' diff --git a/downloads/automation-library/label_deleted_files.cm b/downloads/automation-library/label_deleted_files.cm new file mode 100644 index 00000000..918300c2 --- /dev/null +++ b/downloads/automation-library/label_deleted_files.cm @@ -0,0 +1,19 @@ +# -*- mode: yaml -*- +manifest: + version: 1.0 + +automations: + # Apply a label that indicates when a PR deletes files + # This uses the `has` custom expression found at the bottom of this file + label_deleted_files: + if: + - {{ has.deleted_files }} + run: + - action: add-label@v1 + args: + label: 'deleted-files' + color: '#DF9C04' + +# This is used in the `label_deleted_files` automation +has: + deleted_files: {{ source.diff.files | map(attr='new_file') | match(term='/dev/null') | some }} diff --git a/downloads/automation-library/label_missing_project_tracker.cm b/downloads/automation-library/label_missing_project_tracker.cm new file mode 100644 index 00000000..59b3adad --- /dev/null +++ b/downloads/automation-library/label_missing_project_tracker.cm @@ -0,0 +1,33 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + label_missing_project_tracker: + if: + - {{not (has[provider].ticket_in_title or has[provider].ticket_in_desc)}} + run: + - action: add-label@v1 + args: + label: "⚠️ Missing Project Tracker" + color: 'F6443B' + - action: add-comment@v1 + args: + comment: Please provide a link to the associated resource in your team's project tracker. + +has: + jira: + ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }} + ticket_in_desc: {{ pr.description | includes(regex=r/atlassian.net\/browse\/\w{1,}-\d{3,4}/) }} + asana: + ticket_in_title: {{ pr.title | includes(regex=r/asana-(\d+)/) }} + ticket_in_desc: {{ pr.description | includes(regex=r/app\.asana.\com\/(\d+)\/(\d+)\/(\d+)\/(\d+)\/(\d+)/) }} + azure: + ticket_in_title: {{ pr.title | includes(regex=r/(\w+)-(\w+)-(\d+)/) }} + ticket_in_desc: {{ pr.description | includes(regex=r/(dev\.azure\.com|(\w+)\.visualstudio\.com)\/(\w+)\/(\w+)\/_workitems\/edit\/(\d+)/) }} + shortcut: + ticket_in_title: {{ pr.title | includes(regex=r/(\w+)\/sc-(\d+)/) }} + ticket_in_desc: {{ pr.description | includes(regex=r/(app\.shortcut\.com)\/(\w+)\/story\/(\d+)\/(\w+)/) }} + +provider: jira diff --git a/downloads/automation-library/label_prs_without_tests.cm b/downloads/automation-library/label_prs_without_tests.cm new file mode 100644 index 00000000..b6d86f03 --- /dev/null +++ b/downloads/automation-library/label_prs_without_tests.cm @@ -0,0 +1,14 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + label_prs_without_tests: + if: + - {{ files | match(regex=r/[^a-zA-Z0-9](spec|test|tests)[^a-zA-Z0-9]/) | nope }} + run: + - action: add-label@v1 + args: + label: 'missing-tests' + color: '#E94637' diff --git a/downloads/automation-library/languages/css/review_css_important.cm b/downloads/automation-library/languages/css/review_css_important.cm new file mode 100644 index 00000000..80689905 --- /dev/null +++ b/downloads/automation-library/languages/css/review_css_important.cm @@ -0,0 +1,23 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + review_css_important: + if: + - {{ files | extensions | match(term='css') | some }} + - {{ source.diff.files | matchDiffLines(regex=r/!important/) | some }} + run: + - action: add-label@v1 + args: + label: '⚠️ Includes !important tag' + color: '{{ colors.orange }}' + - action: request-changes@v1 + args: + comment: | + Please remove the `!important` tag from your CSS. + + +colors: + orange: 'd93f0b' diff --git a/downloads/automation-library/languages/golang/approve_golang_log_output.cm b/downloads/automation-library/languages/golang/approve_golang_log_output.cm new file mode 100644 index 00000000..b4fe371f --- /dev/null +++ b/downloads/automation-library/languages/golang/approve_golang_log_output.cm @@ -0,0 +1,20 @@ +# -*- mode: yaml -*- + +manifest: + version: 1.0 + +automations: + approve_golang_log_output: + # Triggered for Golang changes that only affect the console.log() method + if: + - {{ files | extensions | match(term='go') | every }} + - {{ source.diff.files | matchDiffLines(regex=r/^.*log\.Println/, ignoreWhiteSpaces=true) | every }} + run: + - action: add-label@v1 + args: + label: 'log-output-only' + - action: approve@v1 + - action: add-comment@v1 + args: + comment: | + This PR has been approved because it only contains changes to log output \ No newline at end of file diff --git a/downloads/automation-library/languages/golang/review_golang_test_name.cm b/downloads/automation-library/languages/golang/review_golang_test_name.cm new file mode 100644 index 00000000..7d666640 --- /dev/null +++ b/downloads/automation-library/languages/golang/review_golang_test_name.cm @@ -0,0 +1,14 @@ +# -*- mode: yaml -*- +manifest: + version: 1.0 + +automations: + review_golang_test_name: + if: + - {{ source.diff.files | matchDiffLines(regex=r/\*testing.T/) | some }} # Golang test files are created in a separate test directory, so this how we check if it is a test file. + - {{ source.diff.files | match(attr='new_file', regex=r/_test.go$/) | nope }} + run: + - action: request-changes@v1 + args: + comment: | + The test file name does not follow the Golang test name conventions. A test file name needs to have the suffix _test after class name. For example, if you are testing a class file called data.go then the test file name has to be data_test.go. diff --git a/downloads/automation-library/languages/golang/review_missing_golang_tests.cm b/downloads/automation-library/languages/golang/review_missing_golang_tests.cm new file mode 100644 index 00000000..5cdb67d7 --- /dev/null +++ b/downloads/automation-library/languages/golang/review_missing_golang_tests.cm @@ -0,0 +1,31 @@ +# -*- mode: yaml -*- +manifest: + version: 1.0 + +newFiles: {{ source.diff.files | filter(attr='new_file', regex=r/^(pkg|internal)\/(?!.*\_test\.go$).*\.go$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }} +newTests: {{ source.diff.files | filter(attr='new_file', regex=r/.*\_test\.go$/) | filter(attr='original_file', regex=r/^$/) | map(attr='new_file') }} + +newFilesCount: {{ source.diff.files | filter(attr='new_file', regex=r/^(pkg|internal)\/(?!.*\_test\.go$).*\.go$/) | filter(attr='original_file', regex=r/^$/) | length }} +newTestsCount: {{ source.diff.files | filter(attr='new_file', regex=r/.*\_test\.go$/) | filter(attr='original_file', regex=r/^$/) | length }} + +automations: + review_missing_golang_tests: + if: + - {{ newFilesCount != newTestsCount }} + run: + - action: add-label@v1 + args: + label: "⚠️ Missing Tests" + color: {{ colors.orange }} + - action: request-changes@v1 + args: + comment: | + Some of your new Golang files are missing corresponding tests. Please ensure that all new files have a corresponding test file. + + **New Files**: {{ newFilesCount }} + {{ newFiles }} + + **New Tests**: {{ newTestsCount }} + {{ newTests }} +colors: + orange: 'd93f0b' diff --git a/downloads/automation-library/languages/html/enforce_html_title_length.cm b/downloads/automation-library/languages/html/enforce_html_title_length.cm new file mode 100644 index 00000000..0cdc0b53 --- /dev/null +++ b/downloads/automation-library/languages/html/enforce_html_title_length.cm @@ -0,0 +1,13 @@ +# -*- mode: yaml -*- +manifest: + version: 1.0 + +automations: + enforce_html_title_length: + if: + - {{ source.diff.files | matchDiffLines(regex=r/(
How to Test Your Automation
By default, gitStream runs all applicable automations for every new PR and change to existing PR. If you want to test and experiment with new rules, gitStream supports a dry-run mode that will avoid making changes to your PRs. When you commit changes to any CM files found inside your repo's .cm/ directory, gitStream will switch to dry-run mode.
In dry-run mode, gitStream won't execute any automation rules on the PR. Instead, gitStream will parse all applicable automation rules and post a comment to the PR discussion that describes the actions that will be taken for normal PRs. A new comment will be added after every new commit.
Note
When in dry-run mode, incoming changes to the CM files are ignored. In other words, new automations and configurations won't take effect until you merge the PR.
Once you are satisfied with the results, you can merge your CM changes into the main branch to enable the new configurations.