diff --git a/gitlens/GL-New-Page-Template.md b/gitlens/GL-New-Page-Template.md new file mode 100644 index 0000000..86f4f34 --- /dev/null +++ b/gitlens/GL-New-Page-Template.md @@ -0,0 +1,9 @@ +--- + +title: New Page Title +description: New Page Description +taxonomy: + category: gitlens + +--- + diff --git a/gitlens/gitlens-community-vs-gitlens-pro.md b/gitlens/gitlens-community-vs-gitlens-pro.md index d9f4921..72e15e1 100644 --- a/gitlens/gitlens-community-vs-gitlens-pro.md +++ b/gitlens/gitlens-community-vs-gitlens-pro.md @@ -34,10 +34,9 @@ GitLens Pro takes your workflow to the next level by unlocking advanced features ### Making Your Choice Both GitLens Community and Pro provide valuable tools to support your Git workflows. The Community edition is an excellent choice if you're looking for a powerful free VS Code Git management tool. If your work involves PR reviews, collaborative workflows, and advanced Git actions, upgrading to GitLens Pro will unlock new features and workflows to increase your developer productivity. +_Both editions are backed by our commitment to enhancing your development experience. Start with Community and upgrade to Pro when you need additional horsepower for your workflows._ - -_Both editions are backed by our commitment to enhancing your development experience. Start with Community and upgrade to Pro when you need additional horsepower for your workflows._ **_Choose Community if you want:_** @@ -47,12 +46,14 @@ _Both editions are backed by our commitment to enhancing your development experi **_Upgrade to Pro if you need:_** +* _AI-powered automation for Git workflows_ * _Streamlined PR review workflows_ * _Advanced Git operations and visualization_ * _Cross-platform integration capabilities_ * _Team collaboration features_ * _Enhanced productivity tools for professional development_ + ### Get Started with GitLens Pro Today Try GitLens Pro for free diff --git a/gitlens/gitlens-features.md b/gitlens/gitlens-features.md index f7facc2..521b58a 100644 --- a/gitlens/gitlens-features.md +++ b/gitlens/gitlens-features.md @@ -7,8 +7,8 @@ taxonomy: --- -Features marked with `PRO` require a [trial or paid plan](https://www.gitkraken.com/gitlens/pricing) for use on privately hosted repos -Features marked with `PREVIEW` require a GitKraken Account, with access level based on your [plan](https://www.gitkraken.com/gitlens/pricing), e.g. Community, Pro, etc +Features marked with `PRO` require a [trial or paid plan](https://www.gitkraken.com/gitlens/pricing?source=help_center&product=gitlens) for use on privately hosted repos +Features marked with `PREVIEW` require a GitKraken Account, with access level based on your [plan](https://www.gitkraken.com/gitlens/pricing?source=help_center&product=gitlens), e.g. Community, Pro, etc *** @@ -273,7 +273,7 @@ At the top of the commit graph the repository name, the branch name that is curr
-

Note: The Commit Graph is available to all users working on public repositories, and requires no account. Additionally, users with a paid GitLens subscription or trial can use the Commit Graph with private repos.

+

Note: The Commit Graph is available to all users working on public or local repositories, and requires no account. Additionally, users with a paid GitLens subscription or trial can use the Commit Graph with private repos.

We’d love to hear your feedback in the Commit Graph discussion on GitHub.

@@ -411,10 +411,13 @@ You can pin pull requests using the pin icon

Note: The Launchpad is currently organized by prioritizing items on the list that require more action by elevating them to the top. This is subject to change in the future.

+
+

This Feature is only available for Pro subscription tiers or higher

+
*** -## Visual File History `PRO` +## Visual File History The Visual File History allows you to quickly see the evolution of a file, including when changes were made, how large they were, and who made them. @@ -431,21 +434,57 @@ Gain additional insights on hover. +
+

Community plan is restricted to Public and Local Repositories only.

