Skip to content

Commit 61e191b

Browse files
authored
Merge pull request #6 from gitkraken/Automations
Add Automations unlisted page to gkdev
2 parents 5af16b7 + 3f558f9 commit 61e191b

8 files changed

+140
-0
lines changed

_images/gkdev-createautomations.jpeg

153 KB
Loading

_images/gkdev-createautomations2.png

38.6 KB
Loading

_images/gkdev-createautomations3.png

92.5 KB
Loading

_images/gkdev-createautomations4.png

56.7 KB
Loading

_images/gkdev-createautomations5.png

48.3 KB
Loading

_images/gkdev-createautomations6.png

32.3 KB
Loading

_images/gkdev-createautomations7.png

62.3 KB
Loading

gk-dev/gk-dev-automations.md

+140
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
3+
title: Automations
4+
description: Automations makes it easier to manage your team’s workflows
5+
taxonomy:
6+
category: gk-dev-docs
7+
8+
---
9+
10+
GitKraken Automations makes it easier to manage your team’s workflows by codifying best practices, automating repetitive tasks, and proactively highlighting potential issues for you.
11+
12+
13+
14+
## Auotmation Examples
15+
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+
- Safe Deployments: Add a checklist for database migrations to ensure smooth rollouts.
18+
- Critical Code Reviews: Assign the right engineers to review high-impact areas of the codebase, such as a payment service.
19+
- Security Checks: Flag changes to sensitive areas like authentication and ensure a security review is completed.
20+
- Refactoring Guardrails: Prevent conflicting changes during refactors and follow up with post-refactor maintenance tasks.
21+
- SOC 2 Compliance: Automate checklists for encryption, security scans, and documentation to meet regulatory standards.
22+
- DevOps Enhancements: Simplify deployment pipelines, enforce pre-deployment quality checks, and manage infrastructure-as-code changes with Automation workflows tailored to your processes.
23+
24+
<div class='callout callout--warning'>
25+
<p>
26+
<strong>Note:</strong>
27+
Currently, Automations supports GitHub and GitLab repositories.
28+
</p>
29+
</div>
30+
31+
32+
## Get Started with Automations
33+
34+
To get started with Automations simply login to [gitkraken.dev](https://gitkraken.dev/automations/general) and select Automations on the left side menu. If this is your first automation you will be directed to our get started landing page, from here you can create a new automation or select a template from the suggestion list.
35+
36+
<img src="/wp-content/uploads/gkdev-createautomations.jpeg" class="help-center-img img-bordered">
37+
38+
39+
### Create a Automation
40+
41+
To create a Automation, select <button class="button button--success button--ui button--nolink">+ Create Automation</button>.
42+
43+
Then, create a name for your automation. Next, using the Provider drop down select either GitHub or GitLab as your hosting provider. And finally locate the repository you wish to apply the automation to in the Repository drop down. If you wish for the Automation to also apply to draft pull requests please select the checkbox.
44+
45+
<img src="/wp-content/uploads/gkdev-createautomations2.png" class="help-center-img img-bordered">
46+
47+
<div class='callout callout--warning'>
48+
<p>
49+
<strong>Note:</strong>
50+
A webhook will be set up on the selected repository in order to trigger when saving the automation.
51+
</p>
52+
</div>
53+
54+
55+
## Conditions
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"
58+
59+
<img src="/wp-content/uploads/gkdev-createautomations3.png" class="help-center-img img-bordered">
60+
61+
### Boolean logic
62+
63+
You can choose whether all or any of the conditions you set up apply to your Trigger:
64+
65+
<img src="/wp-content/uploads/gkdev-createautomations4.png" class="help-center-img img-bordered">
66+
67+
### File Location
68+
69+
The Following File Location trigger options can be selected:
70+
- File name condition: This condition matches the name of files in your repository.
71+
- File path condition: This condition matches the path of files in your repository.
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).
73+
74+
<div class='callout callout--warning'>
75+
<p>
76+
<strong>Note:</strong>
77+
A file path is different from a file name. For example: *src/app/index.ts* is a file path, while *index.ts* is a file name.
78+
</p>
79+
</div>
80+
81+
82+
### File Contents
83+
84+
The Following File Contet trigger options can be selected:
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+
- 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+
- New and Old Code condition: Matches both sides of the diff view
88+
89+
### Pull Request
90+
91+
The Following Pull Request trigger options can be selected:
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+
- PR Author condition: This condition matches the author of the pull request. This automation will only run if the author matches this condition.
94+
- Labels on the PR condition: This condition matches the GitHub Labels specified
95+
96+
97+
## Actions
98+
99+
Five kinds of actions are currently supported: posting a comment, adding a checklist item, assigning a pull request, and assigning a reviewer.
100+
101+
- Add Comment: When this action is executed, GitKraken will post the comment on the matching pull request
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.
106+
107+
<div class='callout callout--warning'>
108+
<p>
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.
111+
</p>
112+
</div>
113+
114+
115+
## Managing Saved Automations
116+
117+
After creating your first automation you will now see a list of all your saved automations on [GitKraken.dev](https://gitkraken.dev/automations/general). From this screen you can add additional automations, disable/enable, delete, sort, edit and duplicate your saved automations.
118+
119+
<img src="/wp-content/uploads/gkdev-createautomations5.png" class="help-center-img img-bordered">
120+
121+
122+
### Edit / Delete / Duplicate an Automation
123+
124+
Edit / Delete / Duplicate a Automation by selecting the ellipsis <i class="fas fa-ellipsis-v"></i> icon by the Automation name.
125+
126+
<img src="/wp-content/uploads/gkdev-createautomations6.png" class="help-center-img img-bordered">
127+
128+
129+
### Sort Automations
130+
131+
GitKraken Automations has two options for sorting, Status and Action. Status is if the Automation is Enabled or Disabled. Actions allows you to sort by the triggered action of your automation.
132+
133+
<img src="/wp-content/uploads/gkdev-createautomations7.png" class="help-center-img img-bordered">
134+
135+
136+
### Add Additional Automations
137+
138+
To create an additional Automation, select <button class="button button--success button--ui button--nolink">+ Create Automation</button>.
139+
140+

0 commit comments

Comments
 (0)