diff --git a/_images/Insights-Dashboard.png b/_images/Insights-Dashboard.png new file mode 100644 index 0000000..d6e14e1 Binary files /dev/null and b/_images/Insights-Dashboard.png differ diff --git a/_images/add-metric.png b/_images/add-metric.png new file mode 100644 index 0000000..c163dff Binary files /dev/null and b/_images/add-metric.png differ diff --git a/_images/add-metric@2x.png b/_images/add-metric@2x.png new file mode 100644 index 0000000..185e521 Binary files /dev/null and b/_images/add-metric@2x.png differ diff --git a/_images/administration-and-security-controls.png b/_images/administration-and-security-controls.png new file mode 100644 index 0000000..ae7e32a Binary files /dev/null and b/_images/administration-and-security-controls.png differ diff --git a/_images/administration-and-security-controls@2x.png b/_images/administration-and-security-controls@2x.png new file mode 100644 index 0000000..cccb072 Binary files /dev/null and b/_images/administration-and-security-controls@2x.png differ diff --git a/_images/authorize-gitclear.png b/_images/authorize-gitclear.png new file mode 100644 index 0000000..c4822d8 Binary files /dev/null and b/_images/authorize-gitclear.png differ diff --git a/_images/authorize-gitclear@2x.png b/_images/authorize-gitclear@2x.png new file mode 100644 index 0000000..dc1f061 Binary files /dev/null and b/_images/authorize-gitclear@2x.png differ diff --git a/_images/change-lead-time.png b/_images/change-lead-time.png new file mode 100644 index 0000000..e605922 Binary files /dev/null and b/_images/change-lead-time.png differ diff --git a/_images/change-lead-time@2x.png b/_images/change-lead-time@2x.png new file mode 100644 index 0000000..b991f30 Binary files /dev/null and b/_images/change-lead-time@2x.png differ diff --git a/_images/copy-paste-moved.png b/_images/copy-paste-moved.png new file mode 100644 index 0000000..15eec21 Binary files /dev/null and b/_images/copy-paste-moved.png differ diff --git a/_images/copy-paste-moved@2x.png b/_images/copy-paste-moved@2x.png new file mode 100644 index 0000000..786adeb Binary files /dev/null and b/_images/copy-paste-moved@2x.png differ diff --git a/_images/cycle-time-line.png b/_images/cycle-time-line.png new file mode 100644 index 0000000..02affcf Binary files /dev/null and b/_images/cycle-time-line.png differ diff --git a/_images/cycle-time-line@2x.png b/_images/cycle-time-line@2x.png new file mode 100644 index 0000000..84880f1 Binary files /dev/null and b/_images/cycle-time-line@2x.png differ diff --git a/_images/data-connection-oct-2025.png b/_images/data-connection-oct-2025.png new file mode 100644 index 0000000..431dd7a Binary files /dev/null and b/_images/data-connection-oct-2025.png differ diff --git a/_images/data-connection-oct-2025@2x.png b/_images/data-connection-oct-2025@2x.png new file mode 100644 index 0000000..3d341c5 Binary files /dev/null and b/_images/data-connection-oct-2025@2x.png differ diff --git a/_images/data-connection-oct-25.png b/_images/data-connection-oct-25.png new file mode 100644 index 0000000..eea5d14 Binary files /dev/null and b/_images/data-connection-oct-25.png differ diff --git a/_images/data-connection-oct-25@2x.png b/_images/data-connection-oct-25@2x.png new file mode 100644 index 0000000..eea5d14 Binary files /dev/null and b/_images/data-connection-oct-25@2x.png differ diff --git a/_images/data-connection.png b/_images/data-connection.png new file mode 100644 index 0000000..bc0b32b Binary files /dev/null and b/_images/data-connection.png differ diff --git a/_images/data-connection@2x.png b/_images/data-connection@2x.png new file mode 100644 index 0000000..225c429 Binary files /dev/null and b/_images/data-connection@2x.png differ diff --git a/_images/deploy-frequency-details.png b/_images/deploy-frequency-details.png new file mode 100644 index 0000000..dad8aed Binary files /dev/null and b/_images/deploy-frequency-details.png differ diff --git a/_images/deploy-frequency-details@2x.png b/_images/deploy-frequency-details@2x.png new file mode 100644 index 0000000..d897082 Binary files /dev/null and b/_images/deploy-frequency-details@2x.png differ diff --git a/_images/deploy-frequency.png b/_images/deploy-frequency.png new file mode 100644 index 0000000..ae7632b Binary files /dev/null and b/_images/deploy-frequency.png differ diff --git a/_images/deploy-frequency@2x.png b/_images/deploy-frequency@2x.png new file mode 100644 index 0000000..3c09251 Binary files /dev/null and b/_images/deploy-frequency@2x.png differ diff --git a/_images/deployment-frequency-oct-2025.png b/_images/deployment-frequency-oct-2025.png new file mode 100644 index 0000000..a6ad845 Binary files /dev/null and b/_images/deployment-frequency-oct-2025.png differ diff --git a/_images/deployment-frequency-oct-2025@2x.png b/_images/deployment-frequency-oct-2025@2x.png new file mode 100644 index 0000000..414c295 Binary files /dev/null and b/_images/deployment-frequency-oct-2025@2x.png differ diff --git a/_images/duplicated-code-details-view.png b/_images/duplicated-code-details-view.png new file mode 100644 index 0000000..8c01c1f Binary files /dev/null and b/_images/duplicated-code-details-view.png differ diff --git a/_images/duplicated-code-details-view@2x.png b/_images/duplicated-code-details-view@2x.png new file mode 100644 index 0000000..ef99e23 Binary files /dev/null and b/_images/duplicated-code-details-view@2x.png differ diff --git a/_images/duplicated-code-details.png b/_images/duplicated-code-details.png new file mode 100644 index 0000000..d99535d Binary files /dev/null and b/_images/duplicated-code-details.png differ diff --git a/_images/duplicated-code-details@2x.png b/_images/duplicated-code-details@2x.png new file mode 100644 index 0000000..8172990 Binary files /dev/null and b/_images/duplicated-code-details@2x.png differ diff --git a/_images/duplicated-code.png b/_images/duplicated-code.png new file mode 100644 index 0000000..9edc13b Binary files /dev/null and b/_images/duplicated-code.png differ diff --git a/_images/duplicated-code@2x.png b/_images/duplicated-code@2x.png new file mode 100644 index 0000000..9edc13b Binary files /dev/null and b/_images/duplicated-code@2x.png differ diff --git a/_images/enforce-ai-providers.png b/_images/enforce-ai-providers.png new file mode 100644 index 0000000..8252fad Binary files /dev/null and b/_images/enforce-ai-providers.png differ diff --git a/_images/enforce-ai-providers@2x.png b/_images/enforce-ai-providers@2x.png new file mode 100644 index 0000000..f66f42e Binary files /dev/null and b/_images/enforce-ai-providers@2x.png differ diff --git a/_images/first-response-time.png b/_images/first-response-time.png new file mode 100644 index 0000000..d304211 Binary files /dev/null and b/_images/first-response-time.png differ diff --git a/_images/first-response-time@2x.png b/_images/first-response-time@2x.png new file mode 100644 index 0000000..5076329 Binary files /dev/null and b/_images/first-response-time@2x.png differ diff --git a/_images/gitkraken-insights-full-dashboard.png b/_images/gitkraken-insights-full-dashboard.png new file mode 100644 index 0000000..08d69c9 Binary files /dev/null and b/_images/gitkraken-insights-full-dashboard.png differ diff --git a/_images/gitkraken-insights-full-dashboard@2x.png b/_images/gitkraken-insights-full-dashboard@2x.png new file mode 100644 index 0000000..a22b18b Binary files /dev/null and b/_images/gitkraken-insights-full-dashboard@2x.png differ diff --git a/_images/gk-dev-purchase-licenses-2025-B.png b/_images/gk-dev-purchase-licenses-2025-B.png new file mode 100644 index 0000000..88db1af Binary files /dev/null and b/_images/gk-dev-purchase-licenses-2025-B.png differ diff --git a/_images/gk-dev-purchase-licenses-2025-B@2x.png b/_images/gk-dev-purchase-licenses-2025-B@2x.png new file mode 100644 index 0000000..88db1af Binary files /dev/null and b/_images/gk-dev-purchase-licenses-2025-B@2x.png differ diff --git a/_images/gk-dev-purchase-licenses-2025.png b/_images/gk-dev-purchase-licenses-2025.png new file mode 100644 index 0000000..88db1af Binary files /dev/null and b/_images/gk-dev-purchase-licenses-2025.png differ diff --git a/_images/gk-dev-purchase-licenses-2025@2x.png b/_images/gk-dev-purchase-licenses-2025@2x.png new file mode 100644 index 0000000..88db1af Binary files /dev/null and b/_images/gk-dev-purchase-licenses-2025@2x.png differ diff --git a/_images/gk-dev-student-account.png b/_images/gk-dev-student-account.png new file mode 100644 index 0000000..857c944 Binary files /dev/null and b/_images/gk-dev-student-account.png differ diff --git a/_images/gk-dev-student-expire-notification.png b/_images/gk-dev-student-expire-notification.png new file mode 100644 index 0000000..96f4ab3 Binary files /dev/null and b/_images/gk-dev-student-expire-notification.png differ diff --git a/_images/gk-dev-subscription-add-seats-2025-B.png b/_images/gk-dev-subscription-add-seats-2025-B.png new file mode 100644 index 0000000..c51e8aa Binary files /dev/null and b/_images/gk-dev-subscription-add-seats-2025-B.png differ diff --git a/_images/gk-dev-subscription-add-seats-2025-B@2x.png b/_images/gk-dev-subscription-add-seats-2025-B@2x.png new file mode 100644 index 0000000..c51e8aa Binary files /dev/null and b/_images/gk-dev-subscription-add-seats-2025-B@2x.png differ diff --git a/_images/gk-dev-subscription-add-seats-2025.png b/_images/gk-dev-subscription-add-seats-2025.png new file mode 100644 index 0000000..c51e8aa Binary files /dev/null and b/_images/gk-dev-subscription-add-seats-2025.png differ diff --git a/_images/gk-dev-subscription-add-seats-2025@2x.png b/_images/gk-dev-subscription-add-seats-2025@2x.png new file mode 100644 index 0000000..665d55f Binary files /dev/null and b/_images/gk-dev-subscription-add-seats-2025@2x.png differ diff --git a/_images/goal-setup.png b/_images/goal-setup.png new file mode 100644 index 0000000..4fd0aa2 Binary files /dev/null and b/_images/goal-setup.png differ diff --git a/_images/goal-setup@2x.png b/_images/goal-setup@2x.png new file mode 100644 index 0000000..ef5cd72 Binary files /dev/null and b/_images/goal-setup@2x.png differ diff --git a/_images/import-progress.png b/_images/import-progress.png new file mode 100644 index 0000000..91e620a Binary files /dev/null and b/_images/import-progress.png differ diff --git a/_images/import-progress@2x.png b/_images/import-progress@2x.png new file mode 100644 index 0000000..3a2857e Binary files /dev/null and b/_images/import-progress@2x.png differ diff --git a/_images/import-repos.png b/_images/import-repos.png new file mode 100644 index 0000000..77975a8 Binary files /dev/null and b/_images/import-repos.png differ diff --git a/_images/import-repos@2x.png b/_images/import-repos@2x.png new file mode 100644 index 0000000..fb46aa2 Binary files /dev/null and b/_images/import-repos@2x.png differ diff --git a/_images/insights-dashboard-oct-2025.png b/_images/insights-dashboard-oct-2025.png new file mode 100644 index 0000000..f56d4fd Binary files /dev/null and b/_images/insights-dashboard-oct-2025.png differ diff --git a/_images/insights-dashboard-oct-2025@2x.png b/_images/insights-dashboard-oct-2025@2x.png new file mode 100644 index 0000000..3ac4cd8 Binary files /dev/null and b/_images/insights-dashboard-oct-2025@2x.png differ diff --git a/_images/layout-options.png b/_images/layout-options.png new file mode 100644 index 0000000..b7168ed Binary files /dev/null and b/_images/layout-options.png differ diff --git a/_images/layout-options@2x.png b/_images/layout-options@2x.png new file mode 100644 index 0000000..e36b640 Binary files /dev/null and b/_images/layout-options@2x.png differ diff --git a/_images/lead-time.png b/_images/lead-time.png new file mode 100644 index 0000000..76870eb Binary files /dev/null and b/_images/lead-time.png differ diff --git a/_images/lead-time@2x.png b/_images/lead-time@2x.png new file mode 100644 index 0000000..61940b8 Binary files /dev/null and b/_images/lead-time@2x.png differ diff --git a/_images/number-of-reviews.png b/_images/number-of-reviews.png new file mode 100644 index 0000000..0abff26 Binary files /dev/null and b/_images/number-of-reviews.png differ diff --git a/_images/number-of-reviews@2x.png b/_images/number-of-reviews@2x.png new file mode 100644 index 0000000..eadbe4b Binary files /dev/null and b/_images/number-of-reviews@2x.png differ diff --git a/_images/percent-of-code-rework.png b/_images/percent-of-code-rework.png new file mode 100644 index 0000000..2a1100c Binary files /dev/null and b/_images/percent-of-code-rework.png differ diff --git a/_images/percent-of-code-rework@2x.png b/_images/percent-of-code-rework@2x.png new file mode 100644 index 0000000..2a1100c Binary files /dev/null and b/_images/percent-of-code-rework@2x.png differ diff --git a/_images/post-pr-work-occuring-details.png b/_images/post-pr-work-occuring-details.png new file mode 100644 index 0000000..35262fc Binary files /dev/null and b/_images/post-pr-work-occuring-details.png differ diff --git a/_images/post-pr-work-occuring-details@2x.png b/_images/post-pr-work-occuring-details@2x.png new file mode 100644 index 0000000..35262fc Binary files /dev/null and b/_images/post-pr-work-occuring-details@2x.png differ diff --git a/_images/post-pr-work-occuring.png b/_images/post-pr-work-occuring.png new file mode 100644 index 0000000..1e5f845 Binary files /dev/null and b/_images/post-pr-work-occuring.png differ diff --git a/_images/post-pr-work-occuring@2x.png b/_images/post-pr-work-occuring@2x.png new file mode 100644 index 0000000..1e5f845 Binary files /dev/null and b/_images/post-pr-work-occuring@2x.png differ diff --git a/_images/pr-cycle-time-details.png b/_images/pr-cycle-time-details.png new file mode 100644 index 0000000..f7b8798 Binary files /dev/null and b/_images/pr-cycle-time-details.png differ diff --git a/_images/pr-cycle-time-details@2x.png b/_images/pr-cycle-time-details@2x.png new file mode 100644 index 0000000..78b0e68 Binary files /dev/null and b/_images/pr-cycle-time-details@2x.png differ diff --git a/_images/set-role-oct-2025.png b/_images/set-role-oct-2025.png new file mode 100644 index 0000000..7fadbb5 Binary files /dev/null and b/_images/set-role-oct-2025.png differ diff --git a/_images/set-role-oct-2025@2x.png b/_images/set-role-oct-2025@2x.png new file mode 100644 index 0000000..a12c330 Binary files /dev/null and b/_images/set-role-oct-2025@2x.png differ diff --git a/_images/set-role.png b/_images/set-role.png new file mode 100644 index 0000000..7da7155 Binary files /dev/null and b/_images/set-role.png differ diff --git a/_images/set-role@2x.png b/_images/set-role@2x.png new file mode 100644 index 0000000..38f77f2 Binary files /dev/null and b/_images/set-role@2x.png differ diff --git a/_images/timeframe-filter.png b/_images/timeframe-filter.png new file mode 100644 index 0000000..7b3a71f Binary files /dev/null and b/_images/timeframe-filter.png differ diff --git a/_images/timeframe-filter@2x.png b/_images/timeframe-filter@2x.png new file mode 100644 index 0000000..2ca29ee Binary files /dev/null and b/_images/timeframe-filter@2x.png differ diff --git a/gk-dev/GK-dev-terms-and-conditions.md b/gk-dev/GK-dev-terms-and-conditions.md index 85937f3..eb924b3 100644 --- a/gk-dev/GK-dev-terms-and-conditions.md +++ b/gk-dev/GK-dev-terms-and-conditions.md @@ -1,6 +1,6 @@ --- -title: Gitkraken Cloud Services Support Terms and Conditions +title: GitKraken Cloud Services Support Terms and Conditions description: Learn about Gitkraken Cloud Services Support terms and conditions taxonomy: category: gk-dev @@ -14,7 +14,7 @@ You can always reach out to us by using the Contact support. [Contact support](h --- -## Gitkraken Cloud Services Support +## GitKraken Cloud Services Support - Support requests for GitKraken Cloud Services should be submitted at [Contact support](https://help.gitkraken.com/gk-dev/gk-dev-contact-support/?product_s_=GitKraken.dev). Users submitting tickets interact primarily through emails, though other communication services, such as phone calls and screen share services, might be used to deliver Support Services. @@ -58,8 +58,4 @@ We may need to accelerate the timeline for EoL of functionality in extenuating c Similarly, integrated third-party software or services may need to be retired due to the third-party decision to change or retire their solution. In these situations, the pace of retirement will be out of our control. -However, even under these circumstances, we will provide as much advance notice as possible. - - - -Visit the [EULA](https://www.gitkraken.com/eula) and [Privacy Policy](https://www.gitkraken.com/privacy) pages for more information. \ No newline at end of file +However, even under these circumstances, we will provide as much advance notice as possible.Visit the [EULA](https://www.gitkraken.com/eula) and [Privacy Policy](https://www.gitkraken.com/privacy) pages for more information. diff --git a/gk-dev/gk-dev-account.md b/gk-dev/gk-dev-account.md index 4a7d770..55bb2ca 100644 --- a/gk-dev/gk-dev-account.md +++ b/gk-dev/gk-dev-account.md @@ -1,46 +1,74 @@ --- - -title: Manage GitKraken Account -description: Learn about GitKraken Accounts +title: Manage Your GitKraken Account +description: Set up and manage your GitKraken account used across GitKraken Desktop, GitLens, CLI, and more. Learn how to log in, personalize your profile, and delete your account. taxonomy: category: gk-dev - --- -Your GitKraken account is your key to unlock the most personal experience across GitKraken products. +Last updated: June 2025 + +Your GitKraken account provides access to all GitKraken products and services, including GitKraken Desktop, GitLens, CLI, and GitKraken.dev. Use it to manage your identity, license, and preferences in one place.
-

Note that your GitKraken account is not compatible with Git Integration for Jira.

-

It is recommended to create and use a single GitKraken account for yourself, to not create a second account for yourself, and to not share an account with others.

+

Note that your GitKraken account is not compatible with Git Integration for Jira.

+

We recommend using a single GitKraken account for yourself. Avoid creating duplicate accounts or sharing your account with others.

*** -## Login +## Sign in or create an account + +Go to [gitkraken.dev](https://gitkraken.dev?source=help_center) and choose one of the supported login options: -You can create your GitKraken account at [gitkraken.dev](https://gitkraken.dev/register) or from within GitKraken Desktop. When presented with the login page (see image below), you may need to select “Create an account” before selecting how you would like to create your GitKraken account. There are seven options available to create your GitKraken account and login. You can choose your preferred hosting service (GitHub, GitLab, Bitbucket, and Azure DevOps), login with email, Google, or [SSO](/gk-dev/gk-dev-single-sign-on/). +**Git providers:** +- GitHub +- GitLab +- Bitbucket +- Azure DevOps - +**Other options:** +- Google +- Microsoft +- Email + password +- [Single Sign-On (SSO)](/gk-dev/gk-dev-single-sign-on/) -Once you have created your GitKraken account, your account is tied to the primary email address of whichever method you selected. If you use the “Sign up with Email” method, you will need to verify your email address with a link sent to your email. +Each login method is tied to your primary email address. If you sign up with email, you’ll need to verify it via a confirmation link. + +
+ GitKraken login options screen +
Choose a connected service to authenticate with GitKraken
+
*** -## Personalization +## Personalize your account -You can personalize your account to determine how you appear to other users within any GitKraken [organization](/gk-dev/gk-dev-organization/) your account may be associated with. You can personalize your account at [gitkraken.dev/account](https://gitkraken.dev/account) once you have logged in. Here you can change your avatar, name, username, email, and password. +Click your avatar in the top right to: -If you select your profile picture, you will be taken to [Gravatar](https://gravatar.com). This is where you can select your avatar which your GitKraken account pulls from Gravatar and is associated with the shared email between your GitKraken account and your Gravatar. Please note that it may take several hours for your avatar change to reflect in GitKraken. +- Change your display name or avatar +- Manage your GitKraken licenses +- Configure email settings +- View your plan and billing information - +
+ GitKraken account profile settings +
Access account and license settings
+
+GitKraken uses [Gravatar](https://gravatar.com) to manage profile avatars. To change your avatar, select your profile image and follow the link to Gravatar. Updates may take several hours to appear. *** -## Delete +## Delete your account + +To permanently delete your account: -You can delete your GitKraken account at any time by navigating to [gitkraken.dev/account](https://gitkraken.dev/account) and selecting "Delete my Account." Complete the confirmation instructions and select "Delete your Account" to complete the process. +1. Go to Settings > Account Settings +2. Click **Delete Account** +3. Confirm the deletion in the prompt -One exception to this is if you are a non-admin of a GitKraken organization. This is due to company organizations having administrative control over employee accounts. You need to ask an administrator of the GitKraken organization to remove your account from it before deleting your GitKraken account. + > Note: If you are part of a GitKraken organization and not an admin, you’ll need an admin to remove your account before proceeding. -GitKraken is compliant with GDPR. Once you delete your GitKraken account, it cannot be undone. By doing so you will lose the remainder of your subscription (if applicable), cloud workspaces, Insights, organizations, and more. +
+

GitKraken is GDPR-compliant and this action cannot be undone. This action will revoke access to all GitKraken products and services linked to your account.

+
diff --git a/gk-dev/gk-dev-automations.md b/gk-dev/gk-dev-automations.md index 6b534ba..5cbaafb 100644 --- a/gk-dev/gk-dev-automations.md +++ b/gk-dev/gk-dev-automations.md @@ -1,151 +1,236 @@ --- - title: Automations -description: Automations makes it easier to manage your team’s workflows +description: Learn how to use GitKraken.dev automations to streamline GitHub, Bitbucket, Azure DevOps and GitLab workflows with triggers, conditions, and actions. taxonomy: category: gk-dev - --- -GitKraken Automations makes it easier to manage your team’s workflows by codifying best practices, automating repetitive tasks, and proactively highlighting potential issues for you. +Last updated: December 2025 + +Use **GitKraken.dev Automations** to create rule-based workflows that trigger actions when pull requests and issues match specific conditions. Automations help you streamline collaboration and enforce consistency across teams. +
-

This Feature is only available for Pro subscription tiers or higher

+

This feature is only available on Pro subscription tiers or higher. See pricing options.

-## Automation Examples +*** -These are just a few ways teams are already using Automations to reduce manual effort, enforce best practice standards, and create more scalable, repeatable workflows. -- Safe Deployments: Add a checklist for database migrations to ensure smooth rollouts. -- Critical Code Reviews: Assign the right engineers to review high-impact areas of the codebase, such as a payment service. -- Security Checks: Flag changes to sensitive areas like authentication and ensure a security review is completed. -- Refactoring Guardrails: Prevent conflicting changes during refactors and follow up with post-refactor maintenance tasks. -- SOC 2 Compliance: Automate checklists for encryption, security scans, and documentation to meet regulatory standards. -- DevOps Enhancements: Simplify deployment pipelines, enforce pre-deployment quality checks, and manage infrastructure-as-code changes with Automation workflows tailored to your processes. +## Automation examples + +Here are a few ways teams are using Automations to reduce manual effort and create scalable workflows: + +- **Safe deployments**: Add a checklist for database migrations. +- **Critical code reviews**: Assign reviewers to high-impact areas like payments. +- **Security checks**: Flag sensitive changes (e.g., auth) for review. +- **Refactoring guardrails**: Prevent conflicts and schedule follow-ups. +- **SOC 2 compliance**: Automate tasks for encryption and security checks. +- **DevOps enhancements**: Enforce quality checks and automate infrastructure changes.
-

- Note: - Currently, Automations supports cloud integrations. Self-Hosted Integration Automations will be available at a later date. -

+

Note: Automations currently supports cloud integrations. Self-hosted support will be added in a future update.

+*** -## Get Started with Automations +## Get started with automations -To get started with Automations simply login to [gitkraken.dev](https://gitkraken.dev/automations/general) and select Automations on the left side menu. If this is your first automation you will be directed to our get started landing page, from here you can create a new automation or select a template from the suggestion list. +Log in at [gitkraken.dev](https://gitkraken.dev/?source=help_center&product=gitkraken_dot_dev) and select **Automations** in the left menu. If it's your first time, you'll see the get started page with the option to create a new automation or use a suggested template. - +
+ Automations landing page in GitKraken.dev +
Automations landing page on GitKraken.dev
+
+### Create an automation -### Create a Automation +Click . -To create a Automation, select . +1. Name your automation. +2. Choose from the Provider dropdown. +3. Pick the target repository. +4. (Optional) Enable for draft pull requests by checking the box. -Then, create a name for your automation. Next, using the Provider drop down select either GitHub or GitLab as your hosting provider. And finally locate the repository you wish to apply the automation to in the Repository drop down. If you wish for the Automation to also apply to draft pull requests please select the checkbox. - - +
+ Form to create a new automation rule +
Setup form for new automation
+
-

- Note: - A webhook will be set up on the selected repository after saving the automation. You will need to have permission on the repository to allow the creation of the webhook. -

+

Note: Creating an automation sets up a webhook on the repository. You’ll need the appropriate permissions.

+*** + -## Conditions +## Set Conditions -Next up, you will set up conditions, which are a list of criteria that determine when a Action should execute. We currently support 3 types of conditions: "File location", "File contents", and "Pull Request" +Conditions define when an automation is triggered. GitKraken currently supports the following condition types: - +- **Pull request content** + Trigger on PR metadata, activity, or discussion. + +- **Review: Status** + Watch for approvals, missing reviews, or stale feedback. + +- **Branch and origin** + Trigger based on the source or target branch, or the repository. + +- **CI/CD checks** + React to build, test, and deployment outcomes. + +- **File condition** + Match file paths, folders, or specific code snippets. + +- **GitKraken AI** + Analyze pull request diffs and metadata to detect conditions you care about. + +
+ Conditions configuration screen +
Set up condition rules for triggering actions
+
### Boolean logic -You can choose whether all or any of the conditions you set up trigger your Action: +You can choose whether **all** or **any** of the conditions must be true. - +
+ Boolean logic options for condition matching +
Select logic to match all or any conditions
+
-### File Location +### File location conditions -The Following File Location Action options can be selected: -- File name condition: This condition matches the name of files in your repository. -- File path condition: This condition matches the path of files in your repository. -- File added in folder condition: This condition matches when files are added to a specific folder in a pull request. For example, the filter "File added in folder" with the operator "folder path equals" with the value "src/components/icons" would match any file that was added in that icons folder (or subfolders). +- **File name**: Matches file names. +- **File path**: Matches full file paths. +- **File added in folder**: Triggers when a new file is added to a specified folder in a PR.
-

- Note: - A file path is different from a file name. For example: *src/app/index.ts* is a file path, while *index.ts* is a file name. -

+

Note: A file path includes folders, e.g. src/app/index.ts, while a file name is just index.ts.

+### File contents conditions -### File Contents +- **Old code**: Matches the red (left side) of a split diff. +- **New code**: Matches the green (right side) of a split diff. +- **New and old code**: Matches both sides. -The Following File Contet Action options can be selected: -- Old Code condition: Matches against modified lines of code from before your code change: the red on the left-hand side of a split view diff. -- New Code condition: Matches against modified lines of code from after your code change: the green on the right-hand side of a split view diff. -- New and Old Code condition: Matches both sides of the diff view - -### Pull Request +### Pull request conditions -The Following Pull Request Action options can be selected: -- Number of changed files condition: This condition matches when the number of files that are part of this pull request satisfy the inequality. -- PR Author condition: This condition matches the author of the pull request. This automation will only run if the author matches this condition. -- Labels on the PR condition: This condition matches the GitHub Labels specified +- **Number of changed files** +- **PR author** +- **PR labels** ## Actions -Five kinds of actions are currently supported: posting a comment, adding a checklist item, assigning a pull request, and assigning a reviewer. +GitKraken supports these automation actions: -- Add Comment: When this action is executed, GitKraken will post the comment on the matching pull request -- Add to Checklist: When this action is executed, GitKraken will add a new checklist item to the PR description. You can add as many checklist items as you need by adding an action for each item. -- Add Assignee: When this action is executed, GitKraken will assign the pull request to the user of your choice. If you'd like to assign multiple users, you can create multiple instances of this on the same Action. If you supply an optional message to explain why this user is being assigned, GitKraken will post a comment notifying that user and explaining why they were assigned. -- Add Label: When this action is executed, GitKraken will assign the selected GitHub label to the pull request. If you'd like to add multiple labels, you can create multiple instances of this action on the same Action. -- Add Reviewer: When this action is executed, GitKraken will assign the person or team of your choice as a reviewer on the PR. If you'd like to add multiple reviewers, you can create multiple instances of this action on the same Action. If you supply an optional message to explain why this user is being assigned as a reviewer, GitKraken will post a comment notifying that user and explaining why they were assigned as a reviewer. +### AI + +- **GitKraken AI** + Post a comment with a summary generated from an AI prompt. + +### People + +- **Notify user** + Send a custom notification to selected users. + +- **Add reviewer** + Assign a reviewer or team, with an optional message. + +- **Add assignee** + Assign the PR to selected users, optionally including a message. + +- **Remove reviewer** + Unassign a reviewer or team from the PR. + +- **Remove assignee** + Unassign a user from the PR. + +### Pull Request + +- **Add comment** + Post a comment on the PR. + +- **Add label** + Apply a GitHub label to the PR. + +- **Close PR** + Automatically close the pull request. + +- **Add to checklist** + Add checklist items to the PR description.
-

- Note: - A pull request can never have the author of the pull request as a reviewer. If an action would cause the author to be a reviewer on their own pull request, GitKraken will skip over that step, but still perform all other steps on the Action. -

+

Note: Authors can’t review their own PRs. If selected, GitKraken will skip that step and apply all others.

+*** + +## Manage saved automations + +Once you've created automations, manage them at [GitKraken.dev](https://gitkraken.dev/automations/general?source=help_center&product=gitkraken_dot_dev). -## Managing Saved Automations +You can: -After creating your first automation you will now see a list of all your saved automations on [GitKraken.dev](https://gitkraken.dev/automations/general). From this screen you can add additional automations, disable/enable, delete, sort, edit and duplicate your saved automations. +- Enable/disable +- Edit +- Delete +- Duplicate +- Sort by status or action - +
+ List of saved automations +
Manage and organize saved automations
+
+### Edit, delete, or duplicate -### Edit / Delete / Duplicate an Automation +Use the icon next to an automation name. -Edit / Delete / Duplicate a Automation by selecting the ellipsis icon by the Automation name. +
+ Automation options menu +
Automation menu with edit, delete, and duplicate options
+
- +### Sort automations +Sort by **Status** (enabled/disabled) or **Action** (type of triggered automation). -### Sort Automations +
+ Sorting automations by status or action +
Sort saved automations by different criteria
+
-GitKraken Automations has two options for sorting, Status and Action. Status is if the Automation is Enabled or Disabled. Actions allows you to sort by the triggered action of your automation. +### Add another automation - +Click again from the list view. +*** -### Add Additional Automations +## Repository management -To create an additional Automation, select . +The Repository Management screen shows which repos have active automations, who created them, the provider, and automation counts. -## Repoistory Management +
+ Repository automation overview +
View repository-level automation status
+
-Once your automations are created you will then have access to the Repository Management Automations page. +Admins can also add/remove repos or perform bulk actions. - +
+ Repository admin tasks for automations +
Admin view for managing repository automation
+
-From this you can see which repositories have had a Automation connected, who created the automation, the hosting provider and how many automations are active on each repository. You can also perform additional administrative tasks like removing or adding repositories for tracking. This page is perfect for admins that need Automation information at a glance. +*** - +## Next Steps +Explore more ways to automate and streamline Git workflows: +- [Connect an Integration](/gk-dev/gk-dev-integrations/) +- [Use Launchpad to manage PRs and issues](/gk-dev/gk-dev-home/#launchpad-your-daily-git-dashboard) +- [Visualize metrics with GitKraken Insights](/gk-dev/gk-dev-insights/) +- [Return to GitKraken.dev Support Home](/gk-dev/gk-dev-home/) \ No newline at end of file diff --git a/gk-dev/gk-dev-dashboard-management.md b/gk-dev/gk-dev-dashboard-management.md new file mode 100644 index 0000000..12a6ca4 --- /dev/null +++ b/gk-dev/gk-dev-dashboard-management.md @@ -0,0 +1,279 @@ +--- +title: Dashboard Management in GitKraken Insights +description: Learn how to add and interpret key DORA and Pull Request metrics, arrange your layout, and use filters to analyze data on dashboards. +taxonomy: + category: gk-dev +--- +Last updated: December 2025 + + +## Overview + +GitKraken Insights brings your Git data, pull requests, issues, and CI/CD results into one place. Instead of juggling tools or exporting spreadsheets, you get dashboards that show how work is really moving across code, reviews, and releases. The goal is to give both devs and leads a clear view of progress and bottlenecks without extra reporting overhead. + +### Key benefits + +- **In your workflow:** Metrics come straight from the tools you already use: Git, PRs, CI/CD, issue trackers. No duplicate work, no disruption. +- **Useful context:** See how code changes connect to tickets, review quality, and team goals. Less vanity stats, more signal. +- **Clear next steps:** Spot inefficiencies and get practical ways to improve, whether it’s review speed, investment in features vs. fixes, or build times. + +--- + +## Adding Metrics + +Before you can add metrics, complete these setup steps: + +1. [Request a guided tour to get access](https://www.gitkraken.com/insights#form). +2. Connect GitKraken Insights to your GitHub account. +3. Wait for your repositories to finish importing. For detailed instructions, see the [Getting Started guide](https://help.gitkraken.com/gk-dev/gk-dev-insights). + +Once setup is complete, open the **Insights > Dashboard** tab from [gitkraken.dev](https://gitkraken.dev). + +
+ Overview of GitKraken Insights +
Access your Insights Dashboard from gitkraken.dev.
+
+ +### Add a metric + +1. In the Dashboard view, click the **Add Metric** button in the top-right corner. +2. Browse the list of available widgets, grouped by category (for example, **DORA** and **Pull Requests**). +3. Click **Add** next to the metric you want to display on your dashboard. + +
+ Overview of GitKraken Insights +
Add DORA or PR metrics to your dashboard.
+
+ +### Available metrics + +**DORA metrics** + +- Deploy Frequency +- Change lead time +- Mean time to repair/recover +- Defect rate (% of deploy with severe defect) + +**Pull Request metrics** + +- First response time ("Pickup time") +- Cycle time ("first commit" to "merge") +- Lead time ("first commit" to "deployed") +- Number of reviews per day/week/month + +**AI Impact metrics** + +- Copy/paste vs moved percent +- Duplicated code +- Percent of code rework (churned lines) +- Post PR work occurring + +*** + +## DORA metrics + +DORA (DevOps Research and Assessment) metrics are a standardized set of four key performance indicators: deployment frequency, lead time for changes, change failure rate, and time to restore service. + +Developed by a Google Cloud research team, these metrics help organizations measure DevOps performance, identify areas for improvement, and deliver software more efficiently and reliably. + +### Deploy Frequency + +This metric shows how often new code is released or deployed to production, measured as the number of deployments per day, week, or other selected timeframe. + +
+ Overview of GitKraken Insights +
Shows deployments per day, week or selected timeframe.
+
+ +In addition to the main chart, the following submetrics are displayed when you click the Details button: + +- **Deployments per day** +- **Lead time for changes** +- **Average hours to repair (MTTR)** +- **Change failure rate** + +
+ Overview of GitKraken Insights +
Click the Details button to get 4 additional metrics.
+
+ +### Change Lead Time +This metric shows how long each pull request within a selected timeframe took to go from the first commit until it was deployed. Values are expressed in **days** and are calculated over a rolling **7-day period**. + +
+ Overview of GitKraken Insights +
Shows how long each PR took from first commit to deployment.
+
+ +### Mean Time to Repair/Recover (MTTR) + +This metric shows how long each pull request within a selected timeframe took to go from the first commit until it was deployed. Values are expressed in **days** and calculated over a rolling **7-day period**. Lower MTTR indicates that teams can respond quickly to incidents and minimize downtime. + +### Defect Rate + +This metric shows the number of defects detected over time. Values are expressed as **defects** over a rolling **7-day window**. A lower defect rate indicates a more stable and reliable deployment process. + +*** + +## Pull Request metrics + +Pull Request metrics help teams understand how quickly and smoothly code changes move through review and deployment. + +PR intelligence turns these insights into clear actions by highlighting slowdowns, spotting patterns in fast or delayed reviews, and uncovering blockers that may affect delivery. + +### First Response Time ("Pickup Time") + +This metric shows how long each pull request within a selected timeframe took to have a first response (comment or review). Values are expressed in **hours** and averaged over a **7-day period**. Shorter pickup times indicate faster reviewer engagement and healthier collaboration. + +
+ Overview of GitKraken Insights +
Average time it took for PR to receive comment or review.
+
+ +### Cycle Time ("first commit" to "merge") + +This metric shows how long each pull request within a selected timeframe took to merge from the time the first commit was made. Values are expressed in **days** and averaged over a **7-day period**. Cycle time provides insight into overall delivery speed, highlighting how quickly work moves from coding to production. + +
+ Overview of GitKraken Insights +
Average time it took for PR to receive comment or review.
+
+ +The **Details** view offers deeper analysis. + +
+ Overview of GitKraken Insights +
Get a detailed breakdown of PR cycle time.
+
+ +- Pull requests are grouped into four categories by duration: + - **Elite:** Less than 1 day + - **Fast:** 1–7 days + - **Average:** 7–29 days + - **Slower:** Over 30 days +- Each node in the scatter plot is interactive, showing PR details such as time since merge, PR name, author, and a link to open directly in GitHub. +- A sortable table lists all PRs below the chart. You can sort by **Days**, **Pull Request name**, **Author**, **Date Opened**, or **Date Merged**. + +### Lead Time + +This metric shows how long each pull request within a selected timeframe remained open, measured from when the PR was created until it was merged. Values are expressed in **days** and averaged over a **7-day period**. + +
+ Overview of GitKraken Insights +
See how long PRs remained open until it was merged.
+
+ +### Number of Reviews per Day/Week/Month + +This metric shows the total number of reviews (all types) completed over a given period of time. Values are expressed in **reviews** and averaged over a **7-day window**. Tracking review activity helps teams understand collaboration patterns and reviewer workload across different timeframes (daily, weekly, or monthly). + +
+ Overview of GitKraken Insights +
See how many reviews have been given over a time period.
+
+ +*** + +## AI Impact + +AI Impact metrics help teams understand how AI coding tools affect code quality and developer efficiency. By tracking rework, duplication, and post-PR changes, teams can see measurable improvements in code and workflow, proving ROI and guiding smarter use of AI tools. + +### Copy/paste vs moved percent + +The Copy/Paste vs Moved Percent metric compares how much code is duplicated versus refactored or relocated over time. When the copy/paste percentage is higher than the moved percentage, it suggests that developers are duplicating code instead of reusing or restructuring it, which can lead to higher maintenance costs and lower overall code quality. + +
+ Overview of GitKraken Insights +
Compare duplicated versus refactored code over time to identify reuse and duplication trends.
+
+ +You can hover over points on the chart to view the exact percentages for a specific time period, making it easy to see changes before and after implementing an AI coding tool. + + +### Duplicated code + +The Duplicated Code metric highlights how much code is being repeated across your repositories, helping teams identify inefficiencies and potential maintainability issues. When duplication rises, it often signals that AI-assisted or manual coding practices are reusing code without enough refactoring. + +
+ Overview of GitKraken Insights +
Track how duplicated code changes over time to identify growth in repeated code patterns.
+
+ +The detailed view breaks this down by repository and time period, showing where duplication is concentrated and how it changes alongside overall development activity, such as commits, pull requests, and issues resolved. This helps teams connect code duplication trends to broader workflow patterns and assess the real impact of AI tools on code quality. + +
+ Overview of GitKraken Insights +
View duplicated code by repository to see which projects contribute most to redundancy.
+
+ +### Percent of code rework (churned lines) + +The Percent of Code Rework (Churned Lines) metric measures how often recently written code is rewritten, deleted, or replaced over time. High churn rates can indicate instability, unclear requirements, or inefficiencies in AI-assisted code generation. + +
+ Overview of GitKraken Insights +
Track how frequently code is rewritten or replaced over time to identify rework trends.
+
+ +The detailed view breaks this down across repositories and time periods, helping teams see where rework is concentrated and how it aligns with activity levels like commits, pull requests, and issue resolutions. By monitoring this metric, teams can assess whether AI tools are improving long-term code quality or introducing avoidable rework. + +
+ Overview of GitKraken Insights +
View rework percentages by repository to pinpoint where churn is most frequent.
+
+ +### Post PR work occurring + +The Post PR Work Occurring metric measures how much additional code is written or modified after a pull request has been merged. This helps teams spot follow-up work that may indicate incomplete reviews, rushed merges, or overlooked issues during initial development. + +
+ Overview of GitKraken Insights +
Track how much post-merge work occurs over time to identify spikes in follow-up activity.
+
+ +The detailed view breaks this activity down by repository and time period, revealing patterns in post-merge changes and how they relate to broader development activity, such as commits and pull requests. Tracking this metric over time helps teams improve review quality and identify whether AI-assisted coding leads to more—or less—post-merge rework. + +
+ Overview of GitKraken Insights +
View post-merge work by repository to see where additional changes are concentrated.
+
+ + +--- + +## Layout + +Widgets on the dashboard can be customized to fit your needs. + +- **Resize widgets:** Each widget is available in two sizes—small or large. Drag and drop the lower-right corner of a widget to adjust its size. +- **Rearrange widgets:** Drag and drop from the upper-left corner of a widget to move it into a new position on the dashboard. +- **One per dashboard:** Only one copy of each metric can be placed on a dashboard. +- **Widget menu:** From the menu in the upper-right of each widget, you can switch between **line** and **bar** graph types, resize the widget between large or small, export the graph data, or remove the widget from the dashboard. +- **Switch graph type** Switch between line graphs, area graphs, or bar graphs. + +
+ Overview of GitKraken Insights +
Switch between bar, area or line graphs, resize, export graph data, or remove widget from the menu in the upper right.
+
+ +> **Note:** Currently, each user can create only one dashboard per organization. Support for multiple dashboards per user is planned for a future release. + +--- + +## Filters + +The dashboard may be filtered by **Workspace**, **Repositories**, **Timeframe**, and **Team**. + +- **Workspace:** Workspaces are preset groups of repositories. They also enable other key features across gitkraken.dev, GitKraken Desktop, GitLens, and the GitKraken CLI such as Launchpad and multi-repo actions. On the dashboard, you can filter to only display data for the repositories in your chosen Workspace. To create your first workspace, go to [gitkraken.dev/workspaces](https://gitkraken.dev/workspaces). + +- **Repositories:** Refers to the list of repos imported into GitKraken Insights. Check or uncheck repositories to fine-tune the data. Use the search feature to quickly locate repos by name. + +- **Timeframe:** Sets the timebox for the dashboard. Options include **This Week, Last Week, Last 7 days, Last 14 days, Last 28 days, Last 30 days, Last 90 days, Last 12 months**, or a custom date range. + +- **Team:** Filters the data by a group of users. To configure teams, go to **Insights > Settings > Setup your Team**. + + +
+ Overview of GitKraken Insights +
Filter your dashboard by Workspace, Repo, Timeframe, or Team.
+
\ No newline at end of file diff --git a/gk-dev/gk-dev-edu-pack.md b/gk-dev/gk-dev-edu-pack.md deleted file mode 100644 index 7db695e..0000000 --- a/gk-dev/gk-dev-edu-pack.md +++ /dev/null @@ -1,88 +0,0 @@ ---- - -title: GitKraken Pro for Students and Teachers -description: How to enable Pro through the GitHub Student Pack -taxonomy: - category: gk-dev - ---- - -GitKraken Pro is available for free to students and teachers through the GitHub Student Pack. If you don't have the pack yet, first apply through GitHub: - -[Get the GitHub Student Pack](https://education.github.com/pack) - -
-

🚨Important: Once you get the pack, you must sign into your GitKraken account through GitHub one more time to enable Pro on your account. -

-
- -*** - -## Enabling Pro for Students - -Once GitHub has approved your pack, you must sign into your GitKraken account through GitHub 1 more time to enable Pro. - -To sign in again, launch GitKraken Desktop and navigate to File Sign into a Different Account Sign in with GitHub - - - -Or you may login by navigating to the profile dropdown Sign into a Different Account Sign in with GitHub - - - - - -When you sign in with GitHub, GitKraken Desktop will check whether your GitHub account has the GitHub Student Pack. If the app sees the pack, you should see the `Pro` flag in the bottom right of the UI and you will be able to open private repos. - -If you don't see `Pro` then this means GitKraken does not see a pack with the email address tied to your GitHub account. This may mean you need to update the primary email address for your GitHub.com account. - -*** - -## Student Pack FAQ - -### How long does it take to approve the GitHub Student Pack? - -GitHub controls the approval process for the GitHub Student Pack. If you have questions about the status of your application, please email education@github.com. - -Once you get approved, all you need to do is sign into your GitKraken account with your GitHub account 1 more time. - -### I got the student pack but I don't see Pro when I open GitKraken. What should I do? - -Once GitHub has approved your pack, you must sign into your GitKraken account through GitHub 1 more time to enable Pro. - -If you are still not seeing Pro, sign out of GitHub.com in your default browser. Next, in GitKraken, go to `File > Sign in to a different account > Sign in with GitHub` - - - -Lastly, log into your GitHub.com account using the email address that has the GitHub Pack. - - - -Once authorized, you can go back to GitKraken, and you should see `PRO` in the lower right-hand corner. If you continue not seeing `PRO`, you must confirm with GitHub that you still have the student pack. They can be reached at education@github.com. - -### How long will I have Pro as a student or teacher? - -You will have Pro while you have an active GitHub Student Pack. Once the pack expires, your GitKraken Pro access will expire too. - -### Can I use my GitKraken Pro license on more than one computer? - -Yes, your GitKraken subscription is associated with your email address, not a specific computer. So you can use GitKraken Desktop on as many computers as you'd like! - -### How do I reverify my GitHub Student Developer Pack? - -To verify or reverify your GitHub Student Developer Pack, sign into GitKraken using GitHub again. Follow the instructions outlined [here](gk-dev/gk-dev-edu-pack/#i-got-the-student-pack-but-i-dont-see-pro-when-i-open-gitkraken-what-should-i-do). - -### How do I report a bug or vulnerability? - -To report a bug, join our [Public Slack](https://www.gitkraken.com/join-slack-community) and report the issue in any channel. Make sure to @keif in your report or you can send Keif a direct message. - -To report a Security vulnerability, please email security@gitkraken.com. - -### How do I submit a request related to my rights under GDPR? - -If your team needs all account data deleted permanently upon cancellation, please email compliance@gitkraken.com with such requests. Please note, deletion of data is irreversible. - -### I have a question about purchasing GitKraken. - -Please reach out to our [Success team](https://www.gitkraken.com/sales-inquiries) for any questions regarding purchasing. - diff --git a/gk-dev/gk-dev-faq.md b/gk-dev/gk-dev-faq.md index 9f7093d..d191ace 100644 --- a/gk-dev/gk-dev-faq.md +++ b/gk-dev/gk-dev-faq.md @@ -4,85 +4,93 @@ title: GitKraken Accounts and Licenses FAQ description: Here are the most common questions about GitKraken accounts and licenses. taxonomy: category: gk-dev - + --- +Last updated: June 2025 + ### GitKraken automatically put me in a trial. Is there a way to use the app without the trial? -All new GitKraken accounts will automatically get a GitKraken trial of all paid client features. +All new GitKraken accounts automatically begin a 14-day trial of all paid features. -If you plan to use the free version, the trial will automatically end after 7 days and the app will change to the free version. +If you plan to use the free version, simply let the trial expire—GitKraken will revert to the free plan. -If you have questions about your trial, please [contact our sales team](https://www.gitkraken.com/sales-inquiries). +If you have questions, please [contact our sales team](https://www.gitkraken.com/sales-inquiries). *** -### I just subscribed but I still fee FREE in the lower right corner. +### I just subscribed but I still see FREE in the lower right corner. + +Make sure you’re logged in with the same email address tied to your paid subscription. -Be sure you are logged in with the same email address registered with your paid GitKraken subscription. You can check by navigating to Sign into a different account, and then verify that your email is correct. +To check, navigate to: + Sign into a different account *** ### Can I transfer account ownership? -Yes. If you are the `Owner` of a Paid subscription, then you may [transfer ownership](/gk-dev/gk-dev-organization/#transfer-ownership) to a different user on your account from [gitkraken.dev/settings/organization](https://gitkraken.dev/settings/organization). +Yes. If you're the `Owner` of a Paid subscription, you can [transfer ownership](/gk-dev/gk-dev-organization/#transfer-ownership) to another user from [gitkraken.dev/settings/organization](https://gitkraken.dev/settings/?source=help_center&product=gitkraken_dot_dev). - +
+ +
Transfer ownership screen in GitKraken.dev
+
*** -### How do I transfer the ownership if I only have a single license? +### How do I transfer ownership if I only have a single license? -First, add the user with the role [Billing Contact](/gk-dev/gk-dev-organization/#roles) - this does not consume a license - and then transfer the ownership to them. +First, add the new user as a [Billing Contact](/gk-dev/gk-dev-organization/#roles)—this doesn’t consume a license. Then transfer ownership. *** ### Do I need a license to manage users? -A licensed Owner or Admin may manage other Admin or general users. However, the unlicensed Billing Contact role may view the users list and add or remove general users. +Licensed Owner or Admin users can manage others. An unlicensed Billing Contact can view, add, or remove general users. -The User role does not have permission to allocate, edit or remove users. +The User role does not have permissions to edit users. *** -### Can I pay using a Purchase Order. +### Can I pay using a Purchase Order? -We only accept credit card payments for GitKraken Pro and Teams. We do however accept purchase orders for [GitKraken On-Premise or On-Premise Serverless](https://gitkraken.com/pricing). Please [contact our sales team](https://www.gitkraken.com/sales-inquiries) for more information. +For GitKraken Pro and Teams, we accept only credit card payments. Purchase orders are accepted for [GitKraken On-Premise or On-Premise Serverless](https://gitkraken.com/pricing). [Contact our sales team](https://www.gitkraken.com/sales-inquiries) for more info. *** -### When are invoices sent when I purchase a paid license? +### When are invoices sent? -Invoice copies are emailed to the purchaser (Owner or Billing Contact) from `accounting@gitkraken.com` immediately upon purchase. You can also obtain a copy by going to [Billing History](https://gitkraken.dev/subscription/history). +Invoice copies are emailed immediately to the purchaser (Owner or Billing Contact) from `accounting@gitkraken.com`. You can also download them from your [Billing History](https://gitkraken.dev/subscription/history?source=help_center&product=gitkraken_dot_dev). *** -### I'm just a single-user using GitKraken Pro. What do I put for the Organization/Company field? +### I'm a single-user. What should I enter in the Organization/Company field? -Enter a value of your choice. Most use "Personal" or "Self". +Use a value of your choice—common options include "Personal" or "Self". *** -### I just purchased a license. Where is my key? Shouldn't I get emailed a license? +### Where is my license key? -You license is tied to your email. While GitKraken Desktop is a downloadable application, there is no key for your account. All GitKraken licenses are managed from [gitkraken.dev](https://gitkraken.dev/). Additionally, any users you add to your account will be emailed a link to activate their account automatically. +Your license is email-based. There is no key. All licenses are managed at [gitkraken.dev](https://gitkraken.dev/?source=help_center&product=gitkraken_dot_dev). Any added users receive an activation email. *** -### Can I use my paid GitKraken subscription on more than one computer? +### Can I use GitKraken Pro on multiple computers? -Yes, your paid GitKraken subscription is associated with your email address, not a specific computer. So you can use GitKraken Pro on as many computers as you'd like! +Yes! Your license is tied to your email address, not to a specific device. *** -### What happens to my GitKraken Desktop when my subscription expires? +### What happens when my subscription expires? -Your GitKraken Desktop will revert to the free version when the paid subscription expires. You will not lose any data, but the client will not open any private repos and you will only retain access to 1 [profile](/gitkraken-desktop/profiles/). +Your GitKraken Desktop will revert to the free version. You won’t lose any data, but private repos will be inaccessible, and you’ll have access to only one [profile](/gitkraken-desktop/profiles/). -If using the GitKraken Stand-Alone Client, the client will lock upon license expiration until an updated license file is applied. +If you're using the Serverless client, the app locks upon expiration until a new license file is applied. *** -### I will pay using a credit card, but I need the credit card details removed after purchase. +### I need my credit card info removed after purchase. -Please [contact our accounting team](https://www.gitkraken.com/billing-issues) with any request to manually remove billing details from an account. We typically fulfill these requests within 1 business day. +Please [contact our accounting team](https://www.gitkraken.com/billing-issues?source=help_center&product=gitkraken_dot_dev). Most requests are completed within one business day. diff --git a/gk-dev/gk-dev-home.md b/gk-dev/gk-dev-home.md index e9ac854..00d8ff5 100644 --- a/gk-dev/gk-dev-home.md +++ b/gk-dev/gk-dev-home.md @@ -1,113 +1,156 @@ --- - title: GitKraken.dev Support Home -description: Learn how to work with gitkraken.dev features +description: Learn how to work with GitKraken.dev features including Launchpad, Cloud Patches, Workspaces, and Code Suggestions. taxonomy: category: gk-dev - --- - GitKraken.dev is your command center for understanding the status of your development projects and teams. See pull requests and issues relevant to you, gain clear insights into your workflows, collaborate with your team, and begin working all within a browser via desktop or mobile. In addition to working with repositories, you can manage your Organization, Subscription and Security Controls. +Last updated: June 2025 - +GitKraken.dev is a browser-based Git project management app. From tracking issues and pull requests to organizing repositories with your team, GitKraken.dev helps you stay productive directly from your browser. + +
+ GitKraken.dev dashboard overview +
Overview of the GitKraken.dev dashboard
+
*** -## Launchpad +## Launchpad: Your Daily Git Dashboard -
-

This Feature is only available for Pro subscription tiers or higher

-
+The Launchpad offers a real-time summary of pull requests and issues based on your filters, helping you take action faster without context-switching. -The Launchpad provides you with a summary of pull requests and issues relevant to you for the filtered selection and allows you to take action on these items. Instead of hunting for these pieces of information separately, you can get a holistic view of what you’re working on. To begin working with the Launchpad, start by connecting an [integration](/gk-dev/gk-dev-integrations/) to see your issues and pull requests. +Connect an [integration](/gk-dev/gk-dev-integrations/) to begin. - +
+

This feature is only available on Pro or higher plans. See pricing options.

+
-### Launchpad Actions +### Take Quick Actions from Launchpad -From the Launchpad you can begin working with pull requests and issues by taking actions on them from the actions column. Quickly update pull request or issue fields, open branches in GitKraken Desktop or VS Code, merge or close pull requests, open [code suggestions](/gk-dev/gk-dev-home/#code-suggest), and much more. +Use the actions column to update fields, open branches in GitKraken Desktop or VS Code, merge or close pull requests, and open [code suggestions](/gk-dev/gk-dev-home/#code-suggest-pro). - +
+ Launchpad action options for PRs and issues +
Quick actions available for pull requests and issues
+
-### Organizing the Launchpad +### Refine Results with Filters -To change or narrow down your items shown, use the filters under the search bar. Select the desired service for your pull requests and issues, show only items where you are assigned/created/mentioned, or filter further based on [workspaces](/gk-dev/gk-dev-home/#workspaces). +Filter the Launchpad by services, statuses (assigned/created/mentioned), or [workspaces](/gk-dev/gk-dev-home/#workspaces). - +
+ Launchpad filter options to refine visible items +
Use filters to narrow down visible tasks
+
-To organize further, items in the Launchpad can be pinned, to move the item to the top of the list, and can be snoozed, to be hidden under the SNOOZED section. To pin or unpin and item, click the pin in the pin column. To snooze an item, hover over an item, select the snooze icon, and select the desired time option - selecting snooze will snooze the item until it is manually unsnoozed. To unsnooze an item, click on the `SNOOZED` section header, hover over the desired item and select the unsnooze icon for that item. +Pin items for priority or snooze them to hide under the SNOOZED section. Return to the SNOOZED section to unsnooze. - +
+ GIF showing pinning and snoozing actions in Launchpad +
Pin or snooze tasks for focused attention
+
*** ## Cloud Patches `PRO` -A Cloud Patch is a Git patch that GitKraken securely stores for you so it can be easily shared with others across GitKraken Desktop, GitLens, and the GitKraken CLI. The patch is directly transferred from your machine into secure storage or on your own [AWS S3 bucket](/gk-dev/gk-dev-security-controls/#self-hosted). Cloud Patches allow the ability to engage early with your team before a pull request. +Cloud Patches let you securely store and share Git patches without a pull request. Create them using GitKraken Desktop, GitLens, or the GitKraken CLI. Store them on GitKraken servers or your own [AWS S3 bucket](/gk-dev/gk-dev-security-controls/#self-hosted).
-

This Feature is only available for Pro subscription tiers or higher

+

This feature is only available on Pro or higher plans. See pricing options.

-### Creating a Cloud Patch +### Create and Share Cloud Patches -They can be created from [GitKraken Desktop](/gitkraken-client/experimental-features/#cloud-patches), [GitLens](gitlens/gitlens-features/#cloud-patches-preview), and the [GitKraken CLI](/cli/cli-home/#cloud-patches). From gitkraken.dev you can manage all Cloud Patches, including ones that have been shared with you. +Initiate patches from [GitKraken Desktop](/gitkraken-client/experimental-features/#cloud-patches), [GitLens](gitlens/gitlens-features/#cloud-patches-preview), or [GitKraken CLI](/cli/cli-home/#cloud-patches). Manage shared Cloud Patches from gitkraken.dev. - +
+ List of cloud patches in GitKraken.dev +
View and manage shared Cloud Patches
+
-### Working with Cloud Patches +### Apply and Review Patches -Select `Open` to view the files and diffs included in the Cloud Patch. From here, you can open the Cloud Patch in [GitKraken Desktop](/gitkraken-client/experimental-features/#cloud-patches) or [GitLens](gitlens/gitlens-features/#cloud-patches-preview) to then apply the Cloud Patch to a specific branch. +Select `Open` to view patch contents. Open patches in GitKraken Desktop or GitLens to apply them. - +
+ Open and review contents of a Cloud Patch +
Review patch details before applying
+
*** -## Workspaces +## Workspaces: Organize Projects by Team -GitKraken Workspaces allow you to create easily accessible groups of repositories and share them with your organization members or [teams](/gk-dev/gk-dev-organization/#teams) to work with in gitkraken.dev, [GitKraken Desktop](/gitkraken-client/workspaces/), [GitLens](/gitlens/side-bar/#workspaces-☁%ef%b8%8f), and the [GitKraken CLI](/cli/cli-home/#create-workspaces-to-group-repos). +Use Workspaces to group repositories for teams or organizations using GitKraken.dev, GitKraken Desktop, GitLens, or GitKraken CLI. - +
+ Workspace list showing multiple repo groups +
Group repositories under shared Workspaces
+
-### Creating a Workspace +### Set Up a New Workspace -To create a workspace, first connect the [integration](/gk-dev/gk-dev-integrations/) for the desired service. Once connected, select `Create Workspace`, provide a name, select a provider, and optionally provide a photo, description, or share with teams or members. +Connect a [service integration](/gk-dev/gk-dev-integrations/), select `Create Workspace`, name it, choose a provider, and set sharing preferences. - +
+ Create a new workspace modal +
Customize your Workspace with settings and visuals
+
-### Working with Workspaces +### Use Workspaces Across Tools -Select `Open Launchpad` to filer the Launchpad by the selected workspace for pull requests and issues. Additionally, workspaces can be used in [GitKraken Desktop](/gitkraken-client/workspaces/), [GitLens](/gitlens/side-bar/#workspaces-preview), and the [GitKraken CLI](/cli/cli-home/#create-workspaces-to-group-repos) to perform actions on multiple repositories, view repositories status at a glance, and much more. +Click `Open Launchpad` to focus on that Workspace’s repositories. Perform Git actions in your preferred GitKraken tool. - +
+ Open workspace to view associated repositories +
Work across repositories from a single Workspace
+
-### Requirement for Azure Workspaces and Insights +### Azure Configuration for Workspaces & Insights -In order to work with Workspaces and [Insights](/gk-dev/gk-dev-insights) for Azure, `Third-party application access via OAuth` will need to be enabled in Azure from `Organization Settings > Policies`. You can find more information on this setting [here](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/change-application-access-policies?view=azure-devops). +To use Workspaces or [Insights](/gk-dev/gk-dev-insights) with Azure DevOps, enable `Third-party application access via OAuth` in Azure’s Organization Settings. [Learn more from Microsoft](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/change-application-access-policies?view=azure-devops). *** ## Code Suggest `PRO` -GitKraken Code Suggest simplifies code review by allowing you to make suggestions and edits across the entire project, not just on the lines that were changed, within gitkraken.dev, GitLens, and GitKraken Desktop. When a Pull Request is open, you can make suggestions to the pull request that others can then review and accept to include in the pull request. +Suggest code edits across your codebase—not just changed lines—using GitKraken.dev, GitLens, or GitKraken Desktop. Suggestions appear in the pull request for review. - +
+ Suggesting code changes within a pull request +
Post suggested edits across your project
+
-

This Feature is only available for Pro subscription tiers or higher

+

This feature is only available on Pro or higher plans. See pricing options.

### Working with Code Suggestions -Code Suggestions can be created from [GitKraken Desktop](/gitkraken-client/pull-requests/#review-code-and-suggest-changes), [GitLens](gitlens/gitlens-features/#code-suggest-preview), and the [GitKraken CLI](/cli/cli-home/#code-suggest) - see linked Help Center documentation for creating and working with them in each. +Create suggestions in [GitKraken Desktop](/gitkraken-client/pull-requests/#review-code-and-suggest-changes) or [GitLens](gitlens/gitlens-features/#code-suggest-preview). -Once a suggestion is created, it will include a comment on the pull request with two options: you can select _Code Suggestion for #PR_ to open the suggestion in gitkraken.dev or select _locally on your machine_ to open the suggestion in GitKraken or GitLens. +Once submitted, the pull request includes a comment with links to open the suggestion in GitKraken.dev or on your machine. - +
+ PR comment with code suggestion options +
Choose where to review code suggestions
+
-When selecting the _Code Suggestion for #PR_ you will be taken to gitkraken.dev to review and accept the changes. Here, you can review the changes by selecting each file and once you are ready, you can select _Commit Suggestions_. This will create a new commit on the remote for the existing branch (shown under _COMMIT SUGGESTIONS TO_). +Select _Code Suggestion for #PR_ to open in GitKraken.dev and review the changes. Accepting adds a commit to the remote branch. - +
+ GIF showing how to accept a code suggestion +
Review and accept code suggestions in GitKraken.dev
+
+*** +## Next Steps +Explore more GitKraken.dev documentation: +- [Integrations](/gk-dev/gk-dev-integrations/) +- [Organization Management](/gk-dev/gk-dev-organization/) +- [Security Controls](/gk-dev/gk-dev-security-controls/) +- [Insights](/gk-dev/gk-dev-insights/) diff --git a/gk-dev/gk-dev-insights.md b/gk-dev/gk-dev-insights.md index cdc47d5..cc2ee2e 100644 --- a/gk-dev/gk-dev-insights.md +++ b/gk-dev/gk-dev-insights.md @@ -1,77 +1,100 @@ --- - -title: Insights `Pro` -description: GitKraken Insights is a powerful tool that helps you visualize how pull requests are merged into your repositories. +title: Getting Started with GitKraken Insights +description: Learn how to request access, understand plan availability, and connect your data in GitKraken Insights. taxonomy: category: gk-dev +--- +Last updated: December 2025 + +GitKraken Insights turns raw Git data into clear, useful metrics for developers and leaders. It pulls code activity, pull requests, issues, and CI/CD results into a single view that fits directly into existing workflows. + +Instead of surface-level stats, Insights shows how work connects to team goals and points out ways to improve flow and productivity. + +
+ Overview of GitKraken Insights +
Overview of GitKraken Insights
+
--- -GitKraken Insights is a powerful tool that helps you visualize how pull requests are merged into your repositories. It provides a visual representation of your repository's history, allowing you to see how your codebase has evolved over time. You can use this information to make informed decisions about how to improve your workflow. +## Request Access -Insights is available for Github.com, Bitbucket.org, Gitlab.com, and Azure DevOps (Hosted). +GitKraken Insights is available by request only. To get started, [request a guided tour](https://www.gitkraken.com/insights#form). - + A member of the GitKraken team will contact you right away to walk you through Insights and explain how to enable access for your organization. -
-

This Feature is only available for Pro subscription tiers or higher

-
+**Note:** Insights is available as an add-on to the seats in your existing GitKraken subscription, or as a discounted standalone solution for developers on your team who don't use GitKraken. -
-

- Note: Insights is in Preview mode, and we'd love to hear your thoughts and feedback. Just click on the "Feedback" button in the top right to tell us what you think. -

-
+--- + +## Connecting your data -*** +Once your access is approved, you can connect Insights to your repositories and configure settings for your organization. -## How do I use GitKraken Insights? +Currently, Insights supports connections with GitHub, GitLab and Jira Cloud. Support for Bitbucket and Azure DevOps is coming soon. + +--- -Insights can be accessed from [gitkraken.dev/insights](https://gitkraken.dev/insights). +### 1. Repo import -In order to work with Insights, you will need to: -* [Connect an integration](/gk-dev/gk-dev-integrations/) from [gitkraken.dev/settings/integrations](https://gitkraken.dev/settings/integrations) -* And create a [Cloud Workspace](/gk-dev/gk-dev-home/#workspaces) from [gitkraken.dev/workspaces](https://gitkraken.dev/workspaces) +1. In GitKraken.dev, go to **Insights > Data Connection**. +2. Click to connect with GitHub, GitLab, or Jira Cloud. + > Support for Bitbucket and Azure DevOps, is coming soon. +3. Authorize GitKraken Insights by GitClear to connect with GitHub. +4. Select which repositories to track. Use the filter option at the top of the page to quickly narrow down the list. -Once you have done both, you will be able to filter by a workspace to see the Insights for the repositories in that workspace. You can also filter by date range. - +
+ Overview of GitKraken Insights +
Connect GitHub, GitLab, or Jira to enable Insights
+
-
-

- When using Insights, we will attempt to add webhooks to your workspace repositories in order to reduce API calls and improve data performance. -

-

- Filtering by 14 days is available for Teams subscriptions and filtering by 28 days is available for Enterprise Subscriptions. -

-
+
+ Overview of GitKraken Insights +
Authorize GitHub access for GitKraken Insights
+
-### Requirement for Azure Insights and Workspaces +
+ Overview of GitKraken Insights +
Select which repos to import. You can always import more later.
+
-In order to work with Insights and [Workspaces](/gk-dev/gk-dev-home/#workspaces) for Azure, `Third-party application access via OAuth` will need to be enabled in Azure from `Organization Settings > Policies`. You can find more information on this setting [here](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/change-application-access-policies?view=azure-devops). +#### Avoiding GitHub API rate limits -*** +If you're importing a large number of repositories—typically over 100, depending on size and commit history—you may encounter GitHub's hourly API rate limits. This can temporarily throttle other GitHub services used by your organization. -## Metrics +To avoid this, additional members of your organization can connect to Insights using a [Lead role](/gk-dev/gk-dev-organization/#roles). When multiple Leads are connected, GitClear distributes processing across their GitHub tokens to help avoid throttling. -Insights offer the following metrics. You can also hover over the icon to see a description of the metric. +After the initial import is complete, rate limit issues are unlikely to recur. -* **Cycle Time**: Measures the average time it takes for a pull request to be merged for the selected timeframe. -* **Average Throughput**: Measures the average number of pull requests merged for the selected timeframe. -* **Merge** Rate: The percentage of merged pull requests compared to open pull requests for the selected timeframe. -* **Open**: The total number of pull requests opened for the selected timeframe. -* **Merged**: The total number of pull requests merged for the selected timeframe. -*** +--- + +### 2. Setup role + +After connecting repositories, confirm your personal details: + +- First and last name +- Time zone +- Job role + +
+ Overview of GitKraken Insights +
Confirm your details before continuing
+
+ + +--- -## Export Insights Data +### 3. Data import progress -Insights data can be exported into a CSV by selecting "Export CSV" in the top right. +Once setup is complete, Insights will begin importing your repository data. - +- Expect **past month’s activity** to appear within a few hours. +- Full **year’s activity** is usually ready within one to two days. +- Track import progress anytime from the **Dashboard** tab. -
-

- Note: Exporting is only available for Enterprise subscriptions. -

-
\ No newline at end of file +
+ Overview of GitKraken Insights +
Monitor import progress while Insights processes your data
+
\ No newline at end of file diff --git a/gk-dev/gk-dev-integrations.md b/gk-dev/gk-dev-integrations.md index 3ac9186..8b034bc 100644 --- a/gk-dev/gk-dev-integrations.md +++ b/gk-dev/gk-dev-integrations.md @@ -1,23 +1,52 @@ --- - -title: Integrations -description: Learn how to work with integrations on gitkraken.dev +title: Connect GitHub, GitLab, Azure Integrations +description: Step-by-step guide to connecting GitHub, GitLab, Bitbucket, and self-hosted integrations on GitKraken.dev for Launchpad, Insights, Workspaces, and Cloud Patches. taxonomy: category: gk-dev - --- -Connect integrations on gitkraken.dev to begin working with Launchpad, Workspaces, Cloud Patches, and more. +Last updated: June 2025 + +Connect integrations on GitKraken.dev to use features like Launchpad, Workspaces, and Cloud Patches. Supported integrations include GitHub, GitLab, Bitbucket, Azure DevOps, and self-hosted options. *** -Integrations can be connected from https://gitkraken.dev/settings/integrations. To connect an integration, select the desired integration under **Add Integration**. +## How to Connect an Integration + +Go to the Integrations page in GitKraken.dev and follow the instructions based on the type of integration. + +### 1. Cloud-Based Integrations (GitHub, GitLab.com, Bitbucket.org, Azure DevOps) + +1. Under **Add Integration**, select your service. +2. Log into your account. +3. Approve access when prompted to authorize GitKraken. -- For Cloud integrations: Log in to the desired account and then approve access for GitKraken. -- For Self-Hosted/Server integrations: Fill out Host Domain, select `Generate a token on {service}` - this will open the service on the PAT creation page with the required scopes - fill out the PAT and then select `Connect`. +### 2. Self-Hosted or Server-Based Integrations - +1. Under **Add Integration**, select your self-hosted service (e.g., GitHub Enterprise). +2. Enter the Host Domain. +3. Click **Generate a token on {service}**. + - This opens a pre-filled Personal Access Token (PAT) creation page. +4. Create the PAT. +5. Paste the token into GitKraken. +6. Click **Connect**. + +
+ Connecting GitHub and GitLab integrations in GitKraken.dev +
Integration settings page on GitKraken.dev
+
-

Note for GitHub.com: In order to work with repositories owned by a GitHub organization, the organization will need to allow Organization Approval for GitKraken.

-
\ No newline at end of file +

To access repositories owned by a GitHub organization, organization approval is required. Request organization approval.

+ + +*** + +## What’s Next? + +Once connected, you can: +- Use [Launchpad](/gk-dev/gk-dev-home/#launchpad-your-daily-git-dashboard) to track PRs and issues. +- Organize repos into [Workspaces](/gk-dev/gk-dev-home/#workspaces-organize-projects-by-team). +- Share [Cloud Patches](/gk-dev/gk-dev-home/#create-and-share-cloud-patches). + +Return to the [GitKraken.dev Support Home](/gk-dev/gk-dev-home/) to explore more features. diff --git a/gk-dev/gk-dev-organization.md b/gk-dev/gk-dev-organization.md index 9098273..587c4bb 100644 --- a/gk-dev/gk-dev-organization.md +++ b/gk-dev/gk-dev-organization.md @@ -1,79 +1,29 @@ --- - -title: Manage GitKraken Organization -description: Learn about GitKraken Organizations +title: Manage GitKraken Organizations | Roles, Users, Teams, SSO +description: Learn how to manage GitKraken organizations, assign roles, add users, configure teams, and set up SSO. taxonomy: category: gk-dev - --- -A GitKraken organization is a collection of [GitKraken accounts](/gk-dev/gk-dev-account/) which unlocks a shared [subscription](/gk-dev/gk-dev-subscription/), collaboration features between members, and administration of the members in the organization. If you are creating an account for the first time, an organization will automatically be created for you. -
-

Community users are a single user plan, and can not perform any org management. Pro plans and above can perform Org management functions.

-
-*** - -## Add users - -To add someone to your organization, go to [gitkraken.dev](https://gitkraken.dev/), select your organization dropdown in the top left, select "Users", and finally select "Add Users." - - +Last updated: June 2025 -Here you can enter as many email addresses as you want and the [role](/gk-dev/gk-dev-organization/#roles) (in the drop down) you would like to assign them all. - - - -Only members that have a [role](/gk-dev/gk-dev-organization/#roles) with permission can add users to an organization. When you do add someone, it will consume a license of your subscription. If all available licenses are consumed when adding a user, a billing summary will show up during the process, select "Purchase" to complete the transaction and add the users. - - - -You can also add licenses in bulk to your organization separately from adding users by going to the [Subscription](/gk-dev/gk-dev-subscription/) section in your organization. - -*** - -## Inviting users to your organization +Create an organization in GitKraken.dev to manage your team’s access, roles, licenses, and SSO. Centralize your GitKraken [subscription](/gk-dev/gk-dev-subscription/) to simplify provisioning and oversight across all GitKraken products. -As a User, you have the ability to invite other users to the organization for an Owner, Admin, or Billing Contact to approve and/or purchase a license for. - -To invite a user, navigate to gitkraken.dev > Users > Invite Users. Then provide the email(s) of the desired user(s). - - - -This will send an email to any Owner, Admin, or Billing Contact to review the invited user. They can select `Review` on the email or see the invitees from gitkraken.dev > Users > Review. Here, they can Approve or Deny the user. If your organization is at its user limit, you will be prompted to purchase an additional license when approving. - - - -*** - -## Reallocate licenses - -Any Owner, Admin, or Billing Contact may remove users and then add users to reallocate licenses. - -The Billing Contact role cannot remove or edit Owner or Admin users. - -To reallocate a license, navigate to Users and then select "Remove" for the desired user. Then, you can add the new user. - -*** - -## Import and export users - -To import multiple users via CSV select the “Add User” button. From here you can select “Import via CSV”. When importing users, be sure to have columns for `Email`, `Username`, `Role`, `User License`. - - - -To export users to a CSV, select “Export via CSV”. The export will contain columns for Email, Username, Role, User License. - - +
+

Community users are on a single-user plan and cannot perform any organization management. Pro plans and higher can manage users, roles, teams, and settings.

+
*** ## Roles -Roles grant members permissions within an organization. There are four roles a user may have: -+ Owner: there must be exactly one owner per organization. Owners have full permission and consume a license. -+ Admin: Admins have full permissions and consume a license. Admins cannot remove or edit the owner. -+ User: Users have no administrative permissions but do consume a license. -+ Billing Contact: Billing Contacts have the same permissions as admins, except they do not consume a license. +Roles determine what permissions a member has within your organization. There are four roles available: + +- **Owner** – Each organization has one owner by default. The owner has full administrative and billing permissions and consumes a license. +- **Admin** – Has full administrative and billing permissions and consumes a license. Admins cannot change or remove the owner. +- **User** – Can manage teams but no other administrative permissions. This role consumes a license. +- **Lead** – Has access to GitKraken Insights and can manage teams but no other administrative permissions. This role consumes a license. +- **Billing Contact** – Manages billing-related settings and receives invoices. This role does not consume a license. @@ -81,13 +31,15 @@ Roles grant members permissions within an organization. There are four roles a u + - + + @@ -98,13 +50,15 @@ Roles grant members permissions within an organization. There are four roles a u + - + + @@ -112,6 +66,7 @@ Roles grant members permissions within an organization. There are four roles a u + @@ -120,43 +75,233 @@ Roles grant members permissions within an organization. There are four roles a u + + + + + + + + + + + + + + + + + + + + + + + + +
Permission Owner AdminLead User Billing Contact
Licensed to use GitKrakenLicensed to use paid GitKraken features
Create and manage teams
Connect data sources to GitKraken Insights
Access and manage GitKraken Insights
Assign and manage Insights licenses
*** +## Add users + +To add someone to your organization, go to [gitkraken.dev](https://gitkraken.dev/?source=help_center&product=gitkraken_dot_dev), open the organization dropdown in the top left, select **Users**, then click **Add Users**. + +
+ Add Users screen in GitKraken +
Access the Add Users screen from the Users tab
+
+ +You can enter multiple email addresses and select the [role](/gk-dev/gk-dev-organization/#roles) from the dropdown to assign to all users. + +
+ Add users modal with email and role fields +
Enter emails and assign a role to each new user
+
+ +Only members with a [role](/gk-dev/gk-dev-organization/#roles) that includes user management permissions can invite others. Adding a user consumes a license from your subscription. If you exceed your license count during this step, a billing summary will appear. Select **Purchase** to complete the transaction and add the users. + +
+ Modal showing additional license purchase required +
Purchase additional licenses if needed when adding users
+
+ +You can also purchase extra licenses in advance from the [Subscription](/gk-dev/gk-dev-subscription/) section. + +*** + +## Inviting users to your organization + +As a **User**, you can invite others to your organization. These invitations must be reviewed and approved by an Owner, Admin, or Billing Contact. + +To invite someone: + +1. Go to [gitkraken.dev](https://gitkraken.dev/?source=help_center&product=gitkraken_dot_dev) +2. Select your organization from the top-left dropdown +3. Navigate to **Users > Invite Users** +4. Enter the email address(es) of the person you want to invite + +
+ User invite screen in GitKraken +
Submit user invitations for approval
+
+ +Once submitted, Owners, Admins, or Billing Contacts will receive an email notification. They can click **Review** from the email or go to **Users > Review** in the GitKraken interface to approve or deny the invitation. If your organization is at its user limit, approving an invite may prompt a license purchase. + +
+ Review and approve user invitation interface +
Approvers can approve, deny, or assign licenses to new users
+
+ +*** + +## Reallocate licenses + +Owners, Admins, and Billing Contacts can remove existing users to free up licenses, then add new users in their place. + +> **Note:** Billing Contacts cannot remove or edit Owner or Admin users. + +To reallocate a license: + +1. Navigate to **Users** +2. Click **Remove** next to the user you want to remove +3. Invite or add a new user to use the available license + +*** + +## Import and export users + +To import multiple users via CSV, click the **Add Users** button, then choose **Import via CSV**. Be sure your file includes the following columns: `Email`, `Username`, `Role`, `User License`, and optionally `Teams`. + +### User Import CSV Format + +Your CSV file should include these columns: + +| Column | Required | Description | +|--------|----------|-------------| +| Email | Yes | User's email address | +| Username | Yes | User's username | +| Role | Yes | User's role (Owner, Admin, User, or Billing Contact) | +| Teams | No | Teams to add the user to (separate multiple teams with semicolons) | + +**Example CSV for user import:** +```csv +Email,Username,Role,Teams +john.doe@gitkiraken.com,johndoe,user,Frontend Team;Design Team +jane.smith@gitkiraken.com,janesmith,admin,Backend Team +bob.wilson@gitkiraken.com,bobwilson,user,Frontend Team +ashton.kutcher@gitkiraken.com,ashtonkutcher,user,Design Team +constance.baker@gitkiraken.com,constancebaker,user,Design Team +``` + +> **Note:** When you include teams in the CSV, these must already exist. Otherwise, gitkraken.dev will ignore the teams column. A single semicolon is used to separate multiple teams. + +
+ CSV import modal in GitKraken +
Import multiple users via a formatted CSV file
+
+ +To export your current user list to CSV, click **Export via CSV**. The export will include columns for Email, Username, Role, User License, and Teams. + +
+ CSV export button in GitKraken +
Export a CSV of your organization's members
+
+ +*** + ## Teams -Teams are the best way to organize members of your GitKraken organization. In addition, teams can create Shared Workspaces to bring focus to their collaborative work and help identify conflicts by showing what files and branches your team is working on. +Teams help you organize members within your GitKraken organization. Teams can also create Shared Workspaces to stay aligned on collaborative work and avoid merge conflicts by seeing what files and branches team members are working on. + +Any member can create a team from the **Teams** tab in your organization at [gitkraken.dev](https://gitkraken.dev?source=help_center&product=gitkraken_dot_dev). For details on creating and working with teams, visit the [Teams](/gitkraken-desktop/teams/) documentation. + +### Bulk Import Teams + +To import multiple teams via CSV, go to the **Teams** tab and click **Create Team**, then choose **Import via CSV**. This allows you to create multiple teams at once and optionally add existing users to those teams. + +#### Team Import CSV Format + +Your CSV file should include these columns: + +| Column | Required | Description | +|--------|----------|-------------| +| Team Name | Yes | Name of the team to create | +| Users | No | Existing users to add to the team (separate multiple users with semicolons) | + +**Example CSV for team import:** +```csv +Team,Emails +Frontend Team,bob.wilson@gitkiraken.com;john.doe@gitkiraken.com +Backend Team,jane.smith@gitkiraken.com +Design Team,ashton.kutcher@gitkiraken.com;constance.baker@gitkiraken.com;john.doe@gitkiraken.com +``` -Any member can create a team by visiting the Teams tab within the organization at [gitkraken.dev](https://gitkraken.dev). For more information on creating and working with teams, see the [Teams](/gitkraken-desktop/teams/) page. +> **Note:** The Users column is optional. If you include users, GitKraken will add existing users to the teams. Multiple users can be specified in a single cell by separating them with semicolons. Teams will be created if they don't already exist. - +
+ GitKraken organization teams interface +
Use teams to organize members and collaborate efficiently
+
*** ## Organization Settings -Organization settings can be accessed from [gitkraken.dev/settings/organization](https://gitkraken.dev/settings/organization). Visiting the Settings section of your organization will give you a snapshot of your subscription and allow you to edit a few key aspects of your organization like changing the organization name, transferring ownership of the organization, leaving an organization, and setting up single sign-on. +Access your settings at [gitkraken.dev/settings/organization](https://gitkraken.dev/settings/organization?source=help_center&product=gitkraken_dot_dev). From here, you can view subscription details and update: - +- Organization name +- Ownership +- SSO setup +- Organization membership + +
+ Organization settings page +
Update organization settings including name, ownership, and SSO
+
### Transfer ownership -If you’re the [owner](/gk-dev/gk-dev-organization/#roles) of an organization and would like to make someone else the owner you can do that. First you need to make sure to first add that account to the organization. Once the account is added to your organization, go to your organization, select "Settings" and then “Transfer ownership.” You will select the user within the organization to become the owner (and type their email to confirm). Once you select “Transfer Ownership,” the transfer is final and cannot be undone unless the new owner transfers ownership back to the original owner. +If you’re the [owner](/gk-dev/gk-dev-organization/#roles) of an organization and want to assign ownership to someone else: + +1. Make sure the new owner is already added to the organization +2. Go to **Settings > Transfer ownership** +3. Select the user and confirm their email +4. Click **Transfer Ownership** to finalize the change - +> **Note:** Ownership transfers are final unless the new owner reassigns it. + +
+ Transfer ownership workflow +
Transfer organization ownership to another member
+
### Leave an organization -If you no longer need to be a part of an organization, you can leave an organization by navigating to Settings, then Organization and then `Leave Organization`. If you leave an organization, only an admin can invite you back. You will lose access to collaboration with members of GitKraken and your GitKraken paid license. +To leave an organization: + +1. Navigate to **Settings > Organization** +2. Click **Leave Organization** -This option will only be available if you are part of another organization and you are not the owner of the organization. If you are the current owner, you can [transfer the ownership](/gk-dev/gk-dev-organization/#transfer-ownership) and then leave the organization after. +> **Note:** You must be part of another organization and cannot be the current owner. If you are the owner, [transfer ownership](/gk-dev/gk-dev-organization/#transfer-ownership) before leaving. - +Leaving an organization will revoke your GitKraken license and access to shared collaboration features. + +
+ Leave organization screen in GitKraken +
Leave your current GitKraken organization
+
### Single sign-on -Single sign-on (SSO) is available for organizations that require it. See how to setup SSO by visiting our [Single Sign-On documentation](/gk-dev/gk-dev-single-sign-on/). +Single sign-on (SSO) is available for organizations that require it. For setup steps, visit the [Single Sign-On documentation](/gk-dev/gk-dev-single-sign-on/). + + +### Next Steps +- [Connect an Integration](/gk-dev/gk-dev-integrations/) +- [Learn how to manage your GitKraken subscription](/gk-dev/gk-dev-subscription/) +- [Return to GitKraken.dev Support Home](/gk-dev/gk-dev-home/) \ No newline at end of file diff --git a/gk-dev/gk-dev-reseller.md b/gk-dev/gk-dev-reseller.md index 0351c40..15cb7d0 100644 --- a/gk-dev/gk-dev-reseller.md +++ b/gk-dev/gk-dev-reseller.md @@ -1,85 +1,89 @@ --- - title: GitKraken Reseller Guide -description: For resellers to learn about how to purchase and manage GitKraken Accounts and Organizations +description: Learn how to purchase and manage GitKraken accounts and organizations as a reseller. taxonomy: category: gk-dev - --- +Last updated: June 2025 + ## New Organization Purchases Follow this reseller guide for purchasing and user license management information. *** -### 1. Create an account or sign in +### 1. Create an Account or Sign In -First, create a GitKraken account using your reseller email address by navigating to [gitkraken.dev](https://gitkraken.dev/). +Go to [gitkraken.dev](https://gitkraken.dev/?source=help_center) and create a GitKraken account using your reseller email address. -+ Be sure to create an account using email, do not use the auto-sign-in options (like "sign in with GitHub"). -+ Do not enter end-user information on the account creation form. Resellers should register with their own email. -+ After account creation you will need to verify your email before taking any action. This is done by selecting the link sent to your email. +- Use the email method (not social sign-in options). +- Do not input end-user details. Register using your own email. +- Verify your email address via the link sent to your inbox.
-

If you make GitKraken purchases for multiple customers and already have a GitKraken account, choose to sign into an existing account and continue onto Step 2.

+

If you already use GitKraken for multiple customers, simply log in to your existing account and continue to Step 2.

- - -Once you have created your GitKraken account, your account is tied to the primary email address of whichever method you selected. If you use the email method, you will need to verify your email address with a link sent to your email. +
+ +
Sign in screen for resellers
+
*** ### 2. Purchase -Navigate to `Purchase Subscription`, select the desired subscription type, and set the desired seats. Finally, proceed with filling out the required payment information. +Go to `Purchase Subscription`, choose the subscription type, set the number of seats, and enter payment details.
-

If you need to make a new organization for a separate customer, you can do so at gitkraken.dev/purchase.

+

To create a new organization for a different customer, visit gitkraken.dev/purchase.

-To complete the purchase, input: -**Seats:** Number of licenses for the customer -**Organization name:** Organization of the customer -**Payment information:** Enter reseller billing details +- **Seats:** Number of licenses for the customer +- **Organization Name:** Name of the customer's organization +- **Payment Info:** Enter reseller billing information - +
+ +
Purchase subscription screen
+
-

GitKraken Subscriptions only accept card, PayPal, ACH bank payments, and Google Pay. However, invoicing is supported for large purchases of GitKraken Enterprise. Contact our Customer Success team to learn more.

+

We accept card, PayPal, ACH, and Google Pay. Invoicing is available for large GitKraken Enterprise orders. Contact our Customer Success team for invoicing support.

-Once the purchase is complete you will be emailed a copy of your receipt. +After purchase, a receipt will be emailed to you. + +*** ### 3. Transfer Ownership to the Customer -Finally, you will need to [transfer the ownership](gk-dev/gk-dev-organization/#transfer-ownership) to the customer: -* Navigate to [Users](https://gitkraken.dev/users) -* Add the customer with the role [Billing Contact](/gk-dev/gk-dev-organization/#roles) - * This role does not consume a license -* Navigate to [Settings > Organization](https://gitkraken.dev/settings/organization) and transfer the ownership to that user +Follow these steps to transfer the organization: + +1. Go to [Users](https://gitkraken.dev/users?source=help_center) +2. Add the customer as a [Billing Contact](/gk-dev/gk-dev-organization/#roles) +3. Go to [Settings > Organization](https://gitkraken.dev/settings/organization?source=help_center) and transfer ownership -If the customer's email has not been verified, they will receive an email to activate their account and accept the ownership transfer. They have 7 days to accept this and you will remain as owner until they accept it. If the 7 days lapse you can always reinitiate the ownership transfer. +If the customer hasn’t verified their email, they’ll receive an activation link. They have 7 days to accept. If they miss the window, you can reinitiate the transfer. *** ## Existing Organization Purchases -Follow this reseller guide for purchasing additional licenses on an existing account. +Follow these steps to purchase additional licenses: -1. Log into [gitkraken.dev](https://gitkraken.dev/) -2. Select the customer’s organization from the top left dropdown (if you are part of more than one organization) -3. Navigate to the "Subscriptions" tab -4. Update your billing details if needed -5. Select "Edit Plan" -6. Increase Total Users quantity to reflect the total user count including the additional licenses you are purchasing for the customer -7. The Billing Summary will populate the cost of add additional users to the customer account. Please utilize this to provide the customer an official quote for adding users -8. Select “Save.” The customer will have immediate access to the additional licenses +1. Log into [gitkraken.dev](https://gitkraken.dev/?source=help_center&product=gitkraken_dot_dev) +2. Select the customer’s organization from the top-left dropdown +3. Go to the "Subscriptions" tab +4. Update billing info if needed +5. Click "Edit Plan" +6. Increase the total user count +7. Review the Billing Summary for cost and use it as an official quote +8. Click “Save.” The additional licenses will be active immediately.
-

The cost to add users to an existing account is prorated against the billing cycle of the initial purchase of the account.

-

If you are a reseller and the customer’s organization is not listed on your GitKraken account, contact our Customer Success team for assistance.

+

License costs are prorated against the original billing cycle. If a customer org is not listed under your account, contact our Customer Success team.

*** @@ -88,18 +92,18 @@ Follow this reseller guide for purchasing additional licenses on an existing acc ### Upgrade Quote -Here’s how to obtain a quote for an upgrade (either adding licenses or changing plans). +To quote for upgrades (adding seats or changing plans): -1. Log into [gitkraken.dev](https://gitkraken.dev/) -2. Select the customer’s organization from the top left dropdown (if you are part of more than one organization) -3. Navigate to the "Subscriptions" tab -4. Select "Edit Plan" -5. Make the upgrade you would like (either adding licenses or changing plans) but don’t select purchase yet -6. The Billing Summary will populate the cost of the upgrade on the customer’s subscription. Please use this to provide the customer an official quote for the upgrade +1. Log into [gitkraken.dev](https://gitkraken.dev/?source=help_center&product=gitkraken_dot_dev) +2. Select the customer organization +3. Go to "Subscriptions" +4. Click "Edit Plan" +5. Make changes, but don’t purchase +6. Use the Billing Summary as an official quote ### Renewal Quote -1. Log into [gitkraken.dev](https://gitkraken.dev/) -2. Select the customer’s organization from the top left dropdown (if you are part of more than one organization) -3. Navigate to the "Subscriptions" tab -4. The Billing Summary will indicate the Annual Total. Please use this to provide the customer an official quote for the yearly renewal. The date of the renewal is listed as “Next charge” \ No newline at end of file +1. Log into [gitkraken.dev](https://gitkraken.dev/?source=help_center&product=gitkraken_dot_dev) +2. Select the customer organization +3. Go to "Subscriptions" +4. Use the Annual Total in the Billing Summary as the renewal quote. The “Next charge” date indicates the renewal timing. diff --git a/gk-dev/gk-dev-security-controls.md b/gk-dev/gk-dev-security-controls.md index f0d5974..4ecc198 100644 --- a/gk-dev/gk-dev-security-controls.md +++ b/gk-dev/gk-dev-security-controls.md @@ -1,30 +1,126 @@ --- - -title: Security Controls -description: Learn how to work with security controls on gitkraken.dev +title: Security Controls & Cloud Patch Configuration +description: Learn how to manage GitKraken security settings, disable AI features, and configure self-hosted Cloud Patches via AWS S3. taxonomy: category: gk-dev - --- -Manage security controls for your organization and users. +Last updated: June 2025 + +GitKraken provides centralized security settings to help your organization control data-sharing features, enforce compliance, and manage where Git patches are stored. *** -## Gitkraken AI features +## GitKraken AI Features + +GitKraken AI features can suggest code or perform smart actions to improve your workflow. These features may require sending code snippets to GitKraken AI or third-party providers. + +If these features don’t align with your organization's security policies, you can control access across your organization. + +### Manage AI Feature Access + +To enable or disable GitKraken AI features for all organization members: + +- Go to **Settings > Security Controls > AI Features** + - Requires [owner, admin, or billing contact](/gk-dev/gk-dev-organization/#roles) + - Available on [Advanced+ plans](https://www.gitkraken.com/pricing) + +
+ GitKraken AI feature toggle in Security Controls +
Organization-level toggle for GitKraken AI features
+
+ +### Enforce AI Providers + +Organizations on the Business+ plans can enforce restrictions on which AI providers are allowed across GitKraken products. This ensures compliance with your data policies. + +To configure provider-level controls: + +1. Go to **Settings > Security Controls > Enforce AI providers**. +2. Enable the toggle to display supported providers. +3. For each provider, you can: + - Enable: Allow team members to use the provider’s models. + - Disable: Block the provider completely. -The GitKraken suite includes Gitkraken AI features that are intended to speed up your workflow. These features require sending some of your code to Gitkraken AI hosted on the cloud. If you are concerned that AI features do not comply with your company’s data security, you can disable AI features for everyone in your organization. Please note that changing this setting requires you to have the role [owner, admin, or billing contact](gk-dev/gk-dev-organization/#roles) on a [Teams or Enterprise plan](https://www.gitkraken.com/pricing). +For the following marked* providers, you can also: + - Set an API Key: Enforce the use of your key. + - Add a Custom URL (requires a key): Restrict access to a specific endpoint. + +Supported providers include: +- Anthropic* +- Azure* +- DeepSeek +- GitHub Copilot +- GitKraken AI +- Google* +- Hugging Face* +- Mistral* +- Ollama* +- OpenAI* +- OpenAI compatible* +- OpenRouter +- xAI + +
+ AI provider settings showing API key and URL fields +
Example of AI provider configuration fields
+
+ +
+

+ Providers marked with an asterisk (*) support setting a custom API key and URL. +

+

+ These settings apply across all GitKraken products used by your organization. +

+
*** -## Cloud Patches `PRO` +## Cloud Patches + +Allow developers in your organization to create Cloud Patches that can be shared with others. Cloud Patches are encrypted Git patch files that GitKraken can store in GitKraken-managed or customer-managed storage. + +If your company policies require internal storage, you can set up self-hosted Cloud Patches using your own AWS S3 bucket. + +If this setup is not feasible, please contact our customer success team. + +### Self-Host Cloud Patches with AWS S3 -Allow developers in your organization to create Cloud Patches that can be shared with others. A Cloud Patch is a Git patch that is stored securely by GitKraken. If you are concerned that Cloud Patches do not comply with your company’s data security, you can set up self-hosted Cloud Patches for your organization. If this is not an option for you, please [contact our customer success team](https://www.gitkraken.com/sales-inquiries). +Configure your GitKraken organization to store Cloud Patches on your own infrastructure. -### Self-hosted +#### Requirements -You can host your organization’s Cloud Patches on your own AWS S3 bucket. To do so login to https://gitkraken.dev/settings/security, copy the bucket policy by clicking “Copy policy.” Open the AWS Console and navigate to the S3 service. From there, click on the bucket you want to store Cloud Patches. Click the "Permissions" tab and look for the “Bucket policy" section. Click the "Edit" button and paste the bucket policy into the text box. Rename CUSTOMER_BUCKET_NAME with the name of your bucket. Finally, click "Save changes” and return to https://gitkraken.dev/settings/security to test your bucket. +- An AWS account with S3 access +- Admin permissions to apply bucket policies +- GitKraken Pro or Enterprise plan + +#### Setup Steps + +1. **Create an S3 bucket** and give it a meaningful name (e.g., `gitkraken-cloud-patches`). +2. **Apply the GitKraken-supplied bucket policy** using the UI template. +3. **Enter your AWS credentials** into GitKraken: + - Bucket name + - Access key ID + - Secret access key + - AWS region +4. **Test the connection** and save your configuration. + +
+ AWS S3 bucket permissions configuration +
AWS S3 permissions screen for GitKraken Cloud Patches
+
+ +
+

+ GitKraken encrypts all Cloud Patches, even when self-hosted. Only users with access to the patch link and repository permissions can view contents. +

+
+ +*** -Please note to setup self-hosted Cloud Patches require you to have the role [owner, admin, or billing contact](gk-dev/gk-dev-organization/#roles) on an [Enterprise plan](https://www.gitkraken.com/pricing). +## Next Steps - +- [Learn how to use Cloud Patches](/gk-dev/gk-dev-home/#cloud-patches-pro) +- [Manage Org Roles](/gk-dev/gk-dev-organization/#roles) +- [Explore GitKraken.dev Support Home](/gk-dev/gk-dev-home/) diff --git a/gk-dev/gk-dev-security.md b/gk-dev/gk-dev-security.md index c33aeca..0e9cb36 100644 --- a/gk-dev/gk-dev-security.md +++ b/gk-dev/gk-dev-security.md @@ -1,13 +1,15 @@ --- - -title: Security Information for gitkraken.dev -description: Data Security Information for gitkraken.dev +title: Security Information for GitKraken.dev +description: Learn how GitKraken.dev encrypts data in transit and at rest across features like Workspaces, Launchpad, and Cloud Patches. taxonomy: category: gk-dev - --- -Below is a chart outlining some basic security information regarding the type of data that we collect and how we store it. +Last updated: June 2025 + +## Information Collection/Storage +This page outlines how GitKraken.dev handles data security—including what data we collect, how it's transmitted, where it's stored, and how it's protected at rest. + | Service | What information are we collecting | How is this information secured in the transfer| Where is this information stored | How is this information secured in storage | | --- | --- | --- | --- | --- | @@ -16,3 +18,17 @@ Below is a chart outlining some basic security information regarding the type of | Subscriptions | Billing info: lastFour, name, type (credit card, paypal, ach...), zip, country, creditCard type (mastercard, visa...) | Encrypted with TLS | MongoDB Atlas | Encrypted at rest (AES-256) | | Launchpad | Storing meta-data for issues/pull-requests/URLs | Encrypted with TLS | Postgres (RDS) | Encrypted at rest (AES-256) | | Cloud Patches | Info related to the patch (repo name/URL/provider/base branch name/etc.) + the patch content itself. | Encrypted with TLS | Patch info is stored in a Postgres database, patch content is stored in AWS S3. | SSE-S3, which uses 256-bit Advanced Encryption Standard (AES-256) | + +## SOC2 +Gitkraken and it’s tools are now SOC 2 Certified! If you would like to request a copy of our SOC2 report, please visit our [Trust Center](https://trust.gitkraken.com/) to get the request process started. Please note that in order to provide a copy of the report, we will need you to sign an MNDA. + +
+
+
+ +
+
+ SOC 2 reports are only available for Business and Enterprise customers. +
+
+
diff --git a/gk-dev/gk-dev-single-sign-on.md b/gk-dev/gk-dev-single-sign-on.md index 4a6f092..4ad8144 100644 --- a/gk-dev/gk-dev-single-sign-on.md +++ b/gk-dev/gk-dev-single-sign-on.md @@ -1,126 +1,128 @@ --- - -title: Single Sign-On (SSO) -description: How to enable and use Single Sign-On (SSO) +title: Configure Single Sign-On (SSO) for GitKraken +description: Learn how to enable and configure Single Sign-On (SSO) using your identity provider (IdP) for secure access to GitKraken cloud organizations. taxonomy: category: gk-dev - --- -Single Sign On (SSO) is an easy way to manage your users across all your services. This is only for use with the cloud versions of GitKraken, it is not available for On-Premise plans. +Single Sign-On (SSO) is an easy way to manage users across all your services. SSO is supported only for GitKraken cloud users; On-Premise plans are not supported. -Once your organization has set up SSO with an Identity Provider (IdP), the Owner or an Admin on your GitKraken organization can link your organization to that identity provider. Then, any users associated with your IdP can login to GitKraken apps and services. +Once your organization has set up SSO with an Identity Provider (IdP), the Owner or an Admin can link the GitKraken organization to that IdP. After linking, users associated with the IdP can log in to GitKraken apps and services. -Note: You must have a GitKraken Teams or GitKraken Enterprise subscription to enable SSO. You also can try SSO during a 30-day multi-user trial. - -
-

This Feature is only available for Pro subscription tiers or higher

+
+

SSO is available with a GitKraken Advanced or Enterprise subscription. It’s also included in the 30-day multi-user trial.

*** -## What is Single Sign-on (SSO)? +## What is single sign-on (SSO)? -The Wikipedia definition of SSO: +Single sign-on (SSO) is an authentication method that lets users sign in once and gain access to multiple, independent software systems without needing to re-enter their credentials. -*“Single sign-on is an authentication scheme that allows a user to log in with a single ID to any of several related, yet independent, software systems. True single sign-on allows the user to log in once and access services without re-entering authentication factors.”* +
+ Diagram of a typical SSO setup +
A typical SSO setup connecting users, identity providers, and apps
+
- +Here are some important terms related to SSO: -The above diagram depicts what a typical SSO setup entails. Here is some relevant terminology: +**Directory Server:** A directory server stores information about organizational “objects” such as printers, computers, shared folders, users, or groups. These objects may be organized hierarchically. -**Directory Server:** A Directory Server is an application that stores information about the “objects” that belong to an organization. An object is typically something like: printers, computers, shared folders, users, or groups. Some objects can contain other objects which then allows them to reflect hierarchical structures. +Examples: +* Microsoft Active Directory +* Oracle Identity Governance (OIG) Suite +* JumpCloud -Examples of Directory Server applications are: -* Microsoft Active Directory -* Oracle Identity Governance (OIG) Suite -* Jump Cloud +**Identity Provider (IdP):** An IdP manages identity information and provides authentication services. It stores users, groups, and apps that rely on it to authenticate logins. -**Identity Provider:** An identity provider (abbreviated IdP or IDP) is a system entity that creates, maintains, and manages identity information as well as provides authentication services to relying applications within a distributed network. An IdP provider stores 3 main components: Users, Groups, and Applications. - -Examples of Identity Provider applications are: -* Azure Active Directory +Examples: +* Azure Active Directory * Okta * Google Identity Platform -The Identity Providers provide services that allow third party applications to authenticate their users. The authentication mechanism they provide is called “Oauth”, which allows third party applications to authenticate users without accessing/storing their password. +Identity providers authenticate users on behalf of other apps, using a protocol called **OAuth**. This ensures the third-party apps can verify a user without needing access to their password. -**Third party applications:** These are the applications that use IdP services to authenticate users. The end user is redirected to the IdP to instead login there. Then the Idp directs back to the 3rd party app to complete the login, confirming that the user is who they claim to be. +**Third-party applications:** These are the services that use an IdP to authenticate users. Users are redirected to the IdP to log in, then returned to the application once verified. -Examples of third party apps: -* GitKraken -* Slack -* Jira +Examples: +* GitKraken +* Slack +* Jira *** -## SSO in GitKraken +## How SSO works in GitKraken -GitKraken is a 3rd party application in this scenario. The owner or an admin of the GitKraken organization can set up SSO with GitKraken. +GitKraken is a third-party application in this context. The Owner or an Admin of a GitKraken organization can set up SSO. ### Supported Identity Providers -GitKraken uses SAML 2.0 for SSO, therefore any IdP that supports SAML 2.0 should work with GitKraken. +GitKraken supports SAML 2.0 for SSO. Any identity provider (IdP) that supports SAML 2.0 is compatible. ### License Requirements -Single sign-on requires a GitKraken Teams, GitKraken Enterprise, or a 30-day multi-user trial. To use multiple domains requires GitKraken Enterprise or a 30-day multi-user trial. +SSO requires a GitKraken Teams or Enterprise subscription, or a 30-day multi-user trial. To support multiple domains, GitKraken Enterprise or the multi-user trial is required. + +### SSO Enforcement in GitKraken -### SSO Enforcement on GitKraken +- SSO is enforced at the **domain level**: + - Users whose account emails match a verified SSO domain must log in via SSO. + - Owners and Admins can log in using any method. -- GitKraken SSO is enforced at the domain level. This means every account on GitKraken that has an email for the account which matches the domain is required to login using SSO. - - Only users with the user or billing contact role are required to use SSO. The Owner and admins of the organization can login using any method of choice. -- SSO is also enforced by the organization. This means that all users that match the domain must be a part of the organization to login. - - This also means that all members in the organization must match one of your SSO domains. Before turning on SSO, all non-matching users must be removed from the organization. -- Accounts belong to the domain and organization. When SSO is enabled: - - Users cannot create additional organizations or subscriptions. - - Accounts cannot self-leave the organization - - Users cannot change their account email or password. - - Existing accounts that already have additional organizations or subscriptions will still have them. - - Existing accounts cannot access their additional organizations or subscriptions until they can login using SSO and are a part of the organization. +- SSO is also enforced at the **organization level**: + - All users matching a verified domain must be part of the GitKraken organization. + - Users with unmatched domains must be removed before SSO can be enabled. + +- Additional rules: + - Users cannot create other organizations or subscriptions. + - Users cannot leave the organization or change their email/password. + - Existing accounts with other organizations/subscriptions can keep them, but can’t access them until they are part of the organization and sign in with SSO. ### Just-in-time provisioning (JIT) -You can enable JIT on GitKraken.dev > Settings > SSO. With JIT enabled, when a user logs in with SSO successfully and is not part of your organization, they will automatically join your organization and consume a license. You do need to have spare licenses available for this to work, if all licenses are used then the user will not join automatically even if JIT is on. +JIT can be enabled at GitKraken.dev > Settings > SSO. When JIT is active and a user logs in successfully via SSO, they will automatically join the organization and consume a license. + +Note: JIT only works if there are available licenses. If none are available, users will not be added. ### SSO login experience -- To login with SSO, click “SSO” on the login page. -- When a user that belongs to your domain logs in using anything but SSO, they will see a message explaining they need to login using SSO. -- When a user logs in using SSO successfully but is not a part of the organization, they will receive a message telling them to contact their admin to join the GitKraken organization. -- The owner and admins of the organization can log in using any method. +- On the login screen, select **SSO** to sign in. +- If a user tries to log in using a method other than SSO and matches a managed domain, they’ll see a message requiring SSO. +- If a user logs in with SSO but is not part of the organization, they’ll be prompted to contact an admin. +- Owners and Admins may sign in using any supported method. +
+

Gitkraken SSO does not support signing in through the Identity Provider's dashboard.

+
*** -## Setup SSO - -- Login to GitKraken.dev. - - Login as an owner or admin. - - Navigate the left sidebar to [Settings], then [Single sign-on]. -- Click [Setup SSO]. - - If you have created SSO connections before then you should see a table of connections. If you would prefer to follow along from a blank state, delete all connections in the table. -- Fill out the form to create your first connection. - - Connection name: this is to name the connection that will be shown to your users throughout GitKraken. - - Domain: it’s best to add the domain in a basic form (e.g. gitkraken.com). - - Identity URL: you need to copy and paste this into your identity provider to set up the integration. - - Credentials: select the method of choice from Metadata URL, Metadata (raw), or Certificate. Copy it from your IdP and paste it in the textbox(es). - - Once it is all filled out, click [Create Connection]. -- Verify domain ownership. - - Copy the TXT record shown on GitKraken. - - Login to your DNS server. - - Create a new record on the DNS server by pasting the TXT record in and saving it. - - Return to GitKraken and click [Verify Ownership]. - - NOTE: it can take minutes or hours for the new record to reflect, depending on your DNS server. -- Add additional domains (optional). - - If you have more than one domain present for your user base on GitKraken, then add additional domains before continuing to step 6 by clicking [Add Connection] and repeating steps 3 and 4 above. -- Enable SSO - - Make sure the connections in the table are all enabled (if you see [Disable] in the table, that means the connection is enabled). - - Turn on the [Enable SSO] switch at the top of the dashboard. - - (Possible) Enabling SSO requires all members of the organization to match one of your domains. You might see a pop up that shows all the users that don’t match. You can remove them all here to continue or click [Cancel] and add additional domains before continuing (see step 5). - - (Possible) Enabling SSO means that all users that match your SSO domains can no longer login until they join your organization. When enabling SSO a pop up may show all GitKraken accounts that belong to your domains but are not a part of the organization. Here you can choose which accounts to add to your organization. The ones you don’t add will not be able to login until you add them. If you are missing a domain, you can click [Cancel] and add additional domains before continuing (see step 5). - - (Optional) turn on JIT to allow additional users to join the organization when they sign in with SSO (requires spare seats). - -SSO should now be enabled and enforced across GitKraken for your domains! Be sure to test it. If you encounter issues this article doesn’t address, contact GitKraken support for more help. +## Set up SSO + +1. Log in to GitKraken.dev as an Owner or Admin. +2. Navigate to **Settings > Single sign-on** in the left sidebar. +3. Click **Set up SSO**. + - If existing connections appear, you may delete them to start from a blank state. +4. Complete the connection form: + - **Connection name**: Name shown to users in GitKraken. + - **Domain**: Use the base domain (e.g., gitkraken.com). + - **Identity URL**: Provided by GitKraken, paste this into your IdP. + - **Credentials**: Choose Metadata URL, raw Metadata, or Certificate. Paste in values from your IdP. + - Click **Create Connection** when done. +5. Verify domain ownership: + - Copy the TXT record provided. + - Log in to your DNS provider and add the record. + - Return to GitKraken and click **Verify Ownership**. + - Note: DNS changes may take minutes or hours to propagate. +6. (Optional) Add additional domains: + - If users span multiple domains, click **Add Connection** and repeat steps 4 and 5. +7. Enable SSO: + - Ensure connections in the table are enabled (the presence of **Disable** means it is enabled). + - Turn on the **Enable SSO** switch at the top. + - You may be prompted to remove users with unmatched domains or to add external GitKraken users to your organization. + - You may cancel and add more domains if needed. + - (Optional) Enable JIT to allow new users to auto-join when signing in with SSO (requires available licenses). + +SSO is now enabled and enforced across GitKraken for your domains. Be sure to test your setup. If you run into issues, contact GitKraken support. *** @@ -132,51 +134,64 @@ SSO should now be enabled and enforced across GitKraken for your domains! Be sur ### G Suite -How to Create SAML Application in G Suite: +How to Create a SAML Application in G Suite: 1. Go to https://admin.google.com/ - -2. Click on *Apps* and then *Web and mobile apps*. - - - -3. Click on *Add app*. - - - -4. Click *Add custom SAML app*. - - - -5. Type in your app name (such as GitKraken SSO). - - - -6. Copy your *SSO URL* and *Certificate*. - - - -7. Enter the callback URL `https://api.gitkraken.com/oauth/sso/callback` for *ACS URL* and *Entity ID*. - - - -8. Add desired attributes and click on *Finish*. - - - -9. Click on *TEST SAML LOGIN*. - - - -10. Click on *ALLOW ACCESS*. - - - -11. Select *ON for everyone* and save. - - - -Now you are all set to [setup your SSO on a GitKraken Organization](/gk-dev/gk-dev-single-sign-on/#setup-sso) +2. Click on Apps and then Web and mobile apps. +
+ +
Navigate to Web and mobile apps
+
+3. Click on Add app. +
+ +
Add a new application
+
+4. Click Add custom SAML app. +
+ +
Choose to add a custom SAML app
+
+5. Type in your app name (e.g., GitKraken SSO). +
+ +
Name your SAML app
+
+6. Copy your SSO URL and Certificate. +
+ +
Retrieve SSO URL and certificate
+
+7. Enter the callback URL https://api.gitkraken.com/oauth/sso/callback for both ACS URL and Entity ID. +
+ +
Input ACS URL and Entity ID
+
+8. Add desired attributes and click Finish. +
+ +
Configure attributes
+
+9. Click TEST SAML LOGIN. +
+ +
Test your SAML login
+
+10. Click ALLOW ACCESS. +
+ +
Grant access to the app
+
+11. Select ON for everyone and save. +
+ +
Enable the app for all users
+
+ +Now you are all set to set up your SSO on a GitKraken Organization. +- If a user tries to log in using a method other than SSO and matches a managed domain, they’ll see a message requiring SSO. +- If a user logs in with SSO but is not part of the organization, they’ll be prompted to contact an admin. +- Owners and Admins may sign in using any supported method. ### Azure Active Directory @@ -187,31 +202,31 @@ How to create SAML application in Azure Active Directory: 3. Go to *Azure Active Directory* from search bar. 4. In the left menu click on *Enterprise applications*. - + 5. Click on *New application* from the top of the page. - + 6. Select *Create your own application*. - + 7. Give your application name (such as "GitKraken SSO") and select "Integrate any other application you don't find in the gallery (Non-gallery)". - + 8. Select *Single sign-on* from the left sidebar and then choose *SAML*. - + 9. Click the edit icon in the top right corner to configure SAML. - + 10. Input the *Entity ID* URI and *Reply URL*. Both of these should direct to `https://api.gitkraken.com/oauth/sso/callback` for GitKraken SSO. - + Now you are all set to [setup your SSO on a GitKraken Organization](/gk-dev/gk-dev-single-sign-on/#setup-sso) ### Okta @@ -226,32 +241,32 @@ How to Create SAML Application in Okta: 2. Enter your Okta credentials and login. 3. Go to admin dashboard and select *Applications* in navigation bar. - + 4. Click on *Add Application*. 5. Select *Create New App*. - + 6. Select *SAML 2.0* as a Sign on Method and click to next button. - + 7. Enter a name of application (such as "GitKraken SSO"). - + 8. Configure SAML Integration. The *Single sign on URL* and *Audience URI* fields should direct to `https://api.gitkraken.com/oauth/sso/callback`. - + Step 9: Scroll down to the attribute statement and fill in the optional fields. - + Step 10: Select “I am an Okta customer adding an internal app” from option menu and then click to finish. - + Now you are all set to [setup your SSO on a GitKraken Organization](/gk-dev/gk-dev-single-sign-on/#setup-sso) @@ -265,79 +280,79 @@ How to Create SAML Application in Ping Identity 3. Go to the home page and click on *Add Environment*. - + 4. Select the appropriate solution based on your need (in this guide, we use *Customer solution*) and click *Next*. - + 5. Select *PingOne SSO*, then click *Next*. - + 6. Type in your environment name (in *TRIAL ENVIRONMENT NAME*), then click *Finish*. Now your environment is created. Go ahead and click on it. - - + + 7. Select Identities to add some users. Once you are done adding them click on Groups, and then click on the plus button to add a group. (Make sure to add users with their email addresses). - - + + 8. Select *Groups*, then click on the plus button to add a group. Once you have that, you can add the users to your group. - + 9. Select *Connections*. - + 10. Click on the plus button. - + 11. Enter a name for your application, then select *SAML Application*. Next click on the *Configure* button which appears once you select your application type. - + 12. Select *Manually Enter*. Type in the URL for *ACS URLs* and *Entity ID*, then click on *Save*. (URL: `https://api.gitkraken.com/oauth/sso/callback`) - + 13. Click on the toggle button so the users would have access to your application. - + 14. Click on *Attributes* then add email as your new attribute. - - + + 15. Time to add the group we created in Step 8. - + 16. Select the pencil icon pictured below. - + 17. Click on the plus icon to add the group, then click on *Save*. - - + + 18. Go to the *Configuration* tab to copy your *IDP Metadata URL* and download your metadata (*Download Metadata* button). - + -19. Log into gitkraken.dev/settings/sso and select "Setup SSO". Type in your Connection name and Domain. +19. Log into gitkraken.dev/settings/sso and select "Setup SSO". Type in your Connection name and Domain. 20. Then use the *IDP Metadata URL* and *Metadata* from step 18 for *Metadata URL* and *Metadata*. Click on *Create Connection* - + 21. Now the users who were added in step 7 can *Sign in with SSO*. diff --git a/gk-dev/gk-dev-student-pack.md b/gk-dev/gk-dev-student-pack.md new file mode 100644 index 0000000..43b9e6c --- /dev/null +++ b/gk-dev/gk-dev-student-pack.md @@ -0,0 +1,39 @@ +--- +title: GitKraken Student Pack +description: Get a free GitKraken subscription for students. +taxonomy: + category: gk-dev +--- + +Last updated: August 2025 + +GitKraken offers a free Student Pack for students to use GitKraken Desktop, GitLens, CLI, and GitKraken.dev. + +This plan is a 6 month free trial of PRO features for students who are verified on Github Student Developer Pack. + +After the 6 month free trial, you can upgrade to a PRO subscription at a discounted rate. + +# What is in the GitKraken Student Pack + +- GitKraken Desktop +- GitLens +- GitKraken CLI +- GitKraken.dev + +# How to get the Student Pack + +1. You need to be a student with a valid student email address and a verified Github Student Developer Pack. +2. Create a new account on GitKraken using your Github account. +3. Once you have created your account, the `Student`flag shows next to your name in GitKraken.dev +4. Now you can sign into all GitKraken products with your Github account with premium features applied. + +Student flag in GitKraken.dev + +# How to upgrade to a PRO subscription + +When the 6 month free trial is about to end, you will be notified both in the app and in the email you used to sign up. + +Upgrade to PRO screen in GitKraken.dev + +You can upgrade to a PRO subscription at a discounted rate following the instructions in the email. In the checkout process, verify the discount code is applied. + diff --git a/gk-dev/gk-dev-subscription.md b/gk-dev/gk-dev-subscription.md index 42a4595..684e7bb 100644 --- a/gk-dev/gk-dev-subscription.md +++ b/gk-dev/gk-dev-subscription.md @@ -1,64 +1,136 @@ --- - -title: Manage GitKraken Subscriptions -description: Learn about GitKraken Subscriptions +title: Manage GitKraken Subscription and Billing +description: Purchase or cancel GitKraken subscriptions, update billing info, and download past invoices. taxonomy: category: gk-dev - --- -Subscriptions are tied directly to an [organization](/gk-dev/gk-dev-organization/), even if the subscription is for one user. The subscription is identical for everyone in the organization and one license is required for every member (unless their [role](/gk-dev/gk-dev-organization/#roles) does not use a license). +Last updated: July 2025 + +Subscriptions in GitKraken Dev are tied directly to an [organization](/gk-dev/gk-dev-organization/), even if there is only one user. + +All members of an organization share the same subscription, and each active member requires a license. Some [roles](/gk-dev/gk-dev-organization/#roles) do not consume a license. *** ## How to purchase -To purchase a subscription for the first time follow these steps: -1. Visit [gitkraken.dev](https://gitkraken.dev). -2. Login with your [GitKraken account](/gk-dev/gk-dev-account/) or create an account. -3. Select your organization in the left panel and select "Purchase Subscription" (remember you need to have a [role](/gk-dev/gk-dev-organization/#roles) with permission to purchase). -4. Set the desired number of user seats. Then, select the tier that is best for your organization (Pro, Teams, or Enterprise). There are links at the bottom of each while can further elaborate on the differences. -5. Fill out the Organization name, First name, Last name, and country or region. If you have a promo code, select "Have a promo code?" and provide it. Proceed by selecting "Payment details". -6. Select the desired payment method and proceed with filling out the required billing information if needed. Then select "Review your order". -7. Select the "Buy now" button to complete your transaction. -8. If you added more licenses than there are members in the organization to claim, you will be taken to the "Add Users" screen. - -
-

If you encounter trouble while purchasing and you have verified your payment method, please don’t hesitate to contact us for support.

+To purchase a subscription for the first time: + +1. Visit [gitkraken.dev](https://gitkraken.dev?source=help_center&product=gitkraken_dot_dev). +2. Log in with your [GitKraken account](/gk-dev/gk-dev-account/) or create one. +3. Select your organization in the left panel, then click **Purchase Subscription**. You’ll need a [role](/gk-dev/gk-dev-organization/#roles) with billing permissions. +4. Set the number of user seats. Choose the subscription tier that best fits your organization (Pro, Teams, or Enterprise). Each tier includes a link to learn more. +5. Enter your organization name, first and last name, and your country or region. If you have a promo code, click **Have a promo code?** to enter it. Click **Payment details** to continue. +6. Select a payment method and complete the billing information. Then click **Review your order**. +7. Click the **Buy now** button to complete your purchase. +8. If you added more licenses than there are users to assign them to, you’ll be redirected to the **Add Users** screen. + +
+

If you encounter issues while purchasing and have verified your payment method, please contact us for support.

+*** + +## Purchase additional licenses + +To purchase additional licenses, you must be an **Admin**, **Owner**, or **Billing Contact** for your organization. + +Follow these steps to add licenses to your GitKraken subscription: + +1. **Go to your subscription page** + Navigate to [gitkraken.dev/subscription](https://gitkraken.dev/subscription?source=help_center&product=gitkraken_dot_dev). + +2. **Click "Add Seats"** + +
+ Subscription page with Add Seats button highlighted +
The Add Seats button is in the subscription management area.
+
+ +3. **Enter the number of licenses** + A modal appears. Enter how many licenses you want to add. A price preview updates automatically. The amount is **prorated** based on your renewal date. + *(Prorated means you pay only for the remaining time until your next renewal.)* + +
+ Modal window for selecting license quantity and price preview +
The modal lets you select the license quantity and preview the price.
+
+ +4. **Complete your purchase** + When ready, click **Purchase** to complete the transaction. + +5. **Allocate new licenses** + After purchase, go to [gitkraken.dev/users](https://gitkraken.dev/users?source=help_center&product=gitkraken_dot_dev) to assign licenses to users. + +For more information, see [Managing Roles, Users, Teams, SSO](https://help.gitkraken.com/gk-dev/gk-dev-organization/). + + *** ## Cancel -You can cancel your subscription at any time. To do so, login to [gitkraken.dev](https://gitkraken.dev/), select the organization, select "Subscription" on the left side, and select "Cancel." Follow the flow to complete cancellation. Once canceled, you will keep your subscription for the remainder of its billing period. Once the period is up, everyone in the organization will lose access to the subscription. +You can cancel your subscription at any time. To do so: + +1. Log in to [gitkraken.dev](https://gitkraken.dev/?source=help_center&product=gitkraken_dot_dev) +2. Select your organization +3. Go to **Subscription** in the left panel +4. Click **Cancel** and follow the prompts to confirm cancellation + +Once canceled, your subscription remains active until the end of the current billing period. After that, all members will lose access to the subscription. -When your subscription is set to cancel but you can still use it, your organization will be labeled as "non-renewing." When your subscription is completely canceled and the billing period has passed, it will be labeled as "canceled." +Organizations with a pending cancellation will be labeled as **non-renewing**. Once fully expired, they will appear as **canceled**. -
-

Only the owner, admins, and billing contacts have permission to cancel.

+
+

Only the Owner, Admins, and Billing Contacts can cancel subscriptions.

*** ## Reactivation -You can always reactivate a canceled subscription. You can reactivate by logging into [gitkraken.dev](https://gitkraken.dev/), select the organization, select "Subscription" on the left side, and select "Keep GitKraken." +You can reactivate a canceled subscription anytime: -If your subscription is set to cancel but still active, denoted as non-renewing, reactivation will not charge you until your next renewal or if you decide to upgrade from the plan you already have. +1. Log in to [gitkraken.dev](https://gitkraken.dev/?source=help_center&product=gitkraken_dot_dev) +2. Select your organization +3. Go to **Subscription** in the left panel +4. Click **Keep GitKraken** + +If the subscription is labeled **non-renewing** and still active, reactivation won’t trigger a charge until your next renewal or if you upgrade your plan. *** ## Edit billing -To update your billing method, go to [gitkraken.dev](https://gitkraken.dev/), select the organization, select Subscription on the left side, and click "Update" From here you may select to update your existing payment method or switch between payment methods. +To update your billing method: + +1. Visit [gitkraken.dev](https://gitkraken.dev/?source=help_center&product=gitkraken_dot_dev) +2. Select your organization +3. Go to **Subscription** in the left panel +4. Click **Update** to modify or switch payment methods - +
+ Edit billing details in GitKraken +
Update or change your billing method
+
*** ## Billing history -You may view your billing history from [gitkraken.dev/subscription/history](https://staging.gitkraken.dev/subscription/history) or by navigating to Subscription > View Billing History. Here, you may select `Download PDF` to obtain previous invoices. Each billing cycle, the owner and billing contacts of the organization will receive an email with the invoice attached. +You may view your billing history from [gitkraken.dev/subscription/history](https://staging.gitkraken.dev/subscription/history?source=help_center&product=gitkraken_dot_dev) or by navigating to **Subscription > View Billing History**. + +You can select **Download PDF** to retrieve past invoices. The Owner and Billing Contacts will also receive an invoice email at the end of each billing cycle. + +
+ Billing history view with download option +
Access and download past invoices from your billing history
+
+ +*** + +## Next Steps - +- [Assign licenses to users](/gk-dev/gk-dev-organization/#add-users) +- [Set up Single Sign-On (SSO)](/gk-dev/gk-dev-single-sign-on/) +- [Explore GitKraken.dev Home](/gk-dev/gk-dev-home/) \ No newline at end of file diff --git a/gk-dev/gk-dev-trials.md b/gk-dev/gk-dev-trials.md index 9e673a7..1bdcfe0 100644 --- a/gk-dev/gk-dev-trials.md +++ b/gk-dev/gk-dev-trials.md @@ -1,4 +1,4 @@ ---- +--- title: GitKraken Trials description: Learn about GitKraken Trials @@ -6,24 +6,49 @@ taxonomy: category: gk-dev --- - -## Trials +Last updated: June 2025 -Both GitKraken Desktop and GitLens offer 14-day trials of Pro. You can initiate these trials by logging into the corresponding app with a GitKraken account for the first time. Each trial is separate, so starting a 14-day trial with your GitKraken account in one app does not start it for the other. - -*** - -### Business Plan Trials +## Trial options -Business plan trials are available for groups of users that would like to try the [GitKraken DevEx platform](https://www.gitkraken.com/devex) across members of their team, company, or organization. After a Business plan trial is started, it will be active for 30 days. The duration of the Business plan trial is shared by everyone in the organization. - -To start a Business plan trial: - -1. Visit [gitkraken.dev](https://gitkraken.dev/) -2. Login with your GitKraken account -5. Navigate to [Users](https://gitkraken.dev/users) and add a user(s) -6. Once users are added, your extended organization trial has begun - -
-

It is not possible for a user to be a member of more than one Business plan trial at a time. Once the Business plan trial has lapsed, an owner cannot start another multi-user trial.

-
\ No newline at end of file +GitKraken offers two types of trials: + +- **14-day trial:** Try GitKraken Pro features on your own. +- **Business trial (30 days):** Invite your team and try the full GitKraken platform. + +To compare features, visit the [GitKraken pricing page](https://www.gitkraken.com/pricing?source=help_center&product=gitkraken_dot_dev). + +*** + +## Start a 14-day trial + +Both GitKraken Desktop and GitLens offer a [14-day trial](https://www.gitkraken.com/pricing?source=help_center&product=gitkraken_dot_dev). You can start a trial by logging into the respective app with your GitKraken account for the first time. + +Each trial is independent, and so starting a trial in one product does not activate it for the other. + +*** + +## Start a Business trial + +1. Visit [gitkraken.dev](https://gitkraken.dev/?source=help_center&product=gitkraken_dot_dev) +2. Log in using your GitKraken account +3. Navigate to [Users](https://gitkraken.dev/users?source=help_center&product=gitkraken_dot_dev) +4. Add one or more users +5. Once users are added, the organization-wide trial begins + +Business trials include: + +- 30 days of full access +- Support for multiple users and license management +- SSO setup and workspace configuration + +
+

Each user can only join one Business trial. Owners can’t start another Business trial after the first one ends.

+
+ +*** + +## Next Steps + +- [Set up your organization](/gk-dev/gk-dev-organization/) +- [Manage billing and licenses](/gk-dev/gk-dev-subscription/) +- [Explore GitKraken.dev features](/gk-dev/gk-dev-home/)