+
+ *** -## AI-Generated Commit Messages (Preview) `PRO` +## Gitkraken AI +### AI-Generated Commit Messages -Commit messages can be automatically generated using an AI Provider. +Commit messages can be automatically generated using Gitkraken AI. -To connect an AI Provider, stage some changes you want to generate a commit message for and then run the `GitLens: Generate Commit Message (Experimental)` command from the Command Palette (`command/ctrl + shift + P`). From there you will be guided through the process of accepting to send the diff of your staged changes to the AI Provider and the entry of your AI Provider key. The API key can be created from your AI Provider's site. Once completed, the generated commit message will be entered into the commit input box on the Source Control sidebar. You can also enter additional context about your changes in the commit box and those will also be sent to help generate a better message. Additionally, you can customize the `gitlens.experimental.generateCommitMessagePrompt` setting to control the prompt used to structure and format the generated commit message. There are additional `gitlens.ai` settings that can be [customized](/gitlens/gitlens-settings/#misc-settings) for the provider and model. +To generate a commit message, stage the changes you want, then navigate to Home View and tap the "Generate Commit Message" button to generate a precise, descriptive commit messages based on your changes, or run the `GitLens: Generate Commit Message (Experimental)` command from the Command Palette (`command/ctrl + shift + P`). From there you will be guided through the process of accepting to send the diff of your staged changes to Gitkraken AI. Once completed, the generated commit message will be entered into the commit input box on the Source Control sidebar. You can also enter additional context about your changes in the commit box and those will also be sent to help generate a better message. Additionally, you can customize the `gitlens.experimental.generateCommitMessagePrompt` setting to control the prompt used to structure and format the generated commit message. There are additional `gitlens.ai` settings that can be [customized](/gitlens/gitlens-settings/#misc-settings) for the provider and model. + +
+

Gitlens Pro users and above can also choose to provide their own API key in order to use a different AI provider. Gitkraken AI utilizes the Gemini 2.0 Flash model.

+
+ +### AI Stash Messages `Pro` +*Available in:* Pro, Advanced, and Business plans +Create intelligent descriptions for stashed changes, making it easier to find and understand your work later. This feature generates context-rich stash descriptions that help you quickly identify the purpose of each stash. +*How to access:* +- From the Command Palette: `GitLens: Generate Stash Message with AI` +- When creating a stash: Look for the AI option in the stash creation interface +- From the stash view: Generate descriptions for existing stashes + +### AI Commit Explanations`Pro` +*Available in:* Pro, Advanced, and Business plans +Understand the reasoning behind changes with AI-generated explanations of commit content and purpose. Quickly grasp the intent and impact of complex commits without having to manually review all changed files. + +*How to access:* +- In the "Commit Details" view: Find the AI explanation panel +- In the "Cloud Patch Details" view: Look for explanations alongside commit information +- When reviewing commits: Option to generate explanations for any selected commit + +### AI Changelog Creation `Advanced` +*Available in:* Advanced and Business plans only +Automatically generate comprehensive changelogs from selected commits in the Graph, perfect for release documentation. Maintain consistent and detailed changelogs without manual effort. +*How to access:* +- In the Search/Compare view: Click the inline button on the "commits" line +- When selecting multiple commits in the Graph: Right-click and choose "Generate Changelog" +- From the Command Palette: `GitLens: Generate Changelog from Commits` -To remove your AI Provider API key in GitLens, run the command `GitLens: Reset Stored AI Keys...` from the Command Palette. +
+

More questions about Gitkraken AI? Please see our GitKraken AI FAQ page for more details

+
*** -##Git Command Palette +## Git Command Palette @@ -569,6 +608,10 @@ You will be prompted to log into your GitKraken account if you are not already. +
+

Community users are limited to basic functionality only.

+
+ ## GitHub Enterprise Server and GitLab Self-Managed Integration `PRO` GitLens Pro offers a richer integration with GitHub Enterprise Server and GitLab Self-Managed. @@ -609,12 +652,16 @@ Or *** -## Jira Integration +## Jira Integration `PRO` 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`. +
+

This Feature is only available for Pro subscription tiers or higher

