Skip to content

Commit 317169e

Browse files
Roberto-VizcarraRoberto-Vizcarra
authored
Merge pull request #117 from jjsilva4/purple-docs-pass/round-2
Updates start here and integration pages 🟪
2 parents 34bc507 + b85c594 commit 317169e

File tree

4 files changed

+337
-150
lines changed

4 files changed

+337
-150
lines changed

‎gitlens/GL-GK-Account.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ When prompted with the login screen, select **Create an account** to begin. Choo
2929
- [Single Sign-On (SSO)](/gk-dev/gk-dev-single-sign-on/)
3030

3131
<figure>
32-
<img src="/wp-content/uploads/gk-dev-create-account.png" alt="GitKraken account creation screen with multiple login options" class="img-responsive center img-bordered">
32+
<img src="/wp-content/uploads/gk-dev-create-account.png" alt="GitKraken account creation screen with multiple login options" class="help-center-img center img-bordered">
3333
<figcaption style="text-align: center; color: #888">Select a login method to create your GitKraken account</figcaption>
3434
</figure>
3535

@@ -51,7 +51,7 @@ To change your avatar, click your profile picture. This will redirect you to [Gr
5151
> It may take several hours for avatar changes to appear in GitKraken.
5252
5353
<figure>
54-
<img src="/wp-content/uploads/gk-dev-account-personalization.png" srcset="/wp-content/uploads/gk-dev-account-personalization@2x.png" alt="GitKraken account personalization options" class="img-responsive center img-bordered">
54+
<img src="/wp-content/uploads/gk-dev-account-personalization.png" srcset="/wp-content/uploads/gk-dev-account-personalization@2x.png" alt="GitKraken account personalization options" class="help-center-img center img-bordered">
5555
<figcaption style="text-align: center; color: #888">Customize your name, email, avatar, and password</figcaption>
5656
</figure>
5757

‎gitlens/GL-Integrations.md

Lines changed: 133 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,182 @@
11
---
2-
3-
title: Gitlens Integrations
4-
description: Explore Gitlens Integrations
2+
title: GitLens Integrations
3+
description: Explore GitLens integrations with remote providers
54
taxonomy:
65
category: gitlens
6+
---
7+
8+
<kbd>Last updated: July 2025</kbd>
9+
10+
# GitLens Integrations
11+
12+
GitLens supports a wide range of remote providers to enhance your Git workflow inside Visual Studio Code. Supported platforms include:
13+
14+
- GitHub (including GitHub Enterprise)
15+
- GitLab
16+
- Gitea
17+
- Gerrit
18+
- Bitbucket (Cloud and Server)
19+
- Azure DevOps
20+
21+
You can also define [custom remote providers or providers with custom domains](/gitlens/settings/#remote-provider-integration-settings).
22+
23+
## Integration Capabilities
24+
25+
Basic integrations include:
26+
27+
- **Auto-linking** for issues and pull requests
28+
29+
Enhanced integrations (e.g., GitHub, GitLab) offer:
30+
31+
- **Launchpad support** to manage pull requests and workflows
32+
- **Rich hovers** showing issue and PR details
33+
- **Pull request associations** with branches and commits
34+
- **Avatars** for contributors and reviewers
35+
36+
These integrations also add contextual commands to open or copy URLs to files, commits, branches, and comparisons directly from your remote provider.
737

838
---
939

10-
GitLens provides rich integrations with many remote providers, including GitHub, GitHub Enterprise, GitLab, Gitea, Gerrit, Bitbucket, Bitbucket Server, and Azure DevOps. You can also define [custom remote providers](/gitlens/settings/#remote-provider-integration-settings) or [remote providers with custom domains](/gitlens/settings/#remote-provider-integration-settings) as well.
40+
## Remote Command Reference
41+
42+
You can use the following GitLens commands to interact with files, commits, and repositories on your remote platform.
43+
44+
### Files
45+
46+
- **Open File from Remote** (`gitlens.openFileFromRemote`) — Open a local file by specifying a remote file URL
47+
- **Open File on Remote** (`gitlens.openFileOnRemote`) — Open the current file or revision on the remote
48+
- **Copy Remote File URL** (`gitlens.copyRemoteFileUrlToClipboard`) — Copy the URL of the current file or revision
49+
- **Open File on Remote From...** (`gitlens.openFileOnRemoteFrom`) — Open a file/revision from a specific branch or tag
50+
- **Copy Remote File URL From...** (`gitlens.copyRemoteFileUrlFrom`) — Copy the file/revision URL from a specific branch or tag
1151

12-
Basic integrations provide issue and pull request auto-linking, while richer integrations (e.g. GitHub or GitLab) offer the ability to work with the Launchpad, can provide rich hover information provided for auto-linked issues and pull requests, associate pull requests with branches and commits, and provide avatars.
52+
### Commits
1353

14-
Additionally, these integrations provide commands to copy the url of or open, files, commits, branches, and the repository on the remote provider.
54+
- **Open Commit on Remote** (`gitlens.openCommitOnRemote`) — Open a commit on the remote
55+
- **Copy Remote Commit URL** (`gitlens.copyRemoteCommitUrl`) — Copy the URL of a commit
1556

16-
- Open _File from Remote_ command (`gitlens.openFileFromRemote`) — opens the local file from a url of a file on a remote provider
17-
- Open _File on Remote_ command (`gitlens.openFileOnRemote`) — opens a file or revision on the remote provider
18-
- Copy _Remote File Url_ command (`gitlens.copyRemoteFileUrlToClipboard`) — copies the url of a file or revision on the remote provider
19-
- Open _File on Remote From..._ command (`gitlens.openFileOnRemoteFrom`) — opens a file or revision on a specific branch or tag on the remote provider
20-
- Copy _Remote File Url From..._ command (`gitlens.copyRemoteFileUrlFrom`) — copies the url of a file or revision on a specific branch or tag the remote provider
21-
- Open _Commit on Remote_ command (`gitlens.openCommitOnRemote`) — opens a commit on the remote provider
22-
- Copy _Remote Commit Url_ command (`gitlens.copyRemoteCommitUrl`) — copies the url of a commit on the remote provider
23-
- Open _Branch on Remote_ command (`gitlens.openBranchOnRemote`) — opens the branch on the remote provider
24-
- Copy _Remote Branch Url_ command (`gitlens.copyRemoteBranchUrl`) — copies the url of a branch on the remote provider
25-
- Open _Branches on Remote_ command (`gitlens.openBranchesOnRemote`) — opens the branches on the remote provider
26-
- Copy _Remote Branches Url_ command (`gitlens.copyRemoteBranchesUrl`) — copies the url of the branches on the remote provider
27-
- Open _Comparison on Remote_ command (`gitlens.openComparisonOnRemote`) — opens the comparison on the remote provider
28-
- Copy _Remote Comparison Url_ command (`gitlens.copyRemoteComparisonUrl`) — copies the url of the comparison on the remote provider
29-
- Open _Pull Request_ command (`gitlens.openPullRequestOnRemote`) — opens the pull request on the remote provider
30-
- Copy _Pull Request Url_ command (`gitlens.copyRemotePullRequestUrl`) — copies the url of the pull request on the remote provider
31-
- Open _Repository on Remote_ command (`gitlens.openRepoOnRemote`) — opens the repository on the remote provider
32-
- Copy _Remote Repository Url_ command (`gitlens.copyRemoteRepositoryUrl`) — copies the url of the repository on the remote provider
57+
### Branches
3358

34-
### Connecting the GitHub and GitLab Integration
59+
- **Open Branch on Remote** (`gitlens.openBranchOnRemote`) — Open the current branch on the remote
60+
- **Copy Remote Branch URL** (`gitlens.copyRemoteBranchUrl`) — Copy the URL of the current branch
61+
- **Open Branches on Remote** (`gitlens.openBranchesOnRemote`) — Open the list of branches on the remote
62+
- **Copy Remote Branches URL** (`gitlens.copyRemoteBranchesUrl`) — Copy the URL for all branches
3563

36-
The GitHub and GitLab integration are connected via your GitKraken account from [gitkraken.dev](https://gitkraken.dev/settings/integrations?source=help_center&product=gitlens). To connect an integration, open the Command Palette (`command/ctrl+shift+P`) and type `GitLens: Manage Integrations`. You can also navigate to GitKraken Account in the GitLens Activity Bar and select `Integrations`.
64+
### Comparisons
3765

38-
<img src="/wp-content/uploads/gl-connect-remote-integration.png" srcset="/wp-content/uploads/gl-connect-remote-integration@2x.png" class="help-center-img img-bordered">
66+
- **Open Comparison on Remote** (`gitlens.openComparisonOnRemote`) — Open a diff comparison on the remote
67+
- **Copy Remote Comparison URL** (`gitlens.copyRemoteComparisonUrl`) — Copy the URL for the comparison
3968

40-
You will be prompted to log into your GitKraken account if you are not already. Then, select `Connect with GitHub` or `Connect with GitLab` and sign into the desired service. You will have the option to connect multiple integrations if needed. Finish the process by selecting `Complete Setup` to hop back into VS Code and begin working with the integrations.
69+
### Pull Requests
4170

42-
<img src="/wp-content/uploads/gl-connect-remote-integration-manager.png" class="help-center-img img-bordered">
71+
- **Open Pull Request on Remote** (`gitlens.openPullRequestOnRemote`) — Open the associated pull request
72+
- **Copy Pull Request URL** (`gitlens.copyRemotePullRequestUrl`) — Copy the pull request URL
73+
74+
### Repositories
75+
76+
- **Open Repository on Remote** (`gitlens.openRepoOnRemote`) — Open the entire repository in your browser
77+
- **Copy Remote Repository URL** (`gitlens.copyRemoteRepositoryUrl`) — Copy the repository URL for sharing or navigation
78+
79+
80+
### Connect GitHub or GitLab Integration
81+
82+
To connect GitHub or GitLab to GitLens, you'll use your GitKraken account via the [GitLens integrations dashboard](https://gitkraken.dev/settings/integrations?source=help_center&product=gitlens).
83+
84+
#### Steps to Connect:
85+
86+
1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) and run `GitLens: Manage Integrations`, **or**
87+
2. Go to the **GitKraken Account** section in the GitLens Activity Bar and choose **Integrations**.
88+
89+
<figure>
90+
<img src="/wp-content/uploads/gl-connect-remote-integration.png" srcset="/wp-content/uploads/gl-connect-remote-integration@2x.png" class="help-center-img img-bordered">
91+
<figcaption style="text-align:center; color:#888">Navigate to Integrations in the GitKraken Account menu</figcaption>
92+
</figure>
93+
94+
3. If you’re not already signed in, log into your GitKraken account.
95+
4. Click **Connect with GitHub** or **Connect with GitLab** and complete the sign-in process.
96+
5. Select **Complete Setup** to return to Visual Studio Code and activate the integration.
97+
98+
You can connect multiple integrations if needed.
99+
100+
<figure>
101+
<img src="/wp-content/uploads/gl-connect-remote-integration-manager.png" class="help-center-img img-bordered">
102+
<figcaption style="text-align:center; color:#888">Select the service you want to integrate and finish setup</figcaption>
103+
</figure>
43104

44105
<div class='callout callout--warning'>
45-
<p>Community users are limited to basic functionality only.</p>
106+
<p>Community users are limited to basic functionality only.</p>
46107
</div>
47108

48109
## GitHub Enterprise Server and GitLab Self-Managed Integration `PRO`
49110

50-
GitLens Pro offers a richer integration with GitHub Enterprise Server and GitLab Self-Managed.
51-
52-
Once authenticated, GitLens will enrich GitHub Enterprise Server or GitLab Self-Managed autolinks in the hovers. You’ll see your GitHub Enterprise Server or GitLab Self-Managed avatar, links to related pull requests, along with a footnote of the pull request or issue details. You’ll see similar details from the Sidebar views for any commit or branch associated with a pull request or issue.
111+
GitLens Pro supports advanced integration with GitHub Enterprise Server and GitLab Self-Managed.
53112

54-
<img src="/wp-content/uploads/gitlab-github-integration.png" class="help-center-img img-bordered">
113+
Once authenticated, GitLens enhances autolinks for these services in hover cards. You'll see:
55114

56-
### Connecting GitHub Enterprise Server or GitLab Self-Managed
115+
- User avatars
116+
- Links to related pull requests and issues
117+
- Pull request and issue details directly in the Sidebar views
57118

58-
To connect either the GitHub Enterprise Server or GitLab Self-Managed integration:
119+
<figure>
120+
<img src="/wp-content/uploads/gitlab-github-integration.png" class="help-center-img img-bordered">
121+
<figcaption style="text-align:center; color:#888">Enhanced hover cards with issue and PR metadata</figcaption>
122+
</figure>
59123

60-
- Open the `settings.json` - this can be done from the command palette (`command/ctrl + shift + P`) > _Preferences: Open User Settings (JSON)_
124+
### Connect GitHub Enterprise Server or GitLab Self-Managed
61125

62-
- Provide a _gitlens.remote_ with a _domain_ and a _type_ with the below format - for more information on the formatting see the [remote provider integration settings](/gitlens/settings/#remote-provider-integration-settings)
126+
To connect a self-hosted GitHub or GitLab instance:
63127

64-
Format Example:
128+
1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) and select **Preferences: Open User Settings (JSON)**
129+
2. In `settings.json`, add a `gitlens.remotes` entry with your domain and provider type:
65130

66-
```
131+
```json
67132
"gitlens.remotes": [{ "domain": "git.corporate-url.com", "type": "GitHub" }]
68133
```
69134

70-
Or
135+
Or for GitLab:
71136

72-
```
137+
```json
73138
"gitlens.remotes": [{ "domain": "git.corporate-url.com", "type": "GitLab" }]
74139
```
75140

76-
- Open a GitHub Enterprise Server or GitLab Self-Managed repository in VS Code
141+
3. Open the self-hosted repository in Visual Studio Code
142+
4. Open the [Remotes View](/gitlens/side-bar/#remotes-view)
143+
5. Click <i class="fa-solid fa-plug"></i> **Connect to Remote**
77144

78-
- Open the [Remotes View](/gitlens/side-bar/#remotes-view)
145+
<figure>
146+
<img src="/wp-content/uploads/gl-connect-to-remote-ghe.png" class="help-center-img img-bordered">
147+
<figcaption style="text-align:center; color:#888">Use the plug icon to connect a self-managed remote</figcaption>
148+
</figure>
79149

80-
- Select <i class="fa-solid fa-plug"></i> _Connect to Remote_ - if you do not see this option, check that the format of the settings.json matches the example above
150+
> If the **Connect to Remote** option doesn't appear, double-check that your JSON entry matches the example format.
81151
82-
<img src="/wp-content/uploads/gl-connect-to-remote-ghe.png" class="help-center-img img-bordered">
152+
6. When prompted, provide a Personal Access Token (PAT) with the required scopes and press **Enter** to complete setup
83153

84-
- You will then be prompted to provide a PAT with the required scopes and can hit _Enter_ to complete the integration connection
85154

86155
***
87156

88157
## Jira Integration `PRO`
89158

90-
The Jira Integration connected through your GitKraken Account gives you access to Jira [Autolinks](/gitlens/gitlens-features#autolinks) anywhere autolinks are supported in GitLens. Simply connect the integration and GitLens will automatically convert Jira IDs in commit messages to links i.e. `ABC-123`.
159+
GitLens Pro supports integration with Jira Cloud via your GitKraken Account. This allows GitLens to automatically link Jira issue keys (e.g., `ABC-123`) in commit messages and views wherever autolinks are supported.
91160

92-
<img src="/wp-content/uploads/gl-jira-integration.png" class="help-center-img img-bordered">
161+
<figure>
162+
<img src="/wp-content/uploads/gl-jira-integration.png" class="help-center-img img-bordered">
163+
<figcaption style="text-align:center; color:#888">Jira issues auto-linked in GitLens hovers and views</figcaption>
164+
</figure>
93165

94166
<div class='callout callout--warning'>
95-
<p>This Feature is only available for Pro subscription tiers or higher</p>
167+
<p>This feature is only available for Pro subscription tiers or higher.</p>
96168
</div>
97169

98-
To connect the integration, open the GitLens Sidebar, select `Cloud Integrations` from the GitKraken Account view, select Jira Cloud, and proceed with the integration connection by allowing GitKraken access to your Atlassian Account. You can also open [Integration Settings](gitkraken.dev/settings/integrations?source=help_center&product=gitlens) in a browser.
170+
### Connect the Jira Integration
171+
172+
1. Open the GitLens Sidebar and navigate to the **GitKraken Account** view.
173+
2. Select **Cloud Integrations**.
174+
3. Choose **Jira Cloud** and follow the prompts to connect.
175+
4. Allow GitKraken access to your Atlassian Account.
176+
177+
You can also configure this via the [Integration Settings](https://gitkraken.dev/settings/integrations?source=help_center&product=gitlens) in a browser.
99178

100-
<img src="/wp-content/uploads/gl-cloud-integrations.png" class="help-center-img img-bordered">
179+
<figure>
180+
<img src="/wp-content/uploads/gl-cloud-integrations.png" class="help-center-img img-bordered">
181+
<figcaption style="text-align:center; color:#888">Jira integration via GitLens Cloud Integrations panel</figcaption>
182+
</figure>

0 commit comments

Comments
 (0)