@ -20,6 +20,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
- Adds preview extensibility APIs
- Adds a preview _action runner_ extensibility point to provide a runner (handler) for a new _createPullRequest_ and _openPullRequest_ actions — see `gitlens.d.ts` for API definitions
- Preview APIs are only available in the Insiders edition
- Adds a `gitlens.integrations.enabled` setting to specify whether to enable rich integrations with any supported remote services — see [#1208](https://github.com/eamodio/vscode-gitlens/issues/1208)
- Adds a `gitlens.showWelcomeOnInstall` setting to specify whether to show the Welcome (Quick Setup) experience on first install — closes [#1049](https://github.com/eamodio/vscode-gitlens/issues/1049) thanks to [PR #1258](https://github.com/eamodio/vscode-gitlens/pull/1258) by Rickard ([@rickardp](https://github.com/rickardp))
GitLens provides rich integrations with many remote providers, including GitHub, GitHub Enterprise, GitLab, Bitbucket, Bitbucket Server, Azure DevOps. You can also define [custom remote providers](#custom-remotes-settings 'Jump to the Custom Remotes settings') or [remote providers with custom domains](#custom-remotes-settings 'Jump to the Custom Remotes settings') as well.
GitLens provides rich integrations with many remote providers, including GitHub, GitHub Enterprise, GitLab, Bitbucket, Bitbucket Server, 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.
@ -831,25 +831,20 @@ See also [View Settings](#view-settings- 'Jump to the View settings')
| `gitlens.views.contributors.pullRequests.enabled` | Specifies whether to query for pull requests associated with the current branch and commits in the _Contributors_ view. Requires a connection to a supported remote service (e.g. GitHub) |
| `gitlens.views.contributors.pullRequests.showForCommits` | Specifies whether to show pull requests (if any) associated with the current branch in the _Contributors_ view. Requires a connection to a supported remote service (e.g. GitHub) |
| `gitlens.views.compare.files.threshold` | Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Search Commits_ view<br/>Only applies when `gitlens.views.compare.files.layout` is set to `auto` |
| `gitlens.views.compare.avatars` | Specifies whether to show avatar images instead of commit (or status) icons in the _Compare_ view |
| `gitlens.views.compare.files.compact` | Specifies whether to compact (flatten) unnecessary file nesting in the _Compare_ view. Only applies when `gitlens.views.compare.files.layout` is set to `tree` or `auto` |
| `gitlens.views.compare.files.layout` | Specifies how the _Compare_ view will display files<br/><br/>`auto` - automatically switches between displaying files as a `tree` or `list` based on the `gitlens.views.compare.files.threshold` value and the number of files at each nesting level<br/>`list` - displays files as a list<br/>`tree` - displays files as a tree |
| `gitlens.views.compare.files.threshold` | Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Compare_ view. Only applies when `gitlens.views.compare.files.layout` is set to `auto` |
| `gitlens.views.search.avatars` | Specifies whether to show avatar images instead of commit (or status) icons in the _Search Commits_ view |
| `gitlens.views.search.files.compact` | Specifies whether to compact (flatten) unnecessary file nesting in the _Search Commits_ view<br/>Only applies when `gitlens.views.compare.files.layout` is set to `tree` or `auto` |
| `gitlens.views.search.files.layout` | Specifies how the _Search Commits_ view will display files<br/>`auto` - automatically switches between displaying files as a `tree` or `list` based on the `gitlens.views.compare.files.threshold` value and the number of files at each nesting level<br/>`list` - displays files as a list<br/>`tree` - displays files as a tree |
| `gitlens.views.compare.files.threshold` | Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Search Commits_ view<br/>Only applies when `gitlens.views.compare.files.layout` is set to `auto` |
See also [View Settings](#view-settings- 'Jump to the View settings')
| `gitlens.views.compare.avatars` | Specifies whether to show avatar images instead of commit (or status) icons in the _Compare_ view |
| `gitlens.views.compare.files.compact` | Specifies whether to compact (flatten) unnecessary file nesting in the _Compare_ view. Only applies when `gitlens.views.compare.files.layout` is set to `tree` or `auto` |
| `gitlens.views.compare.files.layout` | Specifies how the _Compare_ view will display files<br/><br/>`auto` - automatically switches between displaying files as a `tree` or `list` based on the `gitlens.views.compare.files.threshold` value and the number of files at each nesting level<br/>`list` - displays files as a list<br/>`tree` - displays files as a tree |
| `gitlens.views.compare.files.threshold` | Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Compare_ view. Only applies when `gitlens.views.compare.files.layout` is set to `auto` |
@ -895,6 +890,13 @@ See also [View Settings](#view-settings- 'Jump to the View settings')
| `gitlens.gitCommands.search.showResultsInSideBar` | Specifies whether to show the commit search results directly in the quick pick menu, in the Side Bar, or will be based on the context |
| `gitlens.gitCommands.skipConfirmations` | Specifies which (and when) Git commands will skip the confirmation step, using the format: `git-command-name:(menu/command)` |
## Date & Time Settings [#](#date--time-settings- 'Date & Time Settings')
| Name | Description |
@ -926,24 +928,17 @@ See also [View Settings](#view-settings- 'Jump to the View settings')
| `gitlens.mode.statusBar.alignment` | Specifies the active GitLens mode alignment in the status bar<br/><br/>`left` - aligns to the left<br/>`right` - aligns to the right |
| `gitlens.modes` | Specifies the user-defined GitLens modes<br/><br/>Example — adds heatmap annotations to the built-in _Reviewing_ mode<br/>`"gitlens.modes": { "review": { "annotations": "heatmap" } }`<br/><br/>Example — adds a new _Annotating_ mode with blame annotations<br/>`"gitlens.modes": {`<br/> `"annotate": {`<br/> `"name": "Annotating",`<br/> `"statusBarItemName": "Annotating",`<br/> `"description": "for root cause analysis",`<br/> `"annotations": "blame",`<br/> `"codeLens": false,`<br/> `"currentLine": false,`<br/> `"hovers": true`<br/> `}`<br/>`}` |
| `gitlens.autolinks` | Specifies autolinks to external resources in commit messages. Use `<num>` as the variable for the reference number<br/><br/>Example to autolink Jira issues: (e.g. `JIRA-123 ⟶ https://jira.company.com/issue?query=123`)<br/>`"gitlens.autolinks": [{ "prefix": "JIRA-", "url": "https://jira.company.com/issue?query=<num>" }]` |
| `gitlens.defaultGravatarsStyle` | Specifies the style of the gravatar default (fallback) images<br/><br/>`identicon` - a geometric pattern<br/>`mm` - a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)<br/>`monsterid` - a monster with different colors, faces, etc<br/>`retro` - 8-bit arcade-style pixelated faces<br/>`robohash` - a robot with different colors, faces, etc<br/>`wavatar` - a face with differing features and backgrounds |
| `gitlens.insiders` | Specifies whether to enable experimental features |
| `gitlens.liveshare.allowGuestAccess` | Specifies whether to allow guest access to GitLens features when using Visual Studio Live Share |
| `gitlens.outputLevel` | Specifies how much (if any) output will be sent to the GitLens output channel |
| `gitlens.showWelcomeOnInstall` | Specifies whether to show the Welcome (Quick Setup) experience on first install |
@ -979,10 +974,6 @@ GitLens defines a set of themable colors which can be provided by vscode themes
| `gitlens.lineHighlightBackgroundColor` | Specifies the background color of the associated line highlights in blame annotations |
| `gitlens.lineHighlightOverviewRulerColor` | Specifies the overview ruler color of the associated line highlights in blame annotations |
## Insiders
Add [`"gitlens.insiders": true`](#misc-settings- 'Jump to Misc settings') to your settings to join the insiders channel and get early access to upcoming features. Be aware that because this provides early access expect there to be issues.
# Contributors 🙏❤
A big thanks to the people that have contributed to this project:
"deprecationMessage":"Deprecated. Use the Insiders edition of GitLens instead",
"markdownDeprecationMessage":"Deprecated. Use the [Insiders edition](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens-insiders) of GitLens instead"
},
"gitlens.integrations.enabled":{
"type":"boolean",
"default":false,
"markdownDescription":"Specifies whether to enable experimental features",
"default":true,
"markdownDescription":"Specifies whether to enable rich integrations with any supported remote services",
commands+=`[$(git-pull-request) PR $(sync~spin)](command:${Commands.RefreshHover} "Searching for a Pull Request (if any) that introduced this commit...")${separator}`;
Eric Amodio
4 lat temu