+
+ 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 gitkraken.dev/settings/integrations in a browser. diff --git a/gitlens/gitlens-home.md b/gitlens/gitlens-home.md index 0ac9207..1ad52d0 100644 --- a/gitlens/gitlens-home.md +++ b/gitlens/gitlens-home.md @@ -59,7 +59,7 @@ From inside a file, Inline Blame and Hovers provide the answers to who exactly c Reviewing pull requests can be cumbersome due to needing to context switch to a browser to search through pull requests that are irrelevant to you. Email notification updates can interrupt your workflows when checking out branches if you have work in progress. With the use of Launchpad and Worktrees, GitLens offers the ability to see all pull requests that are organized in groups of actions that you need to take and utilize worktrees to simultaneously have separate working directories, all without leaving Visual Studio Code. -#### Launchpad +#### Launchpad `PRO` To begin working with the Launchpad, connect the [GitHub Integration](gitkraken.dev/settings/integrations). Once connected, you can access the Launchpad from the command palette (command/ctrl + shift + P) > _GitLens: Open Launchpad_. @@ -68,7 +68,9 @@ Here, you can see pull requests that are open on your current branch, blocked, n To begin reviewing a pull request, simply select a pull request and then Open in Worktree or Switch to Branch or Worktree. Open the Launchpad in GitLens. - +
+

This feature is only available for Pro subscription tiers or higher

+
#### Worktrees Worktrees allow you to have separate working directories, meaning you can check out and work in multiple branches at once. This allows you to not need to commit or stash changes you are currently working on in order to review a pull request. @@ -77,6 +79,10 @@ Once you have opened a worktree, you can easily begin reviewing all changes made Open the Worktree View in GitLens. +
+

Community plan is restricted to public and local repositories only.

+
+ *** ### Streamline Collaboration @@ -89,7 +95,7 @@ Once you have opened a worktree, you can easily begin reviewing all changes made When collaborating with others in a repository, it can be difficult to share code without bloating your repository with multiple commits and branches that may not be ready to contribute to the remote. Additionally, pull request reviews can be limiting for what you have access to review, comment on, and does not give you the ability to review files that have not been modified. With the use of Cloud Patches and Code Suggest, GitLens offers the ability to easily share code without needing to commit/push it to a remote and allows you to suggest code changes to any file in the repository. -#### Cloud Patches +#### Cloud Patches `PRO` Cloud Patches are Git patches that can be shared with anyone in your GitKraken organization to quickly share code changes with others. It can be applied to their working directory to continue to collaborate on or commit to the repository. @@ -98,8 +104,11 @@ To create a cloud patch, make changes to any file in a repository and then save When you select members to share it with, they will see this in the Cloud Patch sidebar to be able to apply to their working directory. Open the Cloud Patches View in GitLens. +
+

This feature is only available for Pro subscription tiers or higher

+
-#### Code Suggest +#### Code Suggest `PRO` Code Suggest allows you to make edits across the entire repository that can be submitted to anyone's open pull request. @@ -107,6 +116,10 @@ To create a Code Suggestion, have a branch checked out with an open pull request The pull request creator can then review these changes, apply them to their working directory to continue updating them, and accept the changes to commit/push them to the pull request. +
+

This feature is only available for Pro subscription tiers or higher

+
+ *** ### Improve Workflows With Integrations diff --git a/gitlens/gitlens-start-here.md b/gitlens/gitlens-start-here.md index 0eb429c..8e13027 100644 --- a/gitlens/gitlens-start-here.md +++ b/gitlens/gitlens-start-here.md @@ -6,6 +6,7 @@ taxonomy: category: gitlens --- +--- Welcome to the GitLens Support Documentation site! @@ -24,7 +25,7 @@ GitLens is known for its blame, hover, and annotations, but there’s much more ### Interactive Code History
- +

 

@@ -52,14 +53,14 @@ From inside a file, Inline Blame and Hovers provide the answers to who exactly c ### Accelerate PR Reviews
- +

 

Reviewing pull requests can be cumbersome due to needing to context switch to a browser to search through pull requests that are irrelevant to you. Email notification updates can interrupt your workflows when checking out branches if you have work in progress. With the use of Launchpad and Worktrees, GitLens offers the ability to see all pull requests that are organized in groups of actions that you need to take and utilize worktrees to simultaneously have separate working directories, all without leaving Visual Studio Code. -#### Launchpad +#### Launchpad `PRO` To begin working with the Launchpad, connect the [GitHub Integration](gitkraken.dev/settings/integrations). Once connected, you can access the Launchpad from the command palette (command/ctrl + shift + P) > _GitLens: Open Launchpad_. @@ -68,7 +69,9 @@ Here, you can see pull requests that are open on your current branch, blocked, n To begin reviewing a pull request, simply select a pull request and then Open in Worktree or Switch to Branch or Worktree. Open the Launchpad in GitLens. - +
+

