Skip to content

Commit 37a2e2a

Browse files
authored
Merge pull request #123 from Axxzilla/experimental_features
Adding experimental features page
2 parents 9336ac6 + 166e5b9 commit 37a2e2a

File tree

2 files changed

+85
-0
lines changed

2 files changed

+85
-0
lines changed

_images/gkc-commit-message-ai-gen.gif

1.6 MB
Loading
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
3+
title: Experimental Features
4+
description: Learn about experimental features that are being worked on for possible future inclusion into GitKraken Client.
5+
taxonomy:
6+
category: gitkraken-client
7+
8+
---
9+
10+
Coming from the icy depths of the Git ocean are GitKraken Client experimental features! These are ideas we are trying out that are still being worked on, but we want to share with the world sooner.
11+
12+
---
13+
14+
## Experimental Features
15+
16+
Navigate to <i class="fas fa-cog"></i><kbd><strong>Preferences</strong> <i class='fa fa-caret-right'></i> <strong>Experimental</strong></i></kbd> to access the experimental features menu.
17+
18+
Experimental Features are still under development - treat these as an early sneak peek at some of the new functionality we're working on at GitKraken. Experimental features may not work as intended and could be changed or removed in the future. These settings are entirely optional and can be turned off at any time.
19+
20+
If you do experience issues, or have any other feedback, please reach out to us [Contact Support](https://help.gitkraken.com/gitkraken-client/contact-support/?issue_category__customer_facing_field_=Experimental+feedback&subject=GitKraken+Client+Experimental+feedback).
21+
22+
---
23+
24+
### Git Executable
25+
26+
When this setting is enabled, GitKraken Client will utilize the Git executable instead of the NodeGit library for certain Git actions including fetching and committing. This may provide increased performance and compatibility with certain projects and development environments. This is a partial implementation and will only affect some aspects of Git within GitKraken Client - the amount of Git commands using the Git executable will increase with each release.
27+
28+
**Use Git Executable:** <i class="fa-regular fa-square-check"></i> turn on this experimental feature! Check the box to immediately apply the setting.
29+
30+
**Git Executable:** We automatically include Git with GitKraken Client. You can select other from other versions that are installed on your system.
31+
32+
##### Features using the Git Executable
33+
34+
Find below a list of features using the Git binary if the Git Executable experimental setting is enabled. Anything not listed is still using LibGit2/NodeGit paths.
35+
36+
**Added in 9.4.0:**
37+
- refresh commits (some of the commit info displayed in the graph)
38+
- verify commit gpg signature
39+
- commit
40+
- fetch
41+
- branch ahead/behind count (e.g. from pull request panel)
42+
- merge base calculation (e.g. from right clicking a local branch in the left panel)
43+
- branch rename
44+
- branch delete (local branch only)
45+
46+
---
47+
48+
### AI Commit Message Generation
49+
50+
With this setting enabled, GitKraken Client will have the ability to generate commit messages from any staged changes. You can access this feature from the Command Palette (⌘P/Ctrl P, or the magic wand icon () in the toolbar), or you can click the sparkle icon () in the commit panel when you have staged changes.
51+
52+
<div class='callout callout--danger'>
53+
<p> This feature requires sending a diff of your code changes to OpenAI. Ensure your code does not contain sensitive information before generating a commit message.</p>
54+
</div>
55+
56+
**Generate Commit Messages with AI:** <i class="fa-regular fa-square-check"></i> turn on this experimental feature! Check the box to immediately enable the setting.
57+
58+
**OpenAI API Key:** Your key generated by OpenAI. GitKraken Client uses `gpt-3.5-turbo` model for generating commit messages.
59+
60+
**Prompt:** This is what is sent to OpenAI. We have it pre-filled to hopefully get Open AI on the right track. However, you can enter whatever you want here and it will be sent when you click ✨.
61+
62+
#### How to use in GKC
63+
64+
Once you have AI commit message generation enabled you will see ✨ sparkles ✨ in the commit message field. Stage your changes and click this button to get the AI magic started!
65+
66+
<img src='/wp-content/uploads/gkc-commit-message-ai-gen.gif' class='img-bordered img-responsive center'>
67+
68+
Once the commit message has been generated, you can still fully edit the message before committing. You can also click the ✨to have OpenAI try again.
69+
70+
<div class='callout callout--danger'>
71+
<p>Be aware that using OpenAI/chatGPT has a cost. At the time of this writing, the maximum cost per request is about $0.02. OpenAI offers free trial accounts with $5.00 of credit to get started.</p>
72+
</div>
73+
74+
---
75+
76+
#### More about OpenAI
77+
78+
Login or create an account:
79+
https://chat.openai.com/auth/login
80+
81+
OpenAI's overview and documentation pages to learn more about how it works:
82+
https://platform.openai.com/
83+
84+
To specifically generate an API key for GitKraken Client to use:
85+
https://platform.openai.com/account/api-keys

0 commit comments

Comments
 (0)