Skip to content

Commit bf84c13

Browse files
Updates deep link documentation
1 parent c724272 commit bf84c13

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

docs/links.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Used to open a (remote) branch in GitLens. Once the branch's repository is opene
7878

7979
#### Format
8080

81-
_{prefix}/r/{repoId}/b/{branchName}?{baseQuery}(&action={action})_
81+
_{prefix}/r/{repoId}/b/{branchName}?{baseQuery}(&action={action})(&prId={prId})(&prTitle={prTitle})(&prBaseRef={prBaseRef})(&prHeadRef={prHeadRef})_
8282

8383
#### References
8484

@@ -93,6 +93,16 @@ _{prefix}/r/{repoId}/b/{branchName}?{baseQuery}(&action={action})_
9393

9494
- _switch-to-pr-worktree_: Does everything that the _switch-to-pr_ action does, but always chooses to open the branch in a worktree, creating a new one if needed and creating a new local branch if needed. For creating the local branch and worktree, default options are chosen. The worktree is then opened in a new window.
9595

96+
- _delete-branch_: Delete the branch after confirmation.
97+
98+
- _{prId}_ is an optional parameter representing the Pull Request ID when the branch is associated with a specific pull request.
99+
100+
- _{prTitle}_ is an optional parameter representing the Pull Request title when the branch is associated with a specific pull request.
101+
102+
- _{prBaseRef}_ is an optional parameter representing the base commit SHA of the Pull Request when the branch is associated with a specific pull request.
103+
104+
- _{prHeadRef}_ is an optional parameter representing the head commit SHA of the Pull Request when the branch is associated with a specific pull request.
105+
96106
#### Example Usage
97107

98108
Right click a branch in the Commit Graph and choose "Share -> Copy Link to Branch", select a remote to copy the branch for, and share with a teammate. When they access the link, GitLens will help them clone the repository, open it in GitLens, add the remote you linked, and open the Commit Graph to the branch, step-by-step.
@@ -141,14 +151,16 @@ Used to open a comparison between two references in the _Search & Compare_ view.
141151

142152
#### Format
143153

144-
_{prefix}/r/{repoId}/compare/{ref1}[..|...]{ref2}?{baseQuery}(&prRepoUrl={prRepoUrl})_
154+
_{prefix}/r/{repoId}/compare/{ref1}[..|...]{ref2}?{baseQuery}(&prRepoUrl={prRepoUrl})(&prId={prId})_
145155

146156
#### References
147157

148158
- _{ref1}_ and _{ref2}_ are the two refs to compare, in reverse order i.e. GitLens will compare _{ref2}_ to _{ref1}_ in the _Search & Compare_ view. These refs can be a branch name, tag name, or commit SHA. A blank ref means “working tree”. Both refs cannot be blank.
149159

150160
- _{prRepoUrl}_ is an optional parameter, generally used for Pull Request comparisons, representing the pull URL of the git remote that represents the head commit of the Pull Request. It is formatted similar to _{remoteUrl}_, so see Common References section above to learn how to format it.
151161

162+
- _{prId}_ is an optional parameter representing the Pull Request ID when the comparison is related to a specific pull request.
163+
152164
#### Example Usage
153165

154166
Share the changes of a pull request by right clicking the pull request's branch in the Commit Graph and choose "Compare with Common Base". The changes should be opened in the _Search & Compare_ view. Right click the Comparison item in the _Search & Compare_ view and choose "Share -> Copy Link to Comparison", and choose a remote to copy the comparison for. Share the link with a teammate. When they access the link, GitLens will help them clone the repository, open it in GitLens, add the remote, and open the _Search & Compare_ view to the pull request's changes, step-by-step.
@@ -310,6 +322,7 @@ _{prefix}/integrations/connect(&integration={integration})_
310322
- _bitbucket_ - Connects the Bitbucket integration.
311323
- _azuredevOps_ - Connects the Azure DevOps integration.
312324
- _jira_ - Connects the Jira integration.
325+
- _linear_ - Connects the Linear integration.
313326
- _trello_ - Connects the Trello integration.
314327
- _github-enterprise_ - Connects the GitHub Enterprise integration.
315328
- _gitlab-self-hosted_ - Connects the GitLab Self-Hosted integration.

0 commit comments

Comments
 (0)