This feature is only available for Pro subscription tiers or higher

+
#### Worktrees Worktrees allow you to have separate working directories, meaning you can check out and work in multiple branches at once. This allows you to not need to commit or stash changes you are currently working on in order to review a pull request. @@ -77,19 +80,23 @@ Once you have opened a worktree, you can easily begin reviewing all changes made Open the Worktree View in GitLens. +
+

Community plan is restricted to public and local repositories only.

+
+ *** ### Streamline Collaboration
- +

 

When collaborating with others in a repository, it can be difficult to share code without bloating your repository with multiple commits and branches that may not be ready to contribute to the remote. Additionally, pull request reviews can be limiting for what you have access to review, comment on, and does not give you the ability to review files that have not been modified. With the use of Cloud Patches and Code Suggest, GitLens offers the ability to easily share code without needing to commit/push it to a remote and allows you to suggest code changes to any file in the repository. -#### Cloud Patches +#### Cloud Patches `PRO` Cloud Patches are Git patches that can be shared with anyone in your GitKraken organization to quickly share code changes with others. It can be applied to their working directory to continue to collaborate on or commit to the repository. @@ -98,8 +105,11 @@ To create a cloud patch, make changes to any file in a repository and then save When you select members to share it with, they will see this in the Cloud Patch sidebar to be able to apply to their working directory. Open the Cloud Patches View in GitLens. +
+

This feature is only available for Pro subscription tiers or higher

+
-#### Code Suggest +#### Code Suggest `PRO` Code Suggest allows you to make edits across the entire repository that can be submitted to anyone's open pull request. @@ -107,12 +117,16 @@ To create a Code Suggestion, have a branch checked out with an open pull request The pull request creator can then review these changes, apply them to their working directory to continue updating them, and accept the changes to commit/push them to the pull request. +
+

This feature is only available for Pro subscription tiers or higher

+
+ *** ### Improve Workflows With Integrations
- +

 

