Skip to content

Commit 2cd9699

Browse files
authored
Merge pull request #187 from jkelroy/cloud-patch-updates
Updates Cloud Patch information
2 parents 53da7fd + 8f39572 commit 2cd9699

File tree

3 files changed

+25
-4
lines changed

3 files changed

+25
-4
lines changed

_images/gkc-apply-cloud-patch.gif

2.58 MB
Loading

_images/gkc-create-cloud-patch.png

54.5 KB
Loading

gitkraken-client/experimental-features.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,20 +111,41 @@ https://platform.openai.com/account/api-keys
111111

112112
### Cloud Patches
113113

114-
A Cloud Patch is a Git patch GitKraken securely stores for you so you can easily share changes with your team. The code is transferred directly from your machine into secure storage - this is managed by GitKraken. Currently, anybody with access to the Cloud Patch link can view the code and apply the patch to their repository.
114+
#### What are Cloud Patches and why would you want to use them
115+
116+
A Cloud Patch is a Git patch that GitKraken securely stores for you so it can be easily shared with others across GitKraken Client, GitLens, and the GitKraken CLI. The patch is directly transferred from your machine into secure storage.
117+
118+
Cloud Patches allow the ability to engage early with your team before a pull request. They can be created as soon as you have a work in progress. This can help with collaborating on changes prior to a pull request and minimize the delay of pull request reviews.
119+
120+
#### How to setup Cloud Patches
121+
122+
To enable Cloud Patches in GitKraken Client, check `Use Cloud Patches` under `Preferences > Experimental`. To disable Cloud Patches per client, simply uncheck this option.
123+
124+
#### How to work with Cloud Patches
115125

116126
To create a Cloud Patch, click the share icon <i class="fa-solid fa-share"></i> in the WIP commit panel and stage the changes you want to include in the Cloud Patch. You can also create a Cloud Patch from a commit by right-clicking on a commit in the Commit Graph and selecting `Share commit as Cloud Patch`. Once created, you can select `Copy Cloud Patch link` from the toast or by right-clicking a Cloud Patch in the left panel where all your Cloud Patches will be listed.
117127

118-
This link can be shared with users to open the Cloud Patch in GitKraken. When a Cloud Patch link is opened, the user will be prompted to open the client, clone or open the repository if not known to GitKraken Client, and then select the base branch to apply the patch to. From here, they can simply select `apply patch to <branch>`.
128+
<img src='/wp-content/uploads/gkc-create-cloud-patch.png' class='img-bordered img-responsive center'>
129+
130+
This link can be shared with users to open the Cloud Patch in GitKraken Client or GitLens. When a Cloud Patch link is opened, the user will be prompted to open the client, clone or open the repository if not known to GitKraken Client, and then select the base branch to apply the patch to. From here, they can simply select `apply patch to <branch>`.
119131

120-
<img src='/wp-content/uploads/gkc-apply-cloud-patch.png' class='img-bordered img-responsive center'>
132+
<img src='/wp-content/uploads/gkc-apply-cloud-patch.gif' class='img-bordered img-responsive center'>
121133

122134
To delete a cloud path, right-click it and select `Delete Cloud Patch`.
123135

124136
<img src="/wp-content/uploads/gkc-delete-cloud-patch.png" class="img-bordered img-responsive center">
125137

126-
When `Use Cloud Patches` is enabled, GitKraken will be able to create a Cloud Patch for you to share with other developers. To disable the ability to create a Cloud Patch, uncheck `Preferences > Experimental > Use Cloud Patches`.
138+
#### Known issues and workarounds
139+
140+
*What if I do not want GitKraken to host my Cloud Patches or have my Cloud Patch data stored on your servers?*
141+
142+
We offer the ability for you to host Cloud Patches on your own AWS S3 storage instances. In order to set this up, please reach out to our [support team](https://help.gitkraken.com/gitkraken-client/contact-support/) and include the following information about your bucket:
143+
144+
* Name of AWS bucket
145+
* AWS region the bucket is located in
127146

147+
Once we have that information, we will provide you with a bucket policy that can be attached to your bucket through the Permissions Bucket Policy Editor. After that is completed, Cloud Patches will be stored on your own bucket.
148+
128149
---
129150

130151
### New Commit Graph

0 commit comments

Comments
 (0)