@ -58,7 +58,7 @@ Here are just some of the **features** that GitLens provides,
- [status ](#quick-status-access- 'Jump to Quick Status Access' ) — current branch and working tree status
- a user-friendly [**interactive rebase editor** ](#interactive-rebase-editor- 'Jump to the Interactive Rebase Editor' ) to easily configure an interactive rebase session
- [**terminal links** ](#terminal-links- 'Jump to Terminal Links' ) — `ctrl+click` on autolinks in the integrated terminal to quickly jump to more details for commits, branches, tags, and more
- rich [**remote provider integrations** ](#remote-provider-integrations- 'Jump to Remote Provider Integrations' ) — GitHub, GitLab, Gitea, Gerrit, Bitbucket, Azure DevOps
- rich [**remote provider integrations** ](#remote-provider-integrations- 'Jump to Remote Provider Integrations' ) — GitHub, GitLab, Gitea, Gerrit, GoogleSource, Bitbucket, Azure DevOps
- issue and pull request auto-linking
- rich hover information provided for linked issues and pull requests (GitHub only)
- associates pull requests with branches and commits (GitHub only)
@ -186,7 +186,7 @@ Worktrees allow you to easily work on different branches of a repository simulta
< / p >
- Adds a **details hover** annotation to the current line to show more commit details ([optional](#hover-settings- 'Jump to the Hover settings'), on by default)
- Provides **automatic issue linking** to Bitbucket, Gerrit, Gitea, GitHub, GitLab, and Azure DevOps in commit messages
- Provides **automatic issue linking** to Bitbucket, Gerrit, GoogleSource, G itea, GitHub, GitLab, and Azure DevOps in commit messages
- Provides a **quick-access command bar** with _Open Changes_ , _Blame Previous Revision_ , _Open on Remote_ , _Invite to Live Share_ (if available), and _Show More Actions_ command buttons
- Click the commit SHA to execute the _Show Commit_ command
@ -215,7 +215,7 @@ Worktrees allow you to easily work on different branches of a repository simulta
< / p >
- Adds a **details hover** annotation to each line while annotating to show more commit details ([optional](#hover-settings- 'Jump to the Hover settings'), on by default)
- Provides **automatic issue linking** to Bitbucket, Gerrit, Gitea, GitHub, GitLab, and Azure DevOps in commit messages
- Provides **automatic issue linking** to Bitbucket, Gerrit, GoogleSource, G itea, GitHub, GitLab, and Azure DevOps in commit messages
- Provides a **quick-access command bar** with _Open Changes_ , _Blame Previous Revision_ , _Open on Remote_ , _Invite to Live Share_ (if available), and _Show More Actions_ command buttons
- Click the commit SHA to execute the _Show Commit_ command
@ -614,7 +614,7 @@ The _Search & Compare_ view lists pinnable (saved) results for searching commit
## Remote Provider Integrations [# ](#remote-provider-integrations- 'Remote Provider Integrations' )
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 ](#remote-provider-integration-settings- 'Jump to the Remote Provider Integration settings' ) or [remote providers with custom domains ](#remote-provider-integration-settings- 'Jump to the Remote Provider Integration settings' ) as well.
GitLens provides rich integrations with many remote providers, including GitHub, GitHub Enterprise, GitLab, Gitea, Gerrit, GoogleSource, Bitbucket, Bitbucket Server, and Azure DevOps. You can also define [custom remote providers ](#remote-provider-integration-settings- 'Jump to the Remote Provider Integration settings' ) or [remote providers with custom domains ](#remote-provider-integration-settings- 'Jump to the Remote Provider Integration settings' ) as well.
Basic integrations provide issue and pull request auto-linking, while richer integrations (e.g. GitHub) can provide rich hover information provided for auto-linked issues and pull requests, associate pull requests with branches and commits, and provide avatars.
@ -996,10 +996,10 @@ See also [View Settings](#view-settings- 'Jump to the View settings')
## Remote Provider Integration Settings [# ](#remote-provider-integration-settings- 'Remote Provider Integration Settings' )
| Name | Description |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `gitlens.integrations.enabled` | Specifies whether to enable rich integrations with any supported remote services |
| `gitlens.remotes` | Specifies custom remote services to be matched with Git remotes to detect custom domains for built-in remote services or provide support for custom remote services< br />< br /> Supported Types (e.g. `"type": "GitHub"` ):< ul >< li > "GitHub"</ li >< li > "GitLab"</ li >< li > "Gerrit"</ li >< li > "Gitea"</ li >< li > "AzureDevOps"</ li >< li > "Bitbucket"</ li >< li > "BitbucketServer"</ li >< li > "Custom"</ li ></ ul > Example:< br /> `"gitlens.remotes": [{ "domain": "git.corporate-url.com", "type": "GitHub" }]`< br />< br /> Example:< br /> `"gitlens.remotes": [{ "regex": "ssh:\/\/(my\.company\.com):1234\/git\/(.+)", "type": "GitHub" }]`< br />< br /> Example:< br /> `"gitlens.remotes": [{`< br /> `"domain": "git.corporate-url.com",`< br /> `"type": "Custom",`< br /> `"name": "My Company",`< br /> `"protocol": "https",`< br /> `"urls": {`< br /> `"repository": "https://git.corporate-url.com/${repo}",`< br /> `"branches": "https://git.corporate-url.com/${repo}/branches",`< br /> `"branch": "https://git.corporate-url.com/${repo}/commits/${branch}",`< br /> `"commit": "https://git.corporate-url.com/${repo}/commit/${id}",`< br /> `"file": "https://git.corporate-url.com/${repo}?path=${file}${line}",`< br /> `"fileInBranch": "https://git.corporate-url.com/${repo}/blob/${branch}/${file}${line}",`< br /> `"fileInCommit": "https://git.corporate-url.com/${repo}/blob/${id}/${file}${line}",`< br /> `"fileLine": "#L${line}",`< br /> `"fileRange": "#L${start}-L${end}"`< br /> `}`< br /> `}]`< br />< br /> Example:< br /> `"gitlens.remotes": [{`< br /> `"regex": "ssh:\\/\\/(my\\.company\\.com):1234\\/git\\/(.+)",`< br /> `"type": "Custom",`< br /> `"name": "My Company",`< br /> `"protocol": "https",`< br /> `"urls": {`< br /> `"repository": "https://my.company.com/projects/${repoBase}/repos/${repoPath}",`< br /> `"branches": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/branches",`< br /> `"branch": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/commits/${branch}",`< br /> `"commit": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/commit/${id}",`< br /> `"file": "https://my.company.com/projects/${repoBase}/repos/${repoPath}?path=${file}${line}",`< br /> `"fileInBranch": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/blob/${branch}/${file}${line}",`< br /> `"fileInCommit": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/blob/${id}/${file}${line}",`< br /> `"fileLine": "#L${line}",`< br /> `"fileRange": "#L${start}-L${end}"`< br /> `}`< br /> `}]` |
| Name | Description |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `gitlens.integrations.enabled` | Specifies whether to enable rich integrations with any supported remote services |
| `gitlens.remotes` | Specifies custom remote services to be matched with Git remotes to detect custom domains for built-in remote services or provide support for custom remote services< br />< br /> Supported Types (e.g. `"type": "GitHub"` ):< ul >< li > "GitHub"</ li >< li > "GitLab"</ li >< li > "Gerrit"</ li >< li > "GoogleSource"</ li >< li > "G itea"</ li >< li > "AzureDevOps"</ li >< li > "Bitbucket"</ li >< li > "BitbucketServer"</ li >< li > "Custom"</ li ></ ul > Example:< br /> `"gitlens.remotes": [{ "domain": "git.corporate-url.com", "type": "GitHub" }]`< br />< br /> Example:< br /> `"gitlens.remotes": [{ "regex": "ssh:\/\/(my\.company\.com):1234\/git\/(.+)", "type": "GitHub" }]`< br />< br /> Example:< br /> `"gitlens.remotes": [{`< br /> `"domain": "git.corporate-url.com",`< br /> `"type": "Custom",`< br /> `"name": "My Company",`< br /> `"protocol": "https",`< br /> `"urls": {`< br /> `"repository": "https://git.corporate-url.com/${repo}",`< br /> `"branches": "https://git.corporate-url.com/${repo}/branches",`< br /> `"branch": "https://git.corporate-url.com/${repo}/commits/${branch}",`< br /> `"commit": "https://git.corporate-url.com/${repo}/commit/${id}",`< br /> `"file": "https://git.corporate-url.com/${repo}?path=${file}${line}",`< br /> `"fileInBranch": "https://git.corporate-url.com/${repo}/blob/${branch}/${file}${line}",`< br /> `"fileInCommit": "https://git.corporate-url.com/${repo}/blob/${id}/${file}${line}",`< br /> `"fileLine": "#L${line}",`< br /> `"fileRange": "#L${start}-L${end}"`< br /> `}`< br /> `}]`< br />< br /> Example:< br /> `"gitlens.remotes": [{`< br /> `"regex": "ssh:\\/\\/(my\\.company\\.com):1234\\/git\\/(.+)",`< br /> `"type": "Custom",`< br /> `"name": "My Company",`< br /> `"protocol": "https",`< br /> `"urls": {`< br /> `"repository": "https://my.company.com/projects/${repoBase}/repos/${repoPath}",`< br /> `"branches": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/branches",`< br /> `"branch": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/commits/${branch}",`< br /> `"commit": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/commit/${id}",`< br /> `"file": "https://my.company.com/projects/${repoBase}/repos/${repoPath}?path=${file}${line}",`< br /> `"fileInBranch": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/blob/${branch}/${file}${line}",`< br /> `"fileInCommit": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/blob/${id}/${file}${line}",`< br /> `"fileLine": "#L${line}",`< br /> `"fileRange": "#L${start}-L${end}"`< br /> `}`< br /> `}]` |
## Date & Time Settings [# ](#date--time-settings- 'Date & Time Settings' )