@@ -141,6 +155,3 @@ Join our public slack community and interact with other GitKraken GitLens users Didn't find what you're looking for in all of our documentation and help articles? Paid users can reach out to our support team. [Contact Support](https://help.gitkraken.com/gitlens/gl-contact-support) - - - diff --git a/gitlens/gl-terms-and-conditions.md b/gitlens/gl-terms-and-conditions.md index 71348dc..5f98c15 100644 --- a/gitlens/gl-terms-and-conditions.md +++ b/gitlens/gl-terms-and-conditions.md @@ -16,12 +16,19 @@ You can always reach out to us by using the [Contact support](https://help.gitkr ## GitLens Support -- Support requests for GitLens are to be submitted at [Contact Support](https://help.gitkraken.com/gitlens/gl-contact-support/). Interactions with users submitting tickets are done primarily through emails, though other communication services such as phone calls, screenshare services might be used to deliver Support Services. -- Support Hours are 7:00am to 4:00pm Monday to Friday, Arizona Time (UTC-7) with a response time of 1 (one) business day. While support requests can be submitted by users at any time, responses to requests and interactions with support are provided during Support Hours only. -- The following product plans are guaranteed support: Pro, Teams and Enterprise. -- GitLens is available for Visual Studio Code. -- Best effort support is provided for Students and Education users, we aim to respond quickly and help as much as possible, but we do not have any guaranteed response window. -- While we try to get to everyone who reaches out, a response is not guaranteed to all users. This includes any users who are not paid. We encourage all users to engage in our community and utilize our free resources. [Additional Resources](https://help.gitkraken.com/gitkraken-client/gitkraken-client-home/#additional-resources) +- Support requests for GitLens are to be submitted at [Contact Support](https://help.gitkraken.com/gitlens/gl-contact-support/). Interactions with users submitting tickets are done primarily through emails, though other communication services such as phone calls, screenshare services might be used to deliver Support Services. + +- The following product plans are guaranteed support: Pro, Advanced, Business, and Enterprise. + +- Support Hours are 10:00 am to 10:00 pm, Monday to Friday, UTC. While users can submit support requests anytime, responses to requests and interactions with support are provided during Support Hours only. Below are the response times for each of our Plans during support hours. + +| | PRO | Advanced | Business | Enterprise | +| :--- | :--- | :--- | :--- | :--- | +| Response Time | 3 Business Days | 1 Business day | 12 Hours | 6 Hours | + +- GitLens is available only for Visual Studio Code + +- While we try to get to everyone who reaches out, a response is not guaranteed to all users. This includes any users who are on Student and Community plans. We encourage all users to engage in our community and utilize our self servicefree resources. [Additional Resources](https://help.gitkraken.com/gitkraken-desktop/gitkraken-desktop-home/#additional-resources) ### Support Period diff --git a/gitlens/home-view.md b/gitlens/home-view.md index 88664e4..527897e 100644 --- a/gitlens/home-view.md +++ b/gitlens/home-view.md @@ -34,8 +34,10 @@ At the top of the GitLens Home View, you can see the state of your active reposi When integrations are connected and issues or pull requests are associated with your branch, GitLens Pro will group them with branches. This allows you to check PR statuses, continue reviews, or revisit issue specifications as you work. If you haven't opened a PR yet or need to associate a branch with an existing issue, GitLens will guide you through the process. -## Launchpad Section - +## Launchpad Section `Pro` +
+

This feature is only available for Pro subscription tiers or higher

+
The Launchpad Section highlights the most important tasks to work on next. It leverages integrations to list critical pull requests that need your attention and allows you to start work on issues assigned to you by creating branches and worktrees. diff --git a/gitlens/side-bar.md b/gitlens/side-bar.md index 6a20bc6..3d915df 100644 --- a/gitlens/side-bar.md +++ b/gitlens/side-bar.md @@ -36,8 +36,8 @@ The GitLens side bar is the home of GitKraken teams and collaboration services ( - Home View - GitKraken Workspaces - GitKraken Account -- Cloud Patches -- Launchpad +- Cloud Patches `Pro` +- Launchpad `Pro` @@ -77,7 +77,7 @@ To revert back to the default view locations, open the command palette (com *** -##Commits view +## Commits view @@ -128,7 +128,7 @@ The Overview tab allows you to view your work-in-progress changes any time witho *** -##Repositories view +## Repositories view @@ -167,7 +167,7 @@ The _Repositories_ view lists opened Git repositories, and additionally provides *** -##File History view +## File History view @@ -187,7 +187,7 @@ The file history view lists all of the commits that changed the current file on *** -##Line History view +## Line History view @@ -203,7 +203,7 @@ The line history view lists all of the commits that changed the selected lines o *** -##Branches view +## Branches view @@ -239,7 +239,7 @@ The _Branches_ view lists all of the local branches, and additionally provides: *** -##Remotes view +## Remotes view @@ -253,7 +253,7 @@ The _Remotes_ view lists all of the remotes and their remote branches, and addit *** -##Stashes view +## Stashes view @@ -265,7 +265,7 @@ The _Stashes_ view lists all of the stashes, and additionally provides: *** -##Tags view +## Tags view @@ -284,7 +284,7 @@ The Launchpad view is a view that offers the ability to always have the [Launchp -## Workspaces `PREVIEW` +## Workspaces Workspaces are a convenient way to group and manage multiple repositories, making them easily accessible from anywhere. Whether you're working individually or collaborating with a team, Workspaces provide a seamless way to manage your projects. A Workspace can be made up of local repositories, those you currently have open in your VS Code window, or GitKraken Workspaces, which are repositories stored on the cloud or on GitKraken services. @@ -356,7 +356,7 @@ You can also manually add repositories to the VS Code workspace at any time usin *** -## Worktrees view `PRO` +## Worktrees view @@ -364,7 +364,7 @@ A [customizable](gitlens/gitlens-settings/#worktrees-view-settings) view to crea *** -##Contributors view +## Contributors view @@ -376,7 +376,7 @@ The Contributors view lists all of the contributors, and additionally provides: *** -##Search & Compare view +## Search & Compare view