diff options
Diffstat (limited to 'doc/user/project/repository')
20 files changed, 226 insertions, 159 deletions
diff --git a/doc/user/project/repository/branches/index.md b/doc/user/project/repository/branches/index.md index 0a0cbcbb9c8..d6bcae57322 100644 --- a/doc/user/project/repository/branches/index.md +++ b/doc/user/project/repository/branches/index.md @@ -35,7 +35,7 @@ To create a new branch from the GitLab UI: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Code > Branches**. -1. On the top right, select **New branch**. +1. In the upper-right corner, select **New branch**. 1. Enter a **Branch name**. 1. In **Create from**, select the base of your branch: an existing branch, an existing tag, or a commit SHA. @@ -283,62 +283,64 @@ To do this: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Code > Branches**. -1. On the upper right corner of the page, select **More** **{ellipsis_v}**. +1. In the upper right corner of the page, select **More** **{ellipsis_v}**. 1. Select **Delete merged branches**. 1. In the dialog, enter the word `delete` to confirm, then select **Delete merged branches**. -## Configure rules for target branches **(PREMIUM ALL)** +## Configure workflows for target branches **(PREMIUM ALL)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127115) in GitLab 16.4 [with a flag](../../../../administration/feature_flags.md) named `target_branch_rules_flag`. Enabled by default. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136431) in GitLab 16.7. Some projects use multiple long-term branches for development, like `develop` and `qa`. In these projects, you might want to keep `main` as the default branch, but expect -merge requests to target `develop` or `qa` instead. Target branch rules help ensure +merge requests to target `develop` or `qa` instead. Target branch workflows help ensure merge requests target the appropriate development branch for your project. -When you create a merge request, the rule checks the name of the branch. If the -branch name matches the rule, the merge request targets the branch you specify -in the rule. If the branch name does not match, the merge request targets the +When you create a merge request, the workflow checks the name of the branch. If the +branch name matches the workflow, the merge request targets the branch you specify. If the branch name does not match, the merge request targets the default branch of the project. +Rules are processed on a "first-match" basis - if two rules match the same branch name, the top-most rule is applied. + Prerequisites: - You must have at least the Maintainer role. -To create a target branch rule: +To create a target branch workflow: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Settings > Merge requests**. -1. Select **Add target branch rule**. -1. For **Rule name**, provide a string or wild card to compare against branch names. -1. Select the **Target branch** to use when the branch name matches the **Rule name**. +1. Scroll down to **Merge request branch workflow** +1. Select **Add branch target**. +1. For **Branch name pattern**, provide a string or wild card to compare against branch names. +1. Select the **Target branch** to use when the branch name matches the **Branch name pattern**. 1. Select **Save**. ### Example -You could configure your project to have the following target branch rules: +You could configure your project to have the following target branch workflows: -| Rule name | Target branch | +| Branch name pattern | Target branch | |-------------|---------------| | `feature/*` | `develop` | | `bug/*` | `develop` | | `release/*` | `main` | -These rules simplify the process of creating merge requests for a project that: +These target branches simplify the process of creating merge requests for a project that: - Uses `main` to represent the deployed state of your application. - Tracks current, unreleased development work in another long-running branch, like `develop`. -If your workflow initially places new features in `develop` instead of `main`, these rules +If your workflow initially places new features in `develop` instead of `main`, these target branches ensure all branches matching either `feature/*` or `bug/*` do not target `main` by mistake. -When you're ready to release to `main`, create a branch named `release/*`, and the rules +When you're ready to release to `main`, create a branch named `release/*`, and ensure this branch targets `main`. -## Delete a target branch rule +## Delete a target branch workflow -When you remove a target branch rule, existing merge requests remain unchanged. +When you remove a target branch workflow, existing merge requests remain unchanged. Prerequisites: @@ -348,7 +350,7 @@ To do this: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Settings > Merge requests**. -1. Select **Delete** on the rule you want to delete. +1. Select **Delete** on the branch target you want to delete. ## Related topics diff --git a/doc/user/project/repository/code_suggestions/index.md b/doc/user/project/repository/code_suggestions/index.md index 9e52da6068c..ed9eeac1c2c 100644 --- a/doc/user/project/repository/code_suggestions/index.md +++ b/doc/user/project/repository/code_suggestions/index.md @@ -4,40 +4,45 @@ group: Code Creation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code Suggestions **(FREE ALL BETA)** +# Code Suggestions **(FREE ALL)** > - [Introduced support for Google Vertex AI Codey APIs](https://gitlab.com/groups/gitlab-org/-/epics/10562) in GitLab 16.1. > - [Removed support for GitLab native model](https://gitlab.com/groups/gitlab-org/-/epics/10752) in GitLab 16.2. > - [Introduced support for Code Generation](https://gitlab.com/gitlab-org/gitlab/-/issues/415583) in GitLab 16.3. - -WARNING: -This feature is in [Beta](../../../../policy/experiment-beta-support.md#beta). -Beta users should read about the [known limitations](#known-limitations). We look forward to hearing your [feedback](#feedback). +> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/435271) in GitLab 16.7. Write code more efficiently by using generative AI to suggest code while you're developing. -With Code Suggestions, you get: +With [GitLab Duo Code Suggestions](https://about.gitlab.com/solutions/code-suggestions/), you get: -- Code Completion, which suggests completions the current line you are typing. These suggestions are usually low latency. -- Code Generation, which generates code based on a natural language code comment block. Generating code can exceed multiple seconds. +- Code Completion, which suggests completions to the current line you are typing. These suggestions are usually low latency. +- Code Generation, which generates code based on a natural language code + comment block. Write a comment like `# Type more here` to generate the + appropriate code, based on the context of your comment and the rest of your code. + - Algorithms or large code blocks may take more than 10 seconds to generate. + - Streaming of code generation responses is supported in VS Code, leading to faster average response times. Other supported IDEs offer slower response times and will return the generated code in a single block. ## Start using Code Suggestions GitLab Duo Code Suggestions are available: -- On [self-managed](self_managed.md) and [SaaS](saas.md). View these pages to get started. +- In the Premium and Ultimate tier for [self-managed](self_managed.md), and across all tiers for [SaaS](saas.md). View these pages to get started. - In VS Code, Microsoft Visual Studio, JetBrains IDEs, and Neovim. You must have the corresponding GitLab extension installed. - In the GitLab Web IDE. <div class="video-fallback"> - <a href="https://youtu.be/wAYiy05fjF0">View how to setup and use GitLab Duo Code Suggestions</a>. + <a href="https://youtu.be/xQUlrbIWo8o">View how to setup and use GitLab Duo Code Suggestions</a>. </div> <figure class="video-container"> - <iframe src="https://www.youtube-nocookie.com/embed/wAYiy05fjF0" frameborder="0" allowfullscreen> </iframe> + <iframe src="https://www.youtube-nocookie.com/embed/xQUlrbIWo8o" frameborder="0" allowfullscreen> </iframe> </figure> -During Beta, usage of Code Suggestions is governed by the [GitLab Testing Agreement](https://about.gitlab.com/handbook/legal/testing-agreement/). -Learn about [data usage when using Code Suggestions](#code-suggestions-data-usage). As Code Suggestions matures to General Availability it will be governed by our [AI Functionality Terms](https://about.gitlab.com/handbook/legal/ai-functionality-terms/). +Code Suggestions is available and free to use until February 15, 2024: + +- Before February 15, 2024, usage of Code Suggestions is governed by the + [GitLab Testing Agreement](https://about.gitlab.com/handbook/legal/testing-agreement/). +- On February 15, 2024, Code Suggestions becomes a paid add-on and will be governed by our + [AI Functionality Terms](https://about.gitlab.com/handbook/legal/ai-functionality-terms/). ## Supported languages @@ -51,7 +56,11 @@ For languages not listed in the following table, Code Suggestions might not func ### Supported languages in IDEs -Editor support for languages is documented in the following table. +Code Suggestions is aware of common popular programming concepts and +infrastructure-as-code interfaces, like Kubernetes Resource Model (KRM), +Google Cloud CLI, and Terraform. + +The editor supports these languages: | Language | VS Code | JetBrains IDEs | Visual Studio | Neovim | |------------------|------------------------|------------------------|------------------------|--------| @@ -61,16 +70,14 @@ Editor support for languages is documented in the following table. | Google SQL | **{dotted-circle}** No | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | Java | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | JavaScript | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | -| Kotlin | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | +| Kotlin | **{check-circle}** Yes (Requires third-party extension providing Kotlin support) | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | PHP | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | Python | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | Ruby | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | Rust | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | -| Scala | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | +| Scala | **{check-circle}** Yes (Requires third-party extension providing Scala support) | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | Swift | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | TypeScript | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | -| Google Cloud | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No | -| Kubernetes Resource Model (KRM) | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No | | Terraform | **{check-circle}** Yes (Requires third-party extension providing Terraform support) | **{check-circle}** Yes | **{dotted-circle}** No | **{check-circle}** Yes (Requires third-party extension providing the `terraform` file type) | NOTE: @@ -81,18 +88,13 @@ plugin support. Refer to the JetBrains documentation for specifics on your IDE. Code Suggestions supports a variety of popular editors including: -- VS Code, using [the VS Code GitLab Workflow extension](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow). +- VS Code, using [the VS Code GitLab Workflow extension](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow). Supports streaming responses for code generation. - [GitLab WebIDE (VS Code in the Cloud)](../../../project/web_ide/index.md), with no additional configuration. - Microsoft Visual Studio, using the [Visual Studio GitLab extension](https://marketplace.visualstudio.com/items?itemName=GitLab.GitLabExtensionForVisualStudio). - JetBrains IDEs, using the [GitLab plugin](https://plugins.jetbrains.com/plugin/22325-gitlab). - Neovim, using the [`gitlab.vim` plugin](https://gitlab.com/gitlab-org/editor-extensions/gitlab.vim). -A [GitLab Language Server for Code Suggestions](https://gitlab.com/gitlab-org/editor-extensions/gitlab-language-server-for-code-suggestions) -is also in process. -This improvement should result in: - -- Faster iteration and standardization of the IDE extensions. -- The ability to use Code Suggestions even when an official editor extension isn't available. +A [GitLab Language Server](https://gitlab.com/gitlab-org/editor-extensions/gitlab-lsp) is used in VS Code, Visual Studio, and Neovim. The Language Server supports faster iteration across more platforms. Users can also configure it to support Code Suggestions in IDEs where GitLab doesn't provide official support. ## Code Suggestions data usage @@ -120,7 +122,7 @@ For self-managed instances that have enabled Code Suggestions and SaaS accounts, ### Inference window context -Code Suggestions inferences against the currently opened file, the content before and after the cursor, the filename, and the extension type. For more information on possible future context expansion to improve the quality of suggestions, see [epic 11669](https://gitlab.com/groups/gitlab-org/-/epics/11669). +Code Suggestions inferences against the currently opened file, the content before and after the cursor, the file name, and the extension type. For more information on possible future context expansion to improve the quality of suggestions, see [epic 11669](https://gitlab.com/groups/gitlab-org/-/epics/11669). ### Training data @@ -133,14 +135,18 @@ For more information on GitLab Code Suggestions data [sub-processors](https://ab ## Known limitations -While in Beta, we are working on improving the accuracy of overall generated content. +We are continuing to work on the accuracy of overall generated content. However, Code Suggestions may generate suggestions that are: -- Low-quality -- Incomplete -- Produce failed pipelines -- Insecure code -- Offensive or insensitive +- Irrelevant. +- Incomplete. +- Results in failed pipelines. +- Potentially insecure. +- Offensive or insensitive. + +When using Code Suggestions, [code review best practice](../../../../development/code_review.md) still applies. + +Let us know if you have [feedback](#feedback). ## Progressive enhancement @@ -151,4 +157,11 @@ Code Suggestions do not prevent you from writing code in your IDE. ## Feedback -Report issues in the [feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/405152). +Let us know about your Code Suggestions experience in [issue 435783](https://gitlab.com/gitlab-org/gitlab/-/issues/435783). + +## Troubleshooting + +### Disable Code Suggestions + +Individual users can disable Code Suggestions by disabling the feature in their +[installed IDE editor extension](index.md#supported-editor-extensions). diff --git a/doc/user/project/repository/code_suggestions/repository_xray.md b/doc/user/project/repository/code_suggestions/repository_xray.md new file mode 100644 index 00000000000..d851ee94e34 --- /dev/null +++ b/doc/user/project/repository/code_suggestions/repository_xray.md @@ -0,0 +1,60 @@ +--- +stage: Create +group: Code Creation +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# Repository X-Ray **(PREMIUM)** + +Repository X-Ray enhances GitLab Duo Code Suggestions by providing additional context to improve the accuracy and relevance of code recommendations. + +Repository X-Ray gives the code assistant more insight into the project's codebase and dependencies to generate better code suggestions. It does this by analyzing key project configuration files such as `Gemfile.lock`, `package.json`, and `go.mod` to build additional context. + +By understanding the frameworks, libraries and other dependencies in use, Repository X-Ray helps the code assistant tailor suggestions to match the coding patterns, styles and technologies used in the project. This results in code recommendations that integrate more seamlessly and follow best practices for that stack. + +## Supported languages and package managers + +| Language | Package Manager | Configuration File | +| ---------- |-----------------| -------------------- | +| Go | Go Modules | `go.mod` | +| JavaScript | NPM, Yarn | `package.json` | +| Ruby | RubyGems | `Gemfile.lock` | +| Python | Poetry | `pyproject.toml` | +| Python | Pip | `requirements.txt` | +| Python | Conda | `environment.yml` | + +## Enable Repository X-Ray + +Prerequisites: + +- You must have access to [GitLab Duo Code Suggestions](index.md) in the project. +- GitLab Runner must be set up and enabled for the project, because Repository X-Ray runs analysis pipelines using GitLab runners. + +To enable Repository X-Ray, add the following definition job to the project's `.gitlab-ci.yml`. + +```yaml +xray: + stage: build + image: registry.gitlab.com/gitlab-org/code-creation/repository-x-ray:latest + allow_failure: true + rules: + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH + variables: + OUTPUT_DIR: reports + script: + - x-ray-scan -p "$CI_PROJECT_DIR" -o "$OUTPUT_DIR" + artifacts: + reports: + repository_xray: "$OUTPUT_DIR/*/*.json" +``` + +- The `$OUTPUT_DIR` environment variable defines the: + - Output directory for reports. + - Path that artifacts are uploaded from. +- The added rules restrict the job to the default branch only. Restricting the job this way ensures development changes do not impact the baseline X-Ray data used for production code suggestions. + +After the initial x-ray job completes and uploads the repository analysis reports, no further action is required. Repository X-Ray automatically enriches all code generation requests from that point forward. + +The X-Ray data for your project updates each time a CI/CD pipeline containing the `xray` +job is run. To learn more about pipeline configuration and triggers, see the +[pipelines documentation](../../../../ci/pipelines/merge_request_pipelines.md). diff --git a/doc/user/project/repository/code_suggestions/saas.md b/doc/user/project/repository/code_suggestions/saas.md index 1af5eef585c..4b1cc762406 100644 --- a/doc/user/project/repository/code_suggestions/saas.md +++ b/doc/user/project/repository/code_suggestions/saas.md @@ -4,13 +4,14 @@ group: Code Creation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code Suggestions on GitLab SaaS **(FREE SAAS BETA)** +# Code Suggestions on GitLab SaaS **(FREE SAAS)** > - [Introduced](https://about.gitlab.com/releases/2023/02/22/gitlab-15-9-released/#code-suggestions-available-in-closed-beta) in GitLab 15.9 as [Beta](../../../../policy/experiment-beta-support.md#beta) for early access Ultimate customers on GitLab.com. > - [Enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/408104) as opt-in with GitLab 15.11 as [Beta](../../../../policy/experiment-beta-support.md#beta). > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/408158) from GitLab Ultimate to GitLab Premium in 16.0. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/410801) from GitLab Premium to GitLab Free in 16.0. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121079) in GitLab 16.1. +> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/435271) in GitLab 16.7. Write code more efficiently by using generative AI to suggest code while you're developing. @@ -20,14 +21,14 @@ Learn about [data usage when using Code Suggestions](index.md#code-suggestions-d ## Enable Code Suggestions > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121079) in GitLab 16.1 as [Beta](../../../../policy/experiment-beta-support.md#beta). -> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/139916) in GitLab 16.8. Available to a percentage of users. +> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/139916) in GitLab 16.8. UI user setting removed. A group owner must [enable Code Suggestions for your top-level group](../../../group/manage.md#enable-code-suggestions-for-a-group). NOTE: If you are having issues enabling Code Suggestions, view the -[troubleshooting guide](troubleshooting.md#code-suggestions-arent-displayed). +[troubleshooting guide](troubleshooting.md#code-suggestions-are-not-displayed). ## Use Code Suggestions @@ -35,19 +36,23 @@ Prerequisites: - You must have configured Code Suggestions in a [supported IDE editor extension](index.md#supported-editor-extensions). -- Code Suggestions must be enabled for: - - [The top-level group](../../../group/manage.md#enable-code-suggestions-for-a-group). - - [Your own account](../../../profile/preferences.md#enable-code-suggestions), if your - account is not part of the percentage rollout. +- Code Suggestions must be enabled for [the top-level group](../../../group/manage.md#enable-code-suggestions-for-a-group). To use Code Suggestions: -1. Determine if your user account is part of the percentage rollout. See - [Enable Code Suggestions](../../../profile/preferences.md#enable-code-suggestions) - for more information. 1. Author your code. As you type, suggestions are displayed. Code Suggestions provide code snippets or complete the current line, depending on the cursor position. -1. Describe the requirements in natural language. Be concise and specific. Code Suggestions generates functions and code snippets as appropriate. +1. Describe the requirements in natural language. Code Suggestions generates functions and code snippets based on the context provided. To get the best results from code generation: + - Be as specific as possible while remaining concise. State the outcome you want to generate (for example, a function) and provide details on what you want to achieve. Add additional information, such as the framework or library you want to use when applicable. + For example, to create a Python web service with some specific requirements, you might write something similar to the following: + + ```plaintext + # Create a web service using Tornado that allows a user to log in, run a security scan, and review the scan results. + # Each action (log in, run a scan, and review results) should be its own resource in the web service + ... + ``` + + - Add a space or go to a new line after each comment. This tells the code generator that you have completed your instructions. 1. To accept a suggestion, press <kbd>Tab</kbd>. 1. To ignore a suggestion, keep typing as you usually would. 1. To explicitly reject a suggestion, press <kbd>Esc</kbd>. diff --git a/doc/user/project/repository/code_suggestions/self_managed.md b/doc/user/project/repository/code_suggestions/self_managed.md index 26850bc8b5f..8cd499c13d0 100644 --- a/doc/user/project/repository/code_suggestions/self_managed.md +++ b/doc/user/project/repository/code_suggestions/self_managed.md @@ -4,12 +4,13 @@ group: Code Creation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code Suggestions on self-managed GitLab **(SELF BETA)** +# Code Suggestions on self-managed GitLab **(PREMIUM SELF)** > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10653) in GitLab 16.1 as [Beta](../../../../policy/experiment-beta-support.md#beta) on self-managed GitLab. > - [Introduced support for Google Vertex AI Codey APIs](https://gitlab.com/groups/gitlab-org/-/epics/10562) in GitLab 16.1. > - [Removed support for GitLab native model](https://gitlab.com/groups/gitlab-org/-/epics/10752) in GitLab 16.2. > - Code Suggestions in the GitLab WebIDE enabled for all GitLab-hosted customers. +> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/435271) in GitLab 16.7. Write code more efficiently by using generative AI to suggest code while you're developing. @@ -28,16 +29,19 @@ Learn about [data usage when using Code Suggestions](index.md#code-suggestions-d ## Enable Code Suggestions on self-managed GitLab > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10653) in GitLab 16.1 as [Beta](../../../../policy/experiment-beta-support.md#beta). -> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/139916) in GitLab 16.8. Available to a percentage of users. +> - [Enabled self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/139916) in GitLab 16.8. When you enable Code Suggestions for your self-managed instance, you: - Agree to the [GitLab testing agreement](https://about.gitlab.com/handbook/legal/testing-agreement/). - Acknowledge that GitLab sends data from the instance, including personal data, to GitLab.com infrastructure. -How you enable Code Suggestions for your instance differs depending on your version of GitLab. +How you enable Code Suggestions for your instance differs depending on your +version of GitLab. This setting is visible only in self-managed GitLab instances. -### GitLab 16.3 and later **(PREMIUM)** +::Tabs + +:::TabTitle GitLab 16.3 and later Prerequisites: @@ -53,17 +57,12 @@ To enable Code Suggestions for your self-managed GitLab instance: In GitLab 16.3, you do not need to enter anything into the **Personal access token** field. In GitLab 16.4 and later, there is no **Personal access token** field. 1. Select **Save changes**. - -This setting is visible only in self-managed GitLab instances. - -WARNING: -In GitLab 16.2 and earlier, if you clear the **Turn on Code Suggestions for this instance** checkbox, the users in your instance can still use Code Suggestions for up to one hour, until the issued JSON web token (JWT) expires. - -To make sure Code Suggestions works immediately, you must [manually synchronize your subscription](#manually-synchronize-your-subscription). +1. To make sure Code Suggestions works immediately, you must + [manually synchronize your subscription](#manually-synchronize-your-subscription). The users in your instance can now use Code Suggestions. -### GitLab 16.2 and earlier +:::TabTitle GitLab 16.2 and earlier FLAG: On self-managed GitLab 16.0 and earlier, GitLab Duo Code Suggestions is not available. To use this feature, you must have GitLab 16.1 or later. For optimal performance and full feature access, you should upgrade to GitLab 16.3 or later, which supports cloud licensing. @@ -75,7 +74,7 @@ Prerequisites: - You have a [GitLab SaaS account](https://gitlab.com/users/sign_up). You do not need to have a GitLab SaaS subscription. NOTE: -If you do not have a customer success manager, you cannot participate in the free trial of Code Suggestions on self-managed GitLab. Upgrade to GitLab 16.3 to [perform self-service onboarding](#gitlab-163-and-later). +If you do not have a customer success manager, you cannot participate in the free trial of Code Suggestions on self-managed GitLab. Upgrade to GitLab 16.3 or later to perform self-service onboarding. Then, you will: @@ -83,7 +82,7 @@ Then, you will: 1. Enable Code Suggestions for the instance. 1. [Request early access](#request-access-to-code-suggestions) to the Code Suggestions Beta. -#### Enable Code Suggestions for your SaaS account +### Enable Code Suggestions for your SaaS account To enable Code Suggestions for your GitLab SaaS account: @@ -94,7 +93,7 @@ To enable Code Suggestions for your GitLab SaaS account: 1. In the **Code Suggestions** section, select **Enable Code Suggestions**. 1. Select **Save changes**. -#### Enable Code Suggestions for the instance +### Enable Code Suggestions for the instance To enable Code Suggestions for your self-managed GitLab instance: @@ -110,7 +109,9 @@ This setting is visible only in self-managed GitLab instances. WARNING: If you clear the **Turn on Code Suggestions for this instance** checkbox, the users in your instance can still use Code Suggestions for up to one hour, until the issued JSON web token (JWT) expires. -#### Request access to Code Suggestions +::EndTabs + +### Request access to Code Suggestions GitLab provisions access on a customer-by-customer basis for Code Suggestions on self-managed instances. To request access, contact your customer success manager. @@ -120,7 +121,7 @@ Your customer success manager then provisions access by commenting on [issue 415 After GitLab has provisioned access to Code Suggestions for your instance, the users in your instance can now enable Code Suggestions. -### Configure network and proxy settings +## Configure network and proxy settings Configure any firewalls to allow outbound connections to `https://codesuggestions.gitlab.com/`. @@ -128,7 +129,7 @@ If your GitLab instance uses an HTTP proxy server to access the internet, ensure the server is configured to allow outbound connections, including the [`gitlab_workhorse` environment variable](https://docs.gitlab.com/omnibus/settings/environment-variables.html). -### Upgrade GitLab +## Upgrade GitLab In GitLab 16.3 and later, GitLab is enforcing the cloud licensing requirement for Code Suggestions: @@ -138,11 +139,11 @@ In GitLab 16.3 and later, GitLab is enforcing the cloud licensing requirement fo If you have a GitLab Free subscription and upgrade to GitLab 16.3 or later, to continue having early access to Code Suggestions, you must: -1. Have a [subscription that supports cloud licensing](https://about.gitlab.com/pricing/). +1. Have a [subscription that supports cloud licensing](https://about.gitlab.com/pricing/licensing-faq/cloud-licensing/). 1. Make sure you have the latest version of your [IDE extension](index.md#supported-editor-extensions). 1. [Manually synchronize your subscription](#manually-synchronize-your-subscription). -#### Manually synchronize your subscription +### Manually synchronize your subscription You must [manually synchronize your subscription](../../../../subscriptions/self_managed/index.md#manually-synchronize-your-subscription-details) if either: diff --git a/doc/user/project/repository/code_suggestions/troubleshooting.md b/doc/user/project/repository/code_suggestions/troubleshooting.md index c18ea2dd26b..47327d7a28f 100644 --- a/doc/user/project/repository/code_suggestions/troubleshooting.md +++ b/doc/user/project/repository/code_suggestions/troubleshooting.md @@ -4,35 +4,34 @@ group: Code Creation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Code Suggestions **(FREE ALL BETA)** +# Troubleshooting Code Suggestions **(FREE ALL)** When working with GitLab Duo Code Suggestions, you might encounter the following issues. -## Code Suggestions aren't displayed +## Code Suggestions are not displayed If Code Suggestions are not displayed, and you have [installed a supported IDE extension](index.md#supported-editor-extensions), try the following troubleshooting steps. -In GitLab, ensure Code Suggestions is enabled: - -- [For your user account](../../../profile/preferences.md#enable-code-suggestions). -- [For **all** top-level groups your account belongs to](../../../group/manage.md#enable-code-suggestions-for-a-group). If you don't have a role that lets you view the top-level group's settings, contact a group owner. +In GitLab, ensure Code Suggestions is enabled for **at least one** +[top-level group your account belongs to](../../../group/manage.md#enable-code-suggestions-for-a-group). +If you don't have a role that lets you view the top-level group's settings, contact a group owner. ### Code Suggestions not displayed in VS Code or GitLab WebIDE -Check all the steps in [Code Suggestions aren't displayed](#code-suggestions-arent-displayed) first. +Check all the steps in [Code Suggestions are not displayed](#code-suggestions-are-not-displayed) first. If you are a self-managed user, ensure that Code Suggestions for the [GitLab WebIDE](../../../project/web_ide/index.md) are enabled. The same settings apply to VS Code as local IDE. 1. On the left sidebar, select **Extensions > GitLab Workflow**. 1. Select **Settings** (**{settings}**), and then select **Extension Settings**. -1. In **GitLab > AI Assisted Code Suggestions**, select the **Enable code completion (Beta)** +1. In **GitLab > AI Assisted Code Suggestions**, select the **Enable code completion** checkbox. If the settings are enabled, but Code Suggestions are still not displayed, try the following steps: 1. Enable the `Debug` checkbox in the GitLab Workflow **Extension Settings**. 1. Open the extension log in **View > Output** and change the dropdown list to **GitLab Workflow** as the log filter. The command palette command is `GitLab: Show Extension Logs`. -1. Disable and re-enable the **Enable code completion (Beta)** checkbox. +1. Disable and re-enable the **Enable code completion** checkbox. 1. Verify that the debug log contains similar output: ```shell @@ -43,7 +42,7 @@ If the settings are enabled, but Code Suggestions are still not displayed, try t ### Code Suggestions not displayed in Microsoft Visual Studio -Check all the steps in [Code Suggestions aren't displayed](#code-suggestions-arent-displayed) first. +Check all the steps in [Code Suggestions are not displayed](#code-suggestions-are-not-displayed) first. 1. Ensure you have properly [set up the extension](https://gitlab.com/gitlab-org/editor-extensions/gitlab-visual-studio-extension#setup). 1. From the **Tools > Options** menu, find the **GitLab** option. Ensure **Log Level** is set to **Debug**. diff --git a/doc/user/project/repository/git_blame.md b/doc/user/project/repository/git_blame.md index a602638d244..f1fb118b8d5 100644 --- a/doc/user/project/repository/git_blame.md +++ b/doc/user/project/repository/git_blame.md @@ -34,6 +34,28 @@ to the left of the user avatar shows the general age of the commit. The newest commits have a dark blue bar. As the age of the commit increases, the bar color changes to light gray. +### View blame directly in the file view +<!-- +When feature flags `graphql_git_blame`, `blob_blame_info` and `highlight_js_worker` are removed, +delete this section and update the steps in "View blame for a file". +--> + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/430950) in GitLab 16.7 [with flags](../../../administration/feature_flags.md) named `graphql_git_blame`, `blob_blame_info` and `highlight_js_worker`. Enabled by default. + +FLAG: +On self-managed GitLab, by default this feature is available. +To hide the feature, an administrator can [disable the feature flag](../../../administration/feature_flags.md) named `blob_blame_info`. +On GitLab.com, this feature is available. + +When this feature is enabled, you can additionally view blame for a file directly from the file page. + +To do so: + +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Code > Repository**. +1. Select the file you want to review. +1. In the file header, select **Blame**, and go to the line you want to see. + ### Blame previous commit To see earlier revisions of a specific line: diff --git a/doc/user/project/repository/gpg_signed_commits/index.md b/doc/user/project/repository/gpg_signed_commits/index.md deleted file mode 100644 index 592041ef4e2..00000000000 --- a/doc/user/project/repository/gpg_signed_commits/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../signed_commits/gpg.md' -remove_date: '2023-12-01' ---- - -This document was moved to [another location](../signed_commits/gpg.md). - -<!-- This redirect file can be deleted after <2023-12-01>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/user/project/repository/index.md b/doc/user/project/repository/index.md index dd8ee61f6ae..550ff25e0b1 100644 --- a/doc/user/project/repository/index.md +++ b/doc/user/project/repository/index.md @@ -39,7 +39,7 @@ You can upload a file from the GitLab UI. 1. Go to the directory where you want to upload the file. 1. Next to the directory name, select the plus icon (**{plus}**) > **Upload file**. 1. Complete the fields. - - To create a merge request with your changes, enter a branch name + To create a merge request with your changes, enter a branch name that's not your repository's [default branch](branches/default.md). 1. Select **Upload file**. @@ -85,7 +85,7 @@ Projects that contain a `.xcodeproj` or `.xcworkspace` directory can be cloned into Xcode on macOS. 1. From the GitLab UI, go to the project's overview page. -1. Select **Clone**. +1. In the upper-right corner, select **Code**. 1. Select **Xcode**. The project is cloned onto your computer and you are @@ -101,7 +101,7 @@ Visual Studio Code: - From the GitLab interface: 1. Go to the project's overview page. - 1. Select **Clone**. + 1. In the upper-right corner, select **Code**. 1. Under **Open in your IDE**, select **Visual Studio Code (SSH)** or **Visual Studio Code (HTTPS)**. 1. Select a folder to clone the project into. @@ -121,16 +121,15 @@ Prerequisites: To do this: 1. Go to the project's overview page. -1. Select **Clone**. +1. In the upper-right corner, select **Code**. 1. Under **Open in your IDE**, select **IntelliJ IDEA (SSH)** or **IntelliJ IDEA (HTTPS)**. ## Download the code in a repository -> Support for [including Git LFS blobs](../../../topics/git/lfs#lfs-objects-in-project-archives) was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15079) in GitLab 13.5. - You can download the source code that's stored in a repository. -1. Above the file list, select the download icon (**{download}**). +1. On the left sidebar, select **Search or go to** and find your project. +1. Above the file list, select **Code**. 1. From the options, select the files you want to download. - **Source code:** diff --git a/doc/user/project/repository/managing_large_repositories.md b/doc/user/project/repository/managing_large_repositories.md deleted file mode 100644 index 1fedd8da20c..00000000000 --- a/doc/user/project/repository/managing_large_repositories.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: 'monorepos/index.md' -remove_date: '2023-12-17' ---- - -This document was moved to [another location](monorepos/index.md). - -<!-- This redirect file can be deleted after <2023-12-17>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/user/project/repository/mirror/bidirectional.md b/doc/user/project/repository/mirror/bidirectional.md index d4ab550cb8a..dc789d28a4f 100644 --- a/doc/user/project/repository/mirror/bidirectional.md +++ b/doc/user/project/repository/mirror/bidirectional.md @@ -39,7 +39,7 @@ instance can help reduce race conditions by syncing changes more frequently. Prerequisites: - You have configured the [push](push.md#set-up-a-push-mirror-to-another-gitlab-instance-with-2fa-activated) -and [pull](pull.md#pull-from-a-remote-repository) mirrors in the upstream GitLab instance. + and [pull](pull.md#pull-from-a-remote-repository) mirrors in the upstream GitLab instance. To create the webhook in the downstream instance: diff --git a/doc/user/project/repository/mirror/index.md b/doc/user/project/repository/mirror/index.md index 34a2757bb67..9d5048a4fed 100644 --- a/doc/user/project/repository/mirror/index.md +++ b/doc/user/project/repository/mirror/index.md @@ -208,4 +208,4 @@ Older versions of SSH may require you to remove `-E md5` from the command. - [Troubleshooting](troubleshooting.md) for repository mirroring. - Configure a [Pull Mirroring Interval](../../../../administration/instance_limits.md#pull-mirroring-interval) - [Disable mirrors for a project](../../../../administration/settings/visibility_and_access_controls.md#enable-project-mirroring) -- [Secrets file and mirroring](../../../../administration/backup_restore/backup_gitlab.md#when-the-secrets-file-is-lost) +- [Secrets file and mirroring](../../../../administration/backup_restore/troubleshooting_backup_gitlab.md#when-the-secrets-file-is-lost) diff --git a/doc/user/project/repository/mirror/push.md b/doc/user/project/repository/mirror/push.md index 3aa4c768ebe..babe99441ef 100644 --- a/doc/user/project/repository/mirror/push.md +++ b/doc/user/project/repository/mirror/push.md @@ -161,7 +161,7 @@ To set up a mirror from GitLab to AWS CodeCommit: 1. Copy or download the special Git HTTPS user ID and password. 1. In the AWS CodeCommit console, create a new repository to mirror from your GitLab repository. -1. Open your new repository, and then select **Clone URL > Clone HTTPS** (not **Clone HTTPS (GRC)**). +1. Open your new repository, in the upper-right corner, select **Code > Clone HTTPS** (not **Clone HTTPS (GRC)**). 1. In GitLab, open the repository to be push-mirrored. 1. Select **Settings > Repository**, and then expand **Mirroring repositories**. 1. Fill in the **Git repository URL** field using this format, replacing diff --git a/doc/user/project/repository/mirror/troubleshooting.md b/doc/user/project/repository/mirror/troubleshooting.md index 57a9351e85d..f252c047072 100644 --- a/doc/user/project/repository/mirror/troubleshooting.md +++ b/doc/user/project/repository/mirror/troubleshooting.md @@ -215,3 +215,13 @@ Project.where(mirror: true).each do |project| project.save end ``` + +## `The requested URL returned error: 301` + +When mirroring using the `http://` or `https://` protocols, be sure to specify the exact URL to the repository: `https://gitlab.example.com/group/project.git` + +HTTP redirects are not followed and omitting `.git` can result in a 301 error: + +```plaintext +13:fetch remote: "fatal: unable to access 'https://gitlab.com/group/project': The requested URL returned error: 301\n": exit status 128. +``` diff --git a/doc/user/project/repository/push_rules.md b/doc/user/project/repository/push_rules.md index fc36748a8dd..b15d66e27fb 100644 --- a/doc/user/project/repository/push_rules.md +++ b/doc/user/project/repository/push_rules.md @@ -118,20 +118,20 @@ Some validation examples: - Branches must start with `JIRA-`. ```plaintext - `^JIRA-` + ^JIRA- ``` - Branches must end with `-JIRA`. ```plaintext - `-JIRA$` + -JIRA$ ``` - Branches must be between `4` and `15` characters long, accepting only lowercase letters, numbers and dashes. ```plaintext - `^[a-z0-9\\-]{4,15}$` + ^[a-z0-9\\-]{4,15}$ ``` ## Prevent unintended consequences diff --git a/doc/user/project/repository/reducing_the_repo_size_using_git.md b/doc/user/project/repository/reducing_the_repo_size_using_git.md index a060973d89f..528e9eefa44 100644 --- a/doc/user/project/repository/reducing_the_repo_size_using_git.md +++ b/doc/user/project/repository/reducing_the_repo_size_using_git.md @@ -190,7 +190,7 @@ no longer being available. To clean up a repository: -1. Go to the project for the repository. +1. On the left sidebar, select **Search or go to** and find your project. 1. Go to **Settings > Repository**. 1. Upload a list of objects. For example, a `commit-map` file created by `git filter-repo` which is located in the `filter-repo` directory. diff --git a/doc/user/project/repository/signed_commits/ssh.md b/doc/user/project/repository/signed_commits/ssh.md index e1c2a73be3e..1d3fca6d681 100644 --- a/doc/user/project/repository/signed_commits/ssh.md +++ b/doc/user/project/repository/signed_commits/ssh.md @@ -156,7 +156,7 @@ To revoke an SSH key: 1. On the left sidebar, select your avatar. 1. Select **Edit profile**. -1. On the left sidebar, select (**{key}**) **SSH Keys**. +1. On the left sidebar, select **SSH Keys** (**{key}**). 1. Select **Revoke** next to the SSH key you want to delete. ## Related topics diff --git a/doc/user/project/repository/ssh_signed_commits/index.md b/doc/user/project/repository/ssh_signed_commits/index.md deleted file mode 100644 index 89e3d811dba..00000000000 --- a/doc/user/project/repository/ssh_signed_commits/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../signed_commits/ssh.md' -remove_date: '2023-12-01' ---- - -This document was moved to [another location](../signed_commits/ssh.md). - -<!-- This redirect file can be deleted after <2023-12-01>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/user/project/repository/web_editor.md b/doc/user/project/repository/web_editor.md index 3899890ea7e..d2df9cc18ae 100644 --- a/doc/user/project/repository/web_editor.md +++ b/doc/user/project/repository/web_editor.md @@ -20,7 +20,7 @@ To create a text file in the Web Editor: 1. Go to the directory where you want to create the new file. 1. Next to the directory name, select the plus icon (**{plus}**) > **New file**. 1. Complete the fields. - - To create a merge request with your changes, enter a branch name + To create a merge request with your changes, enter a branch name that's not your repository's [default branch](branches/default.md). 1. Select **Commit changes**. @@ -31,14 +31,14 @@ To create a text file from a template in the Web Editor: 1. On the left sidebar, select **Search or go to** and find your project. 1. Go to the directory where you want to create the new file. 1. Next to the directory name, select the plus icon (**{plus}**) > **New file**. -1. In **Filename**, enter a filename that GitLab provides a template for: +1. In **Filename**, enter a name that GitLab provides a template for: - `.gitignore` - `.gitlab-ci.yml` - `LICENSE` - `Dockerfile` 1. From the **Apply a template** dropdown list, select a template. 1. Complete the fields. - - To create a merge request with your changes, enter a branch name + To create a merge request with your changes, enter a branch name that's not your repository's [default branch](branches/default.md). 1. Select **Commit changes**. @@ -50,7 +50,7 @@ To edit a text file in the Web Editor: 1. Go to the file you want to edit. 1. Select **Edit > Edit single file**. 1. Complete the fields. - - To create a merge request with your changes, enter a branch name + To create a merge request with your changes, enter a branch name that's not your repository's [default branch](branches/default.md). 1. Select **Commit changes**. @@ -72,7 +72,7 @@ To close the preview panel, select the **Write** tab. ### Link to specific lines To link to single or multiple lines in the Web Editor, add hash -information to the filename segment of the URL. For example: +information to the file name segment of the URL. For example: - `MY_FILE.js#L3` highlights line 3 in `MY_FILE.js`. - `MY_FILE.js#L3-10` highlights lines 3 to 10 in `MY_FILE.js`. @@ -90,7 +90,7 @@ To upload a file in the Web Editor: 1. Go to the directory where you want to upload the file. 1. Next to the directory name, select the plus icon (**{plus}**) > **Upload file**. 1. Complete the fields. - - To create a merge request with your changes, enter a branch name + To create a merge request with your changes, enter a branch name that's not your repository's [default branch](branches/default.md). 1. Select **Upload file**. @@ -102,7 +102,7 @@ To create a directory in the Web Editor: 1. Go to the directory where you want to create the new directory. 1. Next to the directory name, select the plus icon (**{plus}**) > **New directory**. 1. Complete the fields. - - To create a merge request with your changes, enter a branch name + To create a merge request with your changes, enter a branch name that's not your repository's [default branch](branches/default.md). 1. Select **Create directory**. diff --git a/doc/user/project/repository/x509_signed_commits/index.md b/doc/user/project/repository/x509_signed_commits/index.md deleted file mode 100644 index ae418581820..00000000000 --- a/doc/user/project/repository/x509_signed_commits/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../signed_commits/x509.md' -remove_date: '2023-12-01' ---- - -This document was moved to [another location](../signed_commits/x509.md). - -<!-- This redirect file can be deleted after <2023-12-01>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> |