You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: gk-dev/gk-dev-automations.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ GitKraken Automations makes it easier to manage your team’s workflows by codif
11
11
12
12
13
13
14
-
## Auotmation Examples
14
+
## Automation Examples
15
15
16
16
These are just a few ways teams are already using Automations to reduce manual effort, enforce best practice standards, and create more scalable, repeatable workflows.
17
17
- Safe Deployments: Add a checklist for database migrations to ensure smooth rollouts.
@@ -24,7 +24,7 @@ These are just a few ways teams are already using Automations to reduce manual e
24
24
<divclass='callout callout--warning'>
25
25
<p>
26
26
<strong>Note:</strong>
27
-
Currently, Automations supports GitHub and GitLab repositories.
27
+
Currently, Automations supports cloud integrations. Self-Hosted Integration Automations will be available at a later date.
28
28
</p>
29
29
</div>
30
30
@@ -47,26 +47,26 @@ Then, create a name for your automation. Next, using the Provider drop down sele
47
47
<divclass='callout callout--warning'>
48
48
<p>
49
49
<strong>Note:</strong>
50
-
A webhook will be set up on the selected repository in order to trigger when saving the automation.
50
+
A webhook will be set up on the selected repository after saving the automation. Permission will need to be granted on the repository to allow the creation of the webhook.
51
51
</p>
52
52
</div>
53
53
54
54
55
55
## Conditions
56
56
57
-
Next up, you will set up conditions, which are a list of criteria that determine when a Trigger should execute. We currently support 3 types of conditions: "File location", "File contents", and "Pull Request"
57
+
Next up, you will set up conditions, which are a list of criteria that determine when a Action should execute. We currently support 3 types of conditions: "File location", "File contents", and "Pull Request"
The Following File Location trigger options can be selected:
69
+
The Following File Location Action options can be selected:
70
70
- File name condition: This condition matches the name of files in your repository.
71
71
- File path condition: This condition matches the path of files in your repository.
72
72
- File added in folder condition: This condition matches when files are added to a specific folder in a pull request. For example, the filter "File added in folder" with the operator "folder path equals" with the value "src/components/icons" would match any file that was added in that icons folder (or subfolders).
@@ -81,14 +81,14 @@ The Following File Location trigger options can be selected:
81
81
82
82
### File Contents
83
83
84
-
The Following File Contet trigger options can be selected:
84
+
The Following File Contet Action options can be selected:
85
85
- Old Code condition: Matches against modified lines of code from before your code change: the red on the left-hand side of a split view diff.
86
86
- New Code condition: Matches against modified lines of code from after your code change: the green on the right-hand side of a split view diff.
87
87
- New and Old Code condition: Matches both sides of the diff view
88
88
89
89
### Pull Request
90
90
91
-
The Following Pull Request trigger options can be selected:
91
+
The Following Pull Request Action options can be selected:
92
92
- Number of changed files condition: This condition matches when the number of files that are part of this pull request satisfy the inequality.
93
93
- PR Author condition: This condition matches the author of the pull request. This automation will only run if the author matches this condition.
94
94
- Labels on the PR condition: This condition matches the GitHub Labels specified
@@ -100,14 +100,14 @@ Five kinds of actions are currently supported: posting a comment, adding a check
100
100
101
101
- Add Comment: When this action is executed, GitKraken will post the comment on the matching pull request
102
102
- Add to Checklist: When this action is executed, GitKraken will add a new checklist item to the PR description. You can add as many checklist items as you need by adding an action for each item.
103
-
- Add Assignee: When this action is executed, GitKraken will assign the pull request to the user of your choice. If you'd like to assign multiple users, you can create multiple instances of this action on the same Trigger. If you supply an optional message to explain why this user is being assigned, GitKraken will post a comment notifying that user and explaining why they were assigned.
104
-
- Add Label: When this action is executed, GitKraken will assign the selected GitHub label to the pull request. If you'd like to add multiple labels, you can create multiple instances of this action on the same Trigger.
105
-
- Add Reviewer: When this action is executed, GitKraken will assign the person or team of your choice as a reviewer on the PR. If you'd like to add multiple reviewers, you can create multiple instances of this action on the same Trigger. If you supply an optional message to explain why this user is being assigned as a reviewer, GitKraken will post a comment notifying that user and explaining why they were assigned as a reviewer.
103
+
- Add Assignee: When this action is executed, GitKraken will assign the pull request to the user of your choice. If you'd like to assign multiple users, you can create multiple instances of this on the same Action. If you supply an optional message to explain why this user is being assigned, GitKraken will post a comment notifying that user and explaining why they were assigned.
104
+
- Add Label: When this action is executed, GitKraken will assign the selected GitHub label to the pull request. If you'd like to add multiple labels, you can create multiple instances of this action on the same Action.
105
+
- Add Reviewer: When this action is executed, GitKraken will assign the person or team of your choice as a reviewer on the PR. If you'd like to add multiple reviewers, you can create multiple instances of this action on the same Action. If you supply an optional message to explain why this user is being assigned as a reviewer, GitKraken will post a comment notifying that user and explaining why they were assigned as a reviewer.
106
106
107
107
<divclass='callout callout--warning'>
108
108
<p>
109
109
<strong>Note:</strong>
110
-
A pull request can never have the author of the pull request as a reviewer. If an action would cause the author to be a reviewer on their own pull request, GitKraken will skip over that action, but still perform all other actions on the trigger.
110
+
A pull request can never have the author of the pull request as a reviewer. If an action would cause the author to be a reviewer on their own pull request, GitKraken will skip over that step, but still perform all other steps on the Action.
0 commit comments