diff options
Diffstat (limited to 'doc/user')
33 files changed, 228 insertions, 218 deletions
diff --git a/doc/user/analytics/dora_metrics.md b/doc/user/analytics/dora_metrics.md index e90bfd690ca..a85c6be4ae1 100644 --- a/doc/user/analytics/dora_metrics.md +++ b/doc/user/analytics/dora_metrics.md @@ -28,7 +28,7 @@ For a video explanation, see [DORA metrics: User analytics](https://www.youtube. The four DORA metrics are available out-of-the-box in the [Value Streams Dashboard](value_streams_dashboard.md). This helps you visualize the engineering work in the context of end-to-end value delivery. -The One DevOps Platform [Value Stream Management](https://gitlab.com/gitlab-org/gitlab/-/value_stream_analytics) provides end-to-end visibility to the entire software delivery lifecycle. +The One DevOps Platform [Value Stream Management](https://gitlab.com/gitlab-org/gitlab/-/value_stream_analytics) provides end-to-end visibility into the entire software delivery lifecycle. This enables teams and managers to understand all aspects of productivity, quality, and delivery, without the ["toolchain tax"](https://about.gitlab.com/solutions/value-stream-management/). ## Deployment frequency @@ -42,7 +42,7 @@ High deployment frequency means you can get feedback sooner and iterate faster t ### How deployment frequency is calculated -In GitLab, Deployment frequency is measured by the average number of deployments per day to a given environment, based on the deployment's end time (its `finished_at` property). +In GitLab, deployment frequency is measured by the average number of deployments per day to a given environment, based on the deployment's end time (its `finished_at` property). GitLab calculates the deployment frequency from the number of finished deployments on the given day. Only successful deployments (`Deployment.statuses = success`) are counted. The calculation takes into account the production `environment tier` or the environments named `production/prod`. The environment must be part of the production deployment tier for its deployment information to appear on the graphs. @@ -51,28 +51,29 @@ The calculation takes into account the production `environment tier` or the envi The first step is to benchmark the cadence of code releases between groups and projects. Next, you should consider: -- Add more automated testing. -- Add more automated code validation. -- Break the changes down into smaller iterations. +- Adding automated testing. +- Adding automated code validation. +- Breaking the changes down into smaller iterations. ## Lead time for changes Lead time for changes is the amount of time it takes a code change to get into production. -"Lead time for changes" is not the same as "Lead time". In the value stream, "Lead time" measures the time it takes for work on an issue to move from the moment it's requested (Issue created) to the moment it's fulfilled and delivered (Issue closed). +**Lead time for changes** is not the same as **Lead time**. In the value stream, lead time measures the time it takes for work on an issue to move from the moment it's requested (Issue created) to the moment it's fulfilled and delivered (Issue closed). -For software leaders, Lead time for changes reflects the efficiency of CI/CD pipelines and visualizes how quickly work is delivered to customers. +For software leaders, lead time for changes reflects the efficiency of CI/CD pipelines and visualizes how quickly work is delivered to customers. Over time, the lead time for changes should decrease, while your team's performance should increase. Low lead time for changes means more efficient CI/CD pipelines. -In GitLab, Lead time for changes is measure by the `Median time it takes for a merge request to get merged into production (from master)`. -By default, Lead time for changes measures only one-branch operations with multiple deployment jobs (for example, jobs moving from development to staging to production jobs on the main branch). +In GitLab, lead time for changes is measured by the `Median time it takes for a merge request to get merged into production (from master)`. + +By default, lead time for changes measures only one-branch operations with multiple deployment jobs (for example, jobs moving from development to staging to production jobs on the main branch). When a merge request gets merged in staging and then merge to production, GitLab processes them as two deployed merge requests, not one. ### How lead time for changes is calculated -GitLab calculates Lead time for changes based on the number of seconds to successfully deliver a commit into production - **from** code committed **to** code successfully running in production, without adding the `coding_time` to the calculation. +GitLab calculates lead time for changes based on the number of seconds to successfully deliver a commit into production - **from** code committed **to** code successfully running in production, without adding the `coding_time` to the calculation. -By default, Lead time for changes supports measuring only one branch operation with multiple deployment jobs (for example, from development to staging to production on the default branch). When a merge request gets merged on staging, and then on production, GitLab interprets them as two deployed merge requests, not one. +By default, lead time for changes supports measuring only one branch operation with multiple deployment jobs (for example, from development to staging to production on the default branch). When a merge request gets merged on staging, and then on production, GitLab interprets them as two deployed merge requests, not one. ### How to improve lead time for changes @@ -80,18 +81,18 @@ The first step is to benchmark the CI/CD pipelines' efficiency between groups an - Using Value Stream Analytics to identify bottlenecks in the processes. - Breaking the changes down into smaller iterations. -- Adding more automation. +- Adding automation. ## Time to restore service Time to restore service is the amount of time it takes an organization to recover from a failure in production. -For software leaders, Time to restore service reflects how long it takes an organization to recover from a failure in production. -Low Time to restore service means the organization can take risks with new innovative features to drive competitive advantages and increase business results. +For software leaders, time to restore service reflects how long it takes an organization to recover from a failure in production. +Low time to restore service means the organization can take risks with new innovative features to drive competitive advantages and increase business results. ### How time to restore service is calculated -In GitLab, Time to restore service is measured as the median time an incident was open for on a production environment. +In GitLab, time to restore service is measured as the median time an incident was open for on a production environment. GitLab calculates the number of seconds an incident was open on a production environment in the given time period. This assumes: - [GitLab incidents](../../operations/incident_management/incidents.md) are tracked. @@ -114,8 +115,8 @@ High change failure rate may indicate an inefficient deployment process or insuf ### How change failure rate is calculated -In GitLab, Change failure rate is measured as the percentage of deployments that cause an incident in production in the given time period. -GitLab calculates this by the number of incidents divided by the number of deployments to a production environment. This assumes: +In GitLab, change failure rate is measured as the percentage of deployments that cause an incident in production in the given time period. +GitLab calculates this as the number of incidents divided by the number of deployments to a production environment. This assumes: - [GitLab incidents](../../operations/incident_management/incidents.md) are tracked. - All incidents are related to a production environment. @@ -124,13 +125,11 @@ more than one incident. ### How to improve change failure rate -The first step is to benchmark the quality and stability, between groups and projects. - -To improve this metric, you should consider: +The first step is to benchmark the quality and stability, between groups and projects. Next, you should consider: - Finding the right balance between stability and throughput (Deployment frequency and Lead time for changes), and not sacrificing quality for speed. - Improving the efficacy of code review processes. -- Adding more automated testing. +- Adding automated testing. ## DORA custom calculation rules **(ULTIMATE ALL EXPERIMENT)** @@ -145,9 +144,9 @@ To join the list of users testing this feature, [here is a suggested test flow]( If you find a bug, [open an issue here](https://gitlab.com/groups/gitlab-org/-/epics/11490). To share your use cases and feedback, comment in [epic 11490](https://gitlab.com/groups/gitlab-org/-/epics/11490). -### DORA Lead Time For Changes - multi-branch rule +### Multi-branch rule for lead time for changes -Unlike the default [calculation of Lead time for changes](#how-lead-time-for-changes-is-calculated), this calculation rule allows measuring multi-branch operations with a single deployment job for each operation. +Unlike the default [calculation of lead time for changes](#how-lead-time-for-changes-is-calculated), this calculation rule allows measuring multi-branch operations with a single deployment job for each operation. For example, from development job on development branch, to staging job on staging branch, to production job on production branch. This calculation rule has been implemented by updating the `dora_configurations` table with the target branches that are part of the development flow. @@ -167,23 +166,22 @@ Dora::Configuration.create!(project: my_project, ltfc_target_branches: \['master To retrieve DORA data, use the [GraphQL](../../api/graphql/reference/index.md) or the [REST](../../api/dora/metrics.md) APIs. +## Measure DORA metrics + ### Measure DORA metrics without using GitLab CI/CD pipelines Deployment frequency is calculated based on the deployments record, which is created for typical push-based deployments. These deployment records are not created for pull-based deployments, for example when Container Images are connected to GitLab with an agent. -To track DORA metrics in these cases, you can [create a deployment record](../../api/deployments.md#create-a-deployment) using the Deployments API. See also the documentation page for [Track deployments of an external deployment tool](../../ci/environments/external_deployment_tools.md). +To track DORA metrics in these cases, you can [create a deployment record](../../api/deployments.md#create-a-deployment) using the Deployments API. For more information, see [Track deployments of an external deployment tool](../../ci/environments/external_deployment_tools.md). ### Measure DORA metrics with Jira -- Deployment frequency and Lead time for changes are calculated based on GitLab CI/CD and Merge Requests (MRs), and do not require Jira data. -- Time to restore service and Change failure rate require GitLab incidents for the calculation. For more information, see [Measure DORA Time to restore service and Change failure rate with external incidents](#measure-dora-time-to-restore-service-and-change-failure-rate-with-external-incidents). +- Deployment frequency and lead time for changes are calculated based on GitLab CI/CD and Merge Requests (MRs), and do not require Jira data. +- Time to restore service and change failure rate require [GitLab incidents](../../operations/incident_management/manage_incidents.md) for the calculation. For more information, see [Measure DORA Time to restore service and Change failure rate with external incidents](#measure-dora-time-to-restore-service-and-change-failure-rate-with-external-incidents). ### Measure DORA Time to restore service and Change failure rate with external incidents -[Time to restore service](#time-to-restore-service) and [Change failure rate](#change-failure-rate) -require [GitLab incidents](../../operations/incident_management/manage_incidents.md) to calculate the metrics. - For PagerDuty, you can set up a [webhook to automatically create a GitLab incident for each PagerDuty incident](../../operations/incident_management/manage_incidents.md#using-the-pagerduty-webhook). This configuration requires you to make changes in both PagerDuty and GitLab. diff --git a/doc/user/gitlab_com/index.md b/doc/user/gitlab_com/index.md index 6f809ae867a..451c1235bb2 100644 --- a/doc/user/gitlab_com/index.md +++ b/doc/user/gitlab_com/index.md @@ -191,7 +191,7 @@ the related documentation. ## Package registry limits The [maximum file size](../../administration/instance_limits.md#file-size-limits) -for a package uploaded to the [GitLab Package Registry](../../user/packages/package_registry/index.md) +for a package uploaded to the [GitLab package registry](../../user/packages/package_registry/index.md) varies by format: | Package type | GitLab.com | diff --git a/doc/user/group/import/index.md b/doc/user/group/import/index.md index 3772ba32bc9..32d59cbb322 100644 --- a/doc/user/group/import/index.md +++ b/doc/user/group/import/index.md @@ -435,7 +435,7 @@ Some project items are excluded from migration because they either: - Environments - Feature flags - Infrastructure Registry - - Package Registry + - Package registry - Pages domains - Remote mirrors diff --git a/doc/user/group/settings/group_access_tokens.md b/doc/user/group/settings/group_access_tokens.md index 938389b7831..842b7bc4d17 100644 --- a/doc/user/group/settings/group_access_tokens.md +++ b/doc/user/group/settings/group_access_tokens.md @@ -145,8 +145,8 @@ The scope determines the actions you can perform when you authenticate with a gr | Scope | Description | |:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `api` | Grants complete read and write access to the scoped group and related project API, including the [Package Registry](../../packages/package_registry/index.md). | -| `read_api` | Grants read access to the scoped group and related project API, including the [Package Registry](../../packages/package_registry/index.md). | +| `api` | Grants complete read and write access to the scoped group and related project API, including the [package registry](../../packages/package_registry/index.md). | +| `read_api` | Grants read access to the scoped group and related project API, including the [package registry](../../packages/package_registry/index.md). | | `read_registry` | Grants read access (pull) to the [container registry](../../packages/container_registry/index.md) images if any project within a group is private and authorization is required. | | `write_registry` | Grants write access (push) to the [container registry](../../packages/container_registry/index.md). | | `read_repository` | Grants read access (pull) to all repositories within a group. | diff --git a/doc/user/packages/composer_repository/index.md b/doc/user/packages/composer_repository/index.md index 6eac299e71f..2ebb1088edc 100644 --- a/doc/user/packages/composer_repository/index.md +++ b/doc/user/packages/composer_repository/index.md @@ -4,7 +4,7 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Composer packages in the Package Registry **(FREE ALL BETA)** +# Composer packages in the package registry **(FREE ALL BETA)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15886) in GitLab 13.2. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/221259) from GitLab Premium to GitLab Free in 13.3. @@ -16,7 +16,7 @@ The Composer package registry for GitLab is under development and isn't ready fo limited functionality. This [epic](https://gitlab.com/groups/gitlab-org/-/epics/6817) details the remaining work and timelines to make it production ready. -Publish [Composer](https://getcomposer.org/) packages in your project's Package Registry. +Publish [Composer](https://getcomposer.org/) packages in your project's package registry. Then, install the packages whenever you need to use them as a dependency. For documentation of the specific API endpoints that the Composer @@ -29,7 +29,7 @@ Learn how to [build a Composer package](../workflows/build_packages.md#composer) ## Publish a Composer package by using the API -Publish a Composer package to the Package Registry, +Publish a Composer package to the package registry, so that anyone who can access the project can use the package as a dependency. Prerequisites: @@ -81,7 +81,7 @@ selecting the **Composer** tab. ## Publish a Composer package by using CI/CD -You can publish a Composer package to the Package Registry as part of your CI/CD process. +You can publish a Composer package to the package registry as part of your CI/CD process. 1. Specify a `CI_JOB_TOKEN` in your `.gitlab-ci.yml` file: @@ -123,11 +123,11 @@ When you publish: > Authorization to [download a package archive](../../../api/packages/composer.md#download-a-package-archive) was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/331601) in GitLab 14.10. -Install a package from the Package Registry so you can use it as a dependency. +Install a package from the package registry so you can use it as a dependency. Prerequisites: -- A package in the Package Registry. +- A package in the package registry. - The group ID, which is on the group's home page. - One of the following token types: - A [personal access token](../../../user/profile/personal_access_tokens.md) @@ -138,9 +138,9 @@ Prerequisites: To install a package: -1. Add the Package Registry URL to your project's `composer.json` file, along with the package name and version you want to install: +1. Add the package registry URL to your project's `composer.json` file, along with the package name and version you want to install: - - Connect to the Package Registry for your group: + - Connect to the package registry for your group: ```shell composer config repositories.<group_id> composer https://gitlab.example.com/api/v4/group/<group_id>/-/packages/composer/packages.json diff --git a/doc/user/packages/conan_repository/index.md b/doc/user/packages/conan_repository/index.md index 74152515198..d1097e2a466 100644 --- a/doc/user/packages/conan_repository/index.md +++ b/doc/user/packages/conan_repository/index.md @@ -4,7 +4,7 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Conan packages in the Package Registry **(FREE ALL EXPERIMENT)** +# Conan packages in the package registry **(FREE ALL EXPERIMENT)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/8248) in GitLab 12.6. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/221259) from GitLab Premium to GitLab Free in 13.3. @@ -17,25 +17,25 @@ work and timelines to make it production ready. NOTE: The Conan registry is not FIPS compliant and is disabled when [FIPS mode](../../../development/fips_compliance.md) is enabled. -Publish Conan packages in your project's Package Registry. Then install the +Publish Conan packages in your project's package registry. Then install the packages whenever you need to use them as a dependency. -To publish Conan packages to the Package Registry, add the Package Registry as a +To publish Conan packages to the package registry, add the package registry as a remote and authenticate with it. Then you can run `conan` commands and publish your package to the -Package Registry. +package registry. For documentation of the specific API endpoints that the Conan package manager client uses, see the [Conan API documentation](../../../api/packages/conan.md). Learn how to [build a Conan package](../workflows/build_packages.md#conan). -## Add the Package Registry as a Conan remote +## Add the package registry as a Conan remote -To run `conan` commands, you must add the Package Registry as a Conan remote for +To run `conan` commands, you must add the package registry as a Conan remote for your project or instance. Then you can publish packages to -and install packages from the Package Registry. +and install packages from the package registry. ### Add a remote for your project @@ -105,13 +105,13 @@ Example recipe names: [Project remotes](#add-a-remote-for-your-project) have a more flexible naming convention. -## Authenticate to the Package Registry +## Authenticate to the package registry GitLab requires authentication to upload packages, and to install packages from private and internal projects. (You can, however, install packages from public projects without authentication.) -To authenticate to the Package Registry, you need one of the following: +To authenticate to the package registry, you need one of the following: - A [personal access token](../../../user/profile/personal_access_tokens.md) with the scope set to `api`. @@ -151,8 +151,8 @@ occasionally need to re-enter your personal access token. ### Set a default remote for your project (optional) -If you want to interact with the GitLab Package Registry without having to -specify a remote, you can tell Conan to always use the Package Registry for your +If you want to interact with the GitLab package registry without having to +specify a remote, you can tell Conan to always use the package registry for your packages. In a terminal, run this command: @@ -174,14 +174,14 @@ remote in your commands: ## Publish a Conan package -Publish a Conan package to the Package Registry, so that anyone who can access +Publish a Conan package to the package registry, so that anyone who can access the project can use the package as a dependency. Prerequisites: - The Conan remote [must be configured](#add-the-package-registry-as-a-conan-remote). - [Authentication](#authenticate-to-the-package-registry) with the - Package Registry must be configured. + package registry must be configured. - A local [Conan package](https://docs.conan.io/en/latest/creating_packages/getting_started.html) must exist. - For an instance remote, the package must meet the [naming convention](#package-recipe-naming-convention-for-instance-remotes). @@ -229,7 +229,7 @@ only the most recently-published package is returned. ## Install a Conan package -Install a Conan package from the Package Registry so you can use it as a +Install a Conan package from the package registry so you can use it as a dependency. You can install a package from the scope of your instance or your project. If multiple packages have the same recipe, when you install a package, the most recently-published package is retrieved. @@ -242,7 +242,7 @@ Prerequisites: - The Conan remote [must be configured](#add-the-package-registry-as-a-conan-remote). - For private and internal projects, you must configure [Authentication](#authenticate-to-the-package-registry) - with the Package Registry. + with the package registry. 1. In the project where you want to install the package as a dependency, open `conanfile.txt`. Or, in the root of your project, create a file called @@ -278,7 +278,7 @@ Delete `~/.conan/data` to clean up the packages stored in the cache. ## Remove a Conan package -There are two ways to remove a Conan package from the GitLab Package Registry. +There are two ways to remove a Conan package from the GitLab package registry. - From the command line, using the Conan client: @@ -291,14 +291,14 @@ There are two ways to remove a Conan package from the GitLab Package Registry. NOTE: This command removes all recipe and binary package files from the - Package Registry. + package registry. - From the GitLab user interface: Go to your project's **Deploy > Package Registry**. Remove the package by selecting **Remove repository** (**{remove}**). -## Search for Conan packages in the Package Registry +## Search for Conan packages in the package registry To search by full or partial package name, or by exact recipe, run the `conan search` command. @@ -327,7 +327,7 @@ packages in the target project, as long as you have permission to access it. NOTE: The limit of the search results is 500 packages, and the results are sorted by the most recently published packages. -## Fetch Conan package information from the Package Registry +## Fetch Conan package information from the package registry The `conan info` command returns information about a package: @@ -339,13 +339,13 @@ conan info Hello/0.1@mycompany/beta The GitLab Conan repository supports the following Conan CLI commands: -- `conan upload`: Upload your recipe and package files to the Package Registry. -- `conan install`: Install a Conan package from the Package Registry, which +- `conan upload`: Upload your recipe and package files to the package registry. +- `conan install`: Install a Conan package from the package registry, which includes using the `conanfile.txt` file. -- `conan search`: Search the Package Registry for public packages, and private +- `conan search`: Search the package registry for public packages, and private packages you have permission to view. -- `conan info`: View the information on a given package from the Package Registry. -- `conan remove`: Delete the package from the Package Registry. +- `conan info`: View the information on a given package from the package registry. +- `conan remove`: Delete the package from the package registry. ## Troubleshooting diff --git a/doc/user/packages/debian_repository/index.md b/doc/user/packages/debian_repository/index.md index 45ebfb2ef73..5c304664d42 100644 --- a/doc/user/packages/debian_repository/index.md +++ b/doc/user/packages/debian_repository/index.md @@ -4,7 +4,7 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Debian packages in the Package Registry **(FREE SELF EXPERIMENT)** +# Debian packages in the package registry **(FREE SELF EXPERIMENT)** > - Debian API [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/42670) in GitLab 13.5. > - Debian group API [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66188) in GitLab 14.2. @@ -14,7 +14,7 @@ WARNING: The Debian package registry for GitLab is under development and isn't ready for production use. This [epic](https://gitlab.com/groups/gitlab-org/-/epics/6057) details the remaining work and timelines to make it production ready. Support for [Debian packages is an experiment](../package_registry/supported_package_managers.md), and has known security vulnerabilities. -Publish Debian packages in your project's Package Registry. Then install the +Publish Debian packages in your project's package registry. Then install the packages whenever you need to use them as a dependency. Project and Group packages are supported. diff --git a/doc/user/packages/generic_packages/index.md b/doc/user/packages/generic_packages/index.md index 1416dcde14f..9ef7c440cfe 100644 --- a/doc/user/packages/generic_packages/index.md +++ b/doc/user/packages/generic_packages/index.md @@ -9,11 +9,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4209) in GitLab 13.5 [with a flag](../../../administration/feature_flags.md) named `generic_packages`. Enabled by default. > - [Feature flag `generic_packages`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80886) removed in GitLab 14.8. -Publish generic files, like release binaries, in your project's Package Registry. Then, install the packages whenever you need to use them as a dependency. +Publish generic files, like release binaries, in your project's package registry. Then, install the packages whenever you need to use them as a dependency. -## Authenticate to the Package Registry +## Authenticate to the package registry -To authenticate to the Package Registry, you need either a [personal access token](../../../api/rest/index.md#personalprojectgroup-access-tokens), +To authenticate to the package registry, you need either a [personal access token](../../../api/rest/index.md#personalprojectgroup-access-tokens), [CI/CD job token](../../../ci/jobs/ci_job_token.md), or [deploy token](../../project/deploy_tokens/index.md). In addition to the standard API authentication mechanisms, the generic package diff --git a/doc/user/packages/go_proxy/index.md b/doc/user/packages/go_proxy/index.md index 6dffd7371b6..0a12ec153a9 100644 --- a/doc/user/packages/go_proxy/index.md +++ b/doc/user/packages/go_proxy/index.md @@ -53,7 +53,7 @@ Feature.disable(:go_proxy, Project.find(2)) ``` NOTE: -Even if it's enabled, GitLab doesn't display Go modules in the **Package Registry**. +Even if it's enabled, GitLab doesn't display Go modules in the **package registry**. Follow [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/213770) for details. diff --git a/doc/user/packages/helm_repository/index.md b/doc/user/packages/helm_repository/index.md index b7888fe2d18..0efea21635f 100644 --- a/doc/user/packages/helm_repository/index.md +++ b/doc/user/packages/helm_repository/index.md @@ -4,7 +4,7 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Helm charts in the Package Registry **(FREE ALL BETA)** +# Helm charts in the package registry **(FREE ALL BETA)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18997) in GitLab 14.1. @@ -13,7 +13,7 @@ The Helm chart registry for GitLab is under development and isn't ready for prod limited functionality. This [epic](https://gitlab.com/groups/gitlab-org/-/epics/6366) details the remaining work and timelines to make it production ready. -Publish Helm packages in your project's Package Registry. Then install the +Publish Helm packages in your project's package registry. Then install the packages whenever you need to use them as a dependency. For documentation of the specific API endpoints that Helm package manager @@ -127,7 +127,7 @@ See [Using Helm](https://helm.sh/docs/intro/using_helm/) for more information. ## Troubleshooting -### The chart is not visible in the Package Registry after uploading +### The chart is not visible in the package registry after uploading Check the [Sidekiq log](../../../administration/logs/index.md#sidekiqlog) for any related errors. If you see `Validation failed: Version is invalid`, it means that the diff --git a/doc/user/packages/index.md b/doc/user/packages/index.md index a66662955f3..e3fc3179c76 100644 --- a/doc/user/packages/index.md +++ b/doc/user/packages/index.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Packages and Registries **(FREE ALL)** -The GitLab [Package Registry](package_registry/index.md) acts as a private or public registry +The GitLab [package registry](package_registry/index.md) acts as a private or public registry for a variety of common package managers. You can publish and share packages, which can be easily consumed as a dependency in downstream projects. diff --git a/doc/user/packages/maven_repository/index.md b/doc/user/packages/maven_repository/index.md index c8730c42022..e4c92acb6d5 100644 --- a/doc/user/packages/maven_repository/index.md +++ b/doc/user/packages/maven_repository/index.md @@ -4,9 +4,9 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Maven packages in the Package Registry **(FREE ALL)** +# Maven packages in the package registry **(FREE ALL)** -Publish [Maven](https://maven.apache.org) artifacts in your project's Package Registry. +Publish [Maven](https://maven.apache.org) artifacts in your project's package registry. Then, install the packages whenever you need to use them as a dependency. For documentation of the specific API endpoints that the Maven package manager @@ -20,9 +20,9 @@ Supported clients: - `sbt` can only be used to [pull dependencies](#install-a-package). See this [issue 408479](https://gitlab.com/gitlab-org/gitlab/-/issues/408479) for more details. -## Publish to the GitLab Package Registry +## Publish to the GitLab package registry -### Authenticate to the Package Registry +### Authenticate to the package registry You need a token to publish a package. There are different tokens available depending on what you're trying to achieve. For more information, review the [guidance on tokens](../package_registry/index.md#authenticate-with-the-registry). @@ -135,7 +135,7 @@ file: ##### Basic HTTP Authentication -You can also use basic HTTP authentication to authenticate to the Maven Package Registry. +You can also use basic HTTP authentication to authenticate to the Maven package registry. ::Tabs @@ -237,7 +237,7 @@ You must to provide a name and a password. NOTE: The name field must be named to match the token you chose. -To install a package from the Maven GitLab Package Registry by using `sbt`, you must configure +To install a package from the Maven GitLab package registry by using `sbt`, you must configure a [Maven resolver](https://www.scala-sbt.org/1.x/docs/Resolvers.html#Maven+resolvers). If you're accessing a private or an internal project or group, you need to set up [credentials](https://www.scala-sbt.org/1.x/docs/Publishing.html#Credentials). @@ -458,7 +458,7 @@ Go to your project's **Packages and registries** page and view the published pac ## Install a package -To install a package from the GitLab Package Registry, you must configure +To install a package from the GitLab package registry, you must configure the [remote and authenticate](#authenticate-to-the-package-registry). When this is completed, you can install a package from a project, group, or namespace. @@ -489,7 +489,7 @@ To install a package by using `mvn install`: mvn install ``` -The message should show that the package is downloading from the Package Registry: +The message should show that the package is downloading from the package registry: ```shell Downloading from gitlab-maven: http://gitlab.example.com/api/v4/projects/PROJECT_ID/packages/maven/com/mycompany/mydepartment/my-project/1.0-SNAPSHOT/my-project-1.0-20200128.120857-1.pom @@ -509,7 +509,7 @@ You can also install packages by using the Maven [`dependency:get` command](http NOTE: The repository IDs in the command(`gitlab-maven`) and the `settings.xml` file must match. -The message should show that the package is downloading from the Package Registry: +The message should show that the package is downloading from the package registry: ```shell Downloading from gitlab-maven: http://gitlab.example.com/api/v4/projects/PROJECT_ID/packages/maven/com/mycompany/mydepartment/my-project/1.0-SNAPSHOT/my-project-1.0-20200128.120857-1.pom @@ -592,7 +592,7 @@ FLAG: By default this feature is not available for self-managed. To make it available, an administrator can [enable the feature flag](../../../administration/feature_flags.md) named `maven_central_request_forwarding`. This feature is not available for SaaS users. -When a Maven package is not found in the Package Registry, the request is forwarded +When a Maven package is not found in the package registry, the request is forwarded to [Maven Central](https://search.maven.org/). When the feature flag is enabled, administrators can disable this behavior in the @@ -789,13 +789,13 @@ The GitLab Maven repository supports the following CLI commands: :::TabTitle `mvn` -- `mvn deploy`: Publish your package to the Package Registry. +- `mvn deploy`: Publish your package to the package registry. - `mvn install`: Install packages specified in your Maven project. - `mvn dependency:get`: Install a specific package. :::TabTitle `gradle` -- `gradle publish`: Publish your package to the Package Registry. +- `gradle publish`: Publish your package to the package registry. - `gradle install`: Install packages specified in your Gradle project. ::EndTabs diff --git a/doc/user/packages/npm_registry/index.md b/doc/user/packages/npm_registry/index.md index 43defb29fd5..9b85e9d4b35 100644 --- a/doc/user/packages/npm_registry/index.md +++ b/doc/user/packages/npm_registry/index.md @@ -4,17 +4,17 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# npm packages in the Package Registry **(FREE ALL)** +# npm packages in the package registry **(FREE ALL)** For documentation of the specific API endpoints that the npm package manager client uses, see the [npm API documentation](../../../api/packages/npm.md). Learn how to build an [npm](../workflows/build_packages.md#npm) or [yarn](../workflows/build_packages.md#yarn) package. -Watch a [video demo](https://youtu.be/yvLxtkvsFDA) of how to publish npm packages to the GitLab Package Registry. +Watch a [video demo](https://youtu.be/yvLxtkvsFDA) of how to publish npm packages to the GitLab package registry. -## Publish to GitLab Package Registry +## Publish to GitLab package registry -### Authentication to the Package Registry +### Authentication to the package registry You need an token to publish a package. There are different tokens available depending on what you're trying to achieve. For more information, review the [guidance on tokens](../../../user/packages/package_registry/index.md#authenticate-with-the-registry). @@ -43,7 +43,7 @@ If you plan to install a package through the [instance level](#install-from-the- of the project with the source code of the package itself. The scope should be lowercase. - The package name can be anything you want -| Project URL | Package Registry in | Scope | Full package name | +| Project URL | Package registry in | Scope | Full package name | | ------------------------------------------------------- | ------------------- | --------- | ---------------------- | | `https://gitlab.com/my-org/engineering-group/analytics` | Analytics | `@my-org` | `@my-org/package-name` | @@ -81,11 +81,11 @@ Associate your [token](#authentication-to-the-package-registry) with the `"${NPM NPM_TOKEN=your_token npm publish ``` -Your package should now publish to the Package Registry. +Your package should now publish to the package registry. ## Publishing a package by using a CI/CD pipeline -When publishing by using a CI/CD pipeline, you can use the [predefined variables](../../../ci/variables/predefined_variables.md) `${CI_PROJECT_ID}` and `${CI_JOB_TOKEN}` to authenticate with your project's Package Registry. We use these variables to create a `.npmrc` file [for authentication](#authenticating-via-the-npmrc) during execution of your CI/CD job. +When publishing by using a CI/CD pipeline, you can use the [predefined variables](../../../ci/variables/predefined_variables.md) `${CI_PROJECT_ID}` and `${CI_JOB_TOKEN}` to authenticate with your project's package registry. We use these variables to create a `.npmrc` file [for authentication](#authenticating-via-the-npmrc) during execution of your CI/CD job. WARNING: When generating the `.npmrc` file, do not specify the port after `${CI_SERVER_HOST}` if it is a default port, @@ -109,7 +109,7 @@ publish-npm: - Replace `@scope` with the [scope](https://docs.npmjs.com/cli/v10/using-npm/scope) of the package that is being published. -Your package is published to the Package Registry when the `publish-npm` job in your pipeline runs. +Your package is published to the package registry when the `publish-npm` job in your pipeline runs. ## Install a package @@ -121,9 +121,9 @@ You can install a package from a GitLab project, group, or instance: - **Group-level**: Use when you have many npm packages in different projects in the same GitLab group. - **Project-level**: Use when you have few npm packages and they are not in the same GitLab group. -### Authenticate to the Package Registry +### Authenticate to the package registry -You must authenticate to the Package Registry to install a package from a private project or a private group. +You must authenticate to the package registry to install a package from a private project or a private group. No authentication is needed if the project or the group is public. To authenticate with `npm`: @@ -171,7 +171,7 @@ are not supported. WARNING: To install a package from the instance level, the package must have been published following the scoped [naming convention](#naming-convention). -1. [Authenticate to the Package Registry](#authenticate-to-the-package-registry). +1. [Authenticate to the package registry](#authenticate-to-the-package-registry). 1. Set the registry @@ -194,7 +194,7 @@ To install a package from the instance level, the package must have been publish > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299834) in GitLab 16.0 [with a flag](../../../administration/feature_flags.md) named `npm_group_level_endpoints`. Disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121837) in GitLab 16.1. Feature flag `npm_group_level_endpoints` removed. -1. [Authenticate to the Package Registry](#authenticate-to-the-package-registry). +1. [Authenticate to the package registry](#authenticate-to-the-package-registry). 1. Set the registry @@ -214,7 +214,7 @@ To install a package from the instance level, the package must have been publish ### Install from the project level -1. [Authenticate to the Package Registry](#authenticate-to-the-package-registry). +1. [Authenticate to the package registry](#authenticate-to-the-package-registry). 1. Set the registry @@ -269,7 +269,7 @@ npm deprecate @scope/package "" ### Package forwarding to npmjs.com -When an npm package is not found in the Package Registry, the request is forwarded to [npmjs.com](https://www.npmjs.com/). The forward is performed by sending an HTTP redirect back to the requesting client. +When an npm package is not found in the package registry, the request is forwarded to [npmjs.com](https://www.npmjs.com/). The forward is performed by sending an HTTP redirect back to the requesting client. Administrators can disable this behavior in the [Continuous Integration settings](../../admin_area/settings/continuous_integration.md). @@ -289,7 +289,7 @@ and use your organization's URL. The name is case-sensitive and must match the n ### npm metadata -The GitLab Package Registry exposes the following attributes to the npm client. +The GitLab package registry exposes the following attributes to the npm client. These are similar to the [abbreviated metadata format](https://github.com/npm/registry/blob/9e368cf6aaca608da5b2c378c0d53f475298b916/docs/responses/package-metadata.md#abbreviated-metadata-format): - `name` @@ -407,7 +407,7 @@ And the `.npmrc` file should look like: If you get this error, ensure that: -- The Package Registry is enabled in your project settings. Although the Package Registry is enabled by default, it's possible to [disable it](../package_registry/index.md#disable-the-package-registry). +- The package registry is enabled in your project settings. Although the package registry is enabled by default, it's possible to [disable it](../package_registry/index.md#disable-the-package-registry). - Your token is not expired and has appropriate permissions. - A package with the same name or version doesn't already exist within the given scope. - The scoped packages URL includes a trailing slash: diff --git a/doc/user/packages/nuget_repository/index.md b/doc/user/packages/nuget_repository/index.md index 8db79dc6c5f..a12f489d6fe 100644 --- a/doc/user/packages/nuget_repository/index.md +++ b/doc/user/packages/nuget_repository/index.md @@ -4,16 +4,16 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# NuGet packages in the Package Registry **(FREE ALL)** +# NuGet packages in the package registry **(FREE ALL)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20050) in GitLab 12.8. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/221259) from GitLab Premium to GitLab Free in 13.3. > - Symbol package support [added](https://gitlab.com/gitlab-org/gitlab/-/issues/262081) in GitLab 14.1. -Publish NuGet packages in your project's Package Registry. Then, install the +Publish NuGet packages in your project's package registry. Then, install the packages whenever you need to use them as a dependency. -The Package Registry works with: +The package registry works with: - [NuGet CLI](https://learn.microsoft.com/en-us/nuget/reference/nuget-exe-cli-reference) - [.NET Core CLI](https://learn.microsoft.com/en-us/dotnet/core/tools/) @@ -37,18 +37,18 @@ To use the GitLab endpoint for NuGet Packages, choose an option: Some features such as [publishing](#publish-a-nuget-package) a package are only available on the project-level endpoint. -When asking for versions of a given NuGet package name, the GitLab Package Registry returns a maximum of 300 most recent versions. +When asking for versions of a given NuGet package name, the GitLab package registry returns a maximum of 300 most recent versions. Do not use authentication methods other than the methods documented here. Undocumented authentication methods might be removed in the future. WARNING: -Because of how NuGet handles credentials, the Package Registry rejects anonymous requests on the group-level endpoint. +Because of how NuGet handles credentials, the package registry rejects anonymous requests on the group-level endpoint. To work around this limitation, set up [authentication](#add-the-package-registry-as-a-source-for-nuget-packages). -## Add the Package Registry as a source for NuGet packages +## Add the package registry as a source for NuGet packages -To publish and install packages to the Package Registry, you must add the -Package Registry as a source for your packages. +To publish and install packages to the package registry, you must add the +package registry as a source for your packages. Prerequisites: @@ -76,10 +76,10 @@ You can now add a new source to NuGet with: #### Project-level endpoint -A project-level endpoint is required to publish NuGet packages to the Package Registry. +A project-level endpoint is required to publish NuGet packages to the package registry. A project-level endpoint is also required to install NuGet packages from a project. -To use the [project-level](#use-the-gitlab-endpoint-for-nuget-packages) NuGet endpoint, add the Package Registry as a source with `nuget`: +To use the [project-level](#use-the-gitlab-endpoint-for-nuget-packages) NuGet endpoint, add the package registry as a source with `nuget`: ```shell nuget source Add -Name <source_name> -Source "https://gitlab.example.com/api/v4/projects/<your_project_id>/packages/nuget/index.json" -UserName <gitlab_username or deploy_token_username> -Password <gitlab_personal_access_token or deploy_token> @@ -97,7 +97,7 @@ nuget source Add -Name "GitLab" -Source "https://gitlab.example.com/api/v4/proje To install a NuGet package from a group, use a group-level endpoint. -To use the [group-level](#use-the-gitlab-endpoint-for-nuget-packages) NuGet endpoint, add the Package Registry as a source with `nuget`: +To use the [group-level](#use-the-gitlab-endpoint-for-nuget-packages) NuGet endpoint, add the package registry as a source with `nuget`: ```shell nuget source Add -Name <source_name> -Source "https://gitlab.example.com/api/v4/groups/<your_group_id>/-/packages/nuget/index.json" -UserName <gitlab_username or deploy_token_username> -Password <gitlab_personal_access_token or deploy_token> @@ -115,10 +115,10 @@ nuget source Add -Name "GitLab" -Source "https://gitlab.example.com/api/v4/group #### Project-level endpoint -A project-level endpoint is required to publish NuGet packages to the Package Registry. +A project-level endpoint is required to publish NuGet packages to the package registry. A project-level endpoint is also required to install NuGet packages from a project. -To use the [project-level](#use-the-gitlab-endpoint-for-nuget-packages) NuGet endpoint, add the Package Registry as a source with Visual Studio: +To use the [project-level](#use-the-gitlab-endpoint-for-nuget-packages) NuGet endpoint, add the package registry as a source with Visual Studio: 1. Open [Visual Studio](https://visualstudio.microsoft.com/vs/). 1. In Windows, select **Tools > Options**. On macOS, select **Visual Studio > Preferences**. @@ -146,7 +146,7 @@ If you get a warning, ensure that the **Source**, **Username**, and To install a package from a group, use a group-level endpoint. -To use the [group-level](#use-the-gitlab-endpoint-for-nuget-packages) NuGet endpoint, add the Package Registry as a source with Visual Studio: +To use the [group-level](#use-the-gitlab-endpoint-for-nuget-packages) NuGet endpoint, add the package registry as a source with Visual Studio: 1. Open [Visual Studio](https://visualstudio.microsoft.com/vs/). 1. In Windows, select **Tools > Options**. On macOS, select **Visual Studio > Preferences**. @@ -174,11 +174,11 @@ If you get a warning, ensure that the **Source**, **Username**, and #### Project-level endpoint -A project-level endpoint is required to publish NuGet packages to the Package Registry. +A project-level endpoint is required to publish NuGet packages to the package registry. A project-level endpoint is also required to install NuGet packages from a project. To use the [project-level](#use-the-gitlab-endpoint-for-nuget-packages) -NuGet endpoint, add the Package Registry as a source with `nuget`: +NuGet endpoint, add the package registry as a source with `nuget`: ```shell dotnet nuget add source "https://gitlab.example.com/api/v4/projects/<your_project_id>/packages/nuget/index.json" --name <source_name> --username <gitlab_username or deploy_token_username> --password <gitlab_personal_access_token or deploy_token> @@ -198,7 +198,7 @@ dotnet nuget add source "https://gitlab.example.com/api/v4/projects/10/packages/ To install a NuGet package from a group, use a group-level endpoint. To use the [group-level](#use-the-gitlab-endpoint-for-nuget-packages) -NuGet endpoint, add the Package Registry as a source with `nuget`: +NuGet endpoint, add the package registry as a source with `nuget`: ```shell dotnet nuget add source "https://gitlab.example.com/api/v4/groups/<your_group_id>/-/packages/nuget/index.json" --name <source_name> --username <gitlab_username or deploy_token_username> --password <gitlab_personal_access_token or deploy_token> @@ -219,10 +219,10 @@ dotnet nuget add source "https://gitlab.example.com/api/v4/groups/23/-/packages/ A project-level endpoint is required to: -- Publish NuGet packages to the Package Registry. +- Publish NuGet packages to the package registry. - Install NuGet packages from a project. -To use the [project-level](#use-the-gitlab-endpoint-for-nuget-packages) Package Registry as a source for .NET: +To use the [project-level](#use-the-gitlab-endpoint-for-nuget-packages) package registry as a source for .NET: 1. In the root of your project, create a file named `nuget.config`. 1. Add this content: @@ -254,7 +254,7 @@ To use the [project-level](#use-the-gitlab-endpoint-for-nuget-packages) Package To install a package from a group, use a group-level endpoint. -To use the [group-level](#use-the-gitlab-endpoint-for-nuget-packages) Package Registry as a source for .NET: +To use the [group-level](#use-the-gitlab-endpoint-for-nuget-packages) package registry as a source for .NET: 1. In the root of your project, create a file named `nuget.config`. 1. Add this content: @@ -288,11 +288,11 @@ You can add a source feed with the Chocolatey CLI. If you use Chocolatey CLI v1. #### Configure a project-level endpoint -You need a project-level endpoint to publish NuGet packages to the Package Registry. +You need a project-level endpoint to publish NuGet packages to the package registry. -To use the [project-level](#use-the-gitlab-endpoint-for-nuget-packages) Package Registry as a source for Chocolatey: +To use the [project-level](#use-the-gitlab-endpoint-for-nuget-packages) package registry as a source for Chocolatey: -- Add the Package Registry as a source with `choco`: +- Add the package registry as a source with `choco`: ```shell choco source add -n=gitlab -s "'https://gitlab.example.com/api/v4/projects/<your_project_id>/packages/nuget/v2'" -u=<gitlab_username or deploy_token_username> -p=<gitlab_personal_access_token or deploy_token> @@ -306,7 +306,7 @@ Prerequisite: When publishing packages: -- The Package Registry on GitLab.com can store up to 5 GB of content. +- The package registry on GitLab.com can store up to 5 GB of content. This limit is [configurable for self-managed GitLab instances](../../../administration/instance_limits.md#package-registry-limits). - If you publish the same package with the same version multiple times, each consecutive upload is saved as a separate file. When installing a package, @@ -362,7 +362,7 @@ dotnet nuget push <package_file> --source <source_url> --api-key <gitlab_persona ``` - `<package_file>` is your package filename, ending in `.nupkg`. -- `<source_url>` is the URL of the NuGet Package Registry. +- `<source_url>` is the URL of the NuGet package registry. For example: @@ -408,7 +408,7 @@ updated: Prerequisite: -- The project-level Package Registry is a source for Chocolatey. +- The project-level package registry is a source for Chocolatey. To publish a package with the Chocolatey CLI: @@ -419,7 +419,7 @@ choco push <package_file> --source <source_url> --api-key <gitlab_personal_acces In this command: - `<package_file>` is your package filename and ends with `.nupkg`. -- `<source_url>` is the URL of the NuGet v2 feed Package Registry. +- `<source_url>` is the URL of the NuGet v2 feed package registry. For example: @@ -457,14 +457,14 @@ not be recognized as a duplicate. If multiple packages have the same name and version, when you install a package, the most recently-published package is retrieved. -To install a NuGet package from the Package Registry, you must first +To install a NuGet package from the package registry, you must first [add a project-level or group-level endpoint](#add-the-package-registry-as-a-source-for-nuget-packages). ### Install a package with the NuGet CLI WARNING: By default, `nuget` checks the official source at `nuget.org` first. If you have -a NuGet package in the Package Registry with the same name as a package at +a NuGet package in the package registry with the same name as a package at `nuget.org`, you must specify the source name to install the correct package. Install the latest version of a package by running this command: @@ -483,7 +483,7 @@ nuget install <package_id> -OutputDirectory <output_directory> \ ### Install a package with the .NET CLI WARNING: -If you have a package in the Package Registry with the same name as a package at +If you have a package in the package registry with the same name as a package at a different source, verify the order in which `dotnet` checks sources during install. This is defined in the `nuget.config` file. @@ -503,7 +503,7 @@ dotnet add package <package_id> \ Prerequisites: -- The project-level Package Registry is a [v2 feed source](#add-a-source-with-chocolatey-cli) for Chocolatey. +- The project-level package registry is a [v2 feed source](#add-a-source-with-chocolatey-cli) for Chocolatey. - A version must be provided when installing or upgrading a package using NuGet v2 feed. To install a package with the Chocolatey CLI: @@ -515,7 +515,7 @@ choco install <package_id> -Source <source_url> -Version <package_version> In this command: - `<package_id>` is the package ID. -- `<source_url>` is the URL or name of the NuGet v2 feed Package Registry. +- `<source_url>` is the URL or name of the NuGet v2 feed package registry. - `<package_version>` is the package version. For example: @@ -537,7 +537,7 @@ choco upgrade <package_id> -Source <source_url> -Version <package_version> In this command: - `<package_id>` is the package ID. -- `<source_url>` is the URL or name of the NuGet v2 feed Package Registry. +- `<source_url>` is the URL or name of the NuGet v2 feed package registry. - `<package_version>` is the package version. For example: diff --git a/doc/user/packages/package_registry/index.md b/doc/user/packages/package_registry/index.md index e9c019deefa..3934122ffed 100644 --- a/doc/user/packages/package_registry/index.md +++ b/doc/user/packages/package_registry/index.md @@ -4,17 +4,17 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Package Registry **(FREE ALL)** +# Package registry **(FREE ALL)** > [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/221259) from GitLab Premium to GitLab Free in 13.3. -With the GitLab Package Registry, you can use GitLab as a private or public registry for a variety +With the GitLab package registry, you can use GitLab as a private or public registry for a variety of [supported package managers](supported_package_managers.md). You can publish and share packages, which can be consumed as a dependency in downstream projects. ## Package workflows -Learn how to use the GitLab Package Registry to build your own custom package workflow: +Learn how to use the GitLab package registry to build your own custom package workflow: - [Use a project as a package registry](../workflows/project_registry.md) to publish all of your packages to one project. @@ -83,7 +83,7 @@ authenticate with GitLab by using the `CI_JOB_TOKEN`. CI/CD templates, which you can use to get started, are in [this repository](https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/gitlab/ci/templates). -For more information about using the GitLab Package Registry with CI/CD, see: +For more information about using the GitLab package registry with CI/CD, see: - [Composer](../composer_repository/index.md#publish-a-composer-package-by-using-cicd) - [Conan](../conan_repository/index.md#publish-a-conan-package-by-using-cicd) @@ -110,18 +110,18 @@ For a list of supported packages, see [Importing packages from other repositorie ## Reduce storage usage -For information on reducing your storage use for the Package Registry, see -[Reduce Package Registry storage use](reduce_package_registry_storage.md). +For information on reducing your storage use for the package registry, see +[Reduce package registry storage use](reduce_package_registry_storage.md). -## Disable the Package Registry +## Disable the package registry -The Package Registry is automatically enabled. +The package registry is automatically enabled. If you are using a self-managed instance of GitLab, your administrator can remove the menu item, **Packages and registries**, from the GitLab sidebar. For more information, see the [administration documentation](../../../administration/packages/index.md). -You can also remove the Package Registry for your project specifically: +You can also remove the package registry for your project specifically: 1. In your project, go to **Settings > General**. 1. Expand the **Visibility, project features, permissions** section and disable the @@ -130,33 +130,33 @@ You can also remove the Package Registry for your project specifically: The **Deploy > Package Registry** entry is removed from the sidebar. -## Package Registry visibility permissions +## Package registry visibility permissions [Project-level permissions](../../permissions.md) determine actions such as downloading, pushing, or deleting packages. -The visibility of the Package Registry is independent of the repository and can be controlled from +The visibility of the package registry is independent of the repository and can be controlled from your project's settings. For example, if you have a public project and set the repository visibility -to **Only Project Members**, the Package Registry is then public. Disabling the Package -Registry disables all Package Registry operations. +to **Only Project Members**, the package registry is then public. Disabling the Package +Registry disables all package registry operations. | Project visibility | Action | Minimum [role](../../permissions.md#roles) required | |--------------------|-----------------------|---------------------------------------------------------| -| Public | View Package Registry | `n/a`, everyone on the internet can perform this action | +| Public | View package registry | `n/a`, everyone on the internet can perform this action | | Public | Publish a package | Developer | | Public | Pull a package | `n/a`, everyone on the internet can perform this action | -| Internal | View Package Registry | Guest | +| Internal | View package registry | Guest | | Internal | Publish a package | Developer | | Internal | Pull a package | Guest (1) | -| Private | View Package Registry | Reporter | +| Private | View package registry | Reporter | | Private | Publish a package | Developer | | Private | Pull a package | Reporter (1) | -### Allow anyone to pull from Package Registry +### Allow anyone to pull from package registry > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385994) in GitLab 15.7. -To allow anyone to pull from the Package Registry, regardless of project visibility: +To allow anyone to pull from the package registry, regardless of project visibility: 1. On the left sidebar, select **Search or go to** and find your private or internal project. 1. On the left sidebar, select **Settings > General**. @@ -164,7 +164,7 @@ To allow anyone to pull from the Package Registry, regardless of project visibil 1. Turn on the **Allow anyone to pull from Package Registry** toggle. 1. Select **Save changes**. -Anyone on the internet can access the Package Registry for the project. +Anyone on the internet can access the package registry for the project. #### Disable allowing anyone to pull @@ -178,7 +178,7 @@ To hide the **Allow anyone to pull from Package Registry** toggle globally: Anonymous downloads are disabled, even for projects that turned on the **Allow anyone to pull from Package Registry** toggle. -Several known issues exist when you allow anyone to pull from the Package Registry: +Several known issues exist when you allow anyone to pull from the package registry: - Project-level endpoints are supported. Group-level and instance-level endpoints are not supported. Support for group-level endpoints is proposed in [issue 383537](https://gitlab.com/gitlab-org/gitlab/-/issues/383537). - It does not work with the [Composer](../composer_repository/index.md#install-a-composer-package), because Composer only has a group endpoint. diff --git a/doc/user/packages/package_registry/reduce_package_registry_storage.md b/doc/user/packages/package_registry/reduce_package_registry_storage.md index e6251034cb2..ff708e70d2b 100644 --- a/doc/user/packages/package_registry/reduce_package_registry_storage.md +++ b/doc/user/packages/package_registry/reduce_package_registry_storage.md @@ -4,7 +4,7 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reduce Package Registry Storage **(FREE ALL)** +# Reduce package registry storage **(FREE ALL)** Without cleanup, package registries become large over time. When a large number of packages and their assets are added: @@ -14,13 +14,13 @@ their assets are added: We recommend deleting unnecessary packages and assets. This page offers examples of how to do so. -## Check Package Registry Storage Use +## Check package registry storage use The Usage Quotas page (**Settings > Usage Quotas > Storage**) displays storage usage for Packages. ## Delete a package -You cannot edit a package after you publish it in the Package Registry. Instead, you +You cannot edit a package after you publish it in the package registry. Instead, you must delete and recreate it. To delete a package, you must have suitable [permissions](../../permissions.md). diff --git a/doc/user/packages/package_registry/supported_functionality.md b/doc/user/packages/package_registry/supported_functionality.md index eb6b415ee06..ca054648d0d 100644 --- a/doc/user/packages/package_registry/supported_functionality.md +++ b/doc/user/packages/package_registry/supported_functionality.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Supported package functionality -The GitLab Package Registry supports different functionalities for each package type. This support includes publishing +The GitLab package registry supports different functionalities for each package type. This support includes publishing and pulling packages, request forwarding, managing duplicates, and authentication. ## Publishing packages **(FREE ALL)** @@ -133,7 +133,7 @@ By default, the GitLab package registry either allows or prevents duplicates bas ## Authentication tokens **(FREE ALL)** -GitLab tokens are used to authenticate with the GitLab Package Registry. +GitLab tokens are used to authenticate with the GitLab package registry. The following tokens are supported: @@ -181,7 +181,7 @@ The following authentication protocols are supported: Hash values are used to ensure you are using the correct package. You can view these values in the user interface or with the [API](../../../api/packages.md). -The Package Registry supports the following hash types: +The package registry supports the following hash types: | Package type | Supported hashes | |-------------------------------------------------------|----------------------------------| diff --git a/doc/user/packages/package_registry/supported_package_managers.md b/doc/user/packages/package_registry/supported_package_managers.md index 8d31399a36b..b1d8396c9d1 100644 --- a/doc/user/packages/package_registry/supported_package_managers.md +++ b/doc/user/packages/package_registry/supported_package_managers.md @@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: Not all package manager formats are ready for production use. -The Package Registry supports the following package manager types: +The package registry supports the following package manager types: | Package type | GitLab version | Status | | ------------------------------------------------ | -------------- | --------------------------------------------------------------- | @@ -27,4 +27,4 @@ The Package Registry supports the following package manager types: [View what each status means](../../../policy/experiment-beta-support.md). -You can also use the [API](../../../api/packages.md) to administer the Package Registry. +You can also use the [API](../../../api/packages.md) to administer the package registry. diff --git a/doc/user/packages/pypi_repository/index.md b/doc/user/packages/pypi_repository/index.md index c196e414461..d29f4803e8e 100644 --- a/doc/user/packages/pypi_repository/index.md +++ b/doc/user/packages/pypi_repository/index.md @@ -4,15 +4,15 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# PyPI packages in the Package Registry **(FREE ALL)** +# PyPI packages in the package registry **(FREE ALL)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208747) in GitLab 12.10. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/221259) from GitLab Premium to GitLab Free in 13.3. -Publish PyPI packages in your project's Package Registry. Then install the +Publish PyPI packages in your project's package registry. Then install the packages whenever you need to use them as a dependency. -The Package Registry works with: +The package registry works with: - [pip](https://pypi.org/project/pip/) - [twine](https://pypi.org/project/twine/) @@ -22,9 +22,9 @@ clients use, see the [PyPI API documentation](../../../api/packages/pypi.md). Learn how to [build a PyPI package](../workflows/build_packages.md#pypi). -## Authenticate with the Package Registry +## Authenticate with the package registry -Before you can publish to the Package Registry, you must authenticate. +Before you can publish to the package registry, you must authenticate. To do this, you can use: @@ -119,7 +119,7 @@ https://gitlab.example.com/api/v4/groups/<group_id>/-/packages/pypi Prerequisites: -- You must [authenticate with the Package Registry](#authenticate-with-the-package-registry). +- You must [authenticate with the package registry](#authenticate-with-the-package-registry). - Your [version string must be valid](#ensure-your-version-string-is-valid). - The maximum allowed package size is 5 GB. - You can't upload the same version of a package multiple times. If you try, @@ -202,7 +202,7 @@ more than once, a `400 Bad Request` error occurs. ## Install a PyPI package In [GitLab 14.2 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/233413), -when a PyPI package is not found in the Package Registry, the request is forwarded to [pypi.org](https://pypi.org/). +when a PyPI package is not found in the package registry, the request is forwarded to [pypi.org](https://pypi.org/). Administrators can disable this behavior in the [Continuous Integration settings](../../admin_area/settings/continuous_integration.md). diff --git a/doc/user/packages/rubygems_registry/index.md b/doc/user/packages/rubygems_registry/index.md index 361114e6f9e..e193130f8bc 100644 --- a/doc/user/packages/rubygems_registry/index.md +++ b/doc/user/packages/rubygems_registry/index.md @@ -4,7 +4,7 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Ruby gems in the Package Registry **(FREE ALL EXPERIMENT)** +# Ruby gems in the package registry **(FREE ALL EXPERIMENT)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/803) in GitLab 13.10. @@ -13,9 +13,9 @@ The Ruby gems package registry for GitLab is under development and isn't ready f limited functionality. This [epic](https://gitlab.com/groups/gitlab-org/-/epics/3200) details the remaining work and timelines to make it production ready. -You can publish Ruby gems in your project's Package Registry, then install the packages when you +You can publish Ruby gems in your project's package registry, then install the packages when you need to use them as a dependency. Although you can push gems to the registry, you cannot install -them from the registry. However, you can download `gem` files directly from the Package Registry's +them from the registry. However, you can download `gem` files directly from the package registry's UI, or by using the [API](../../../api/packages/rubygems.md#download-a-gem-file). For documentation of the specific API endpoints that the Ruby gems and Bundler package manager @@ -49,9 +49,9 @@ Feature.disable(:rubygem_packages, Project.find(2)) If you need help creating a Ruby gem, see the [RubyGems documentation](https://guides.rubygems.org/make-your-own-gem/). -## Authenticate to the Package Registry +## Authenticate to the package registry -Before you can push to the Package Registry, you must authenticate. +Before you can push to the package registry, you must authenticate. To do this, you can use: @@ -108,7 +108,7 @@ https://gitlab.example.com/api/v4/projects/${env.CI_PROJECT_ID}/packages/rubygem Prerequisites: -- You must [authenticate to the Package Registry](#authenticate-to-the-package-registry). +- You must [authenticate to the package registry](#authenticate-to-the-package-registry). - The maximum allowed gem size is 3 GB. To push your gem, run a command like this one: diff --git a/doc/user/packages/workflows/build_packages.md b/doc/user/packages/workflows/build_packages.md index a0757e968bc..fa72520dff2 100644 --- a/doc/user/packages/workflows/build_packages.md +++ b/doc/user/packages/workflows/build_packages.md @@ -92,7 +92,7 @@ The CMake version is printed in the output. ### Create a project -To test the Package Registry, you need a C++ project. If you don't already have +To test the package registry, you need a C++ project. If you don't already have one, you can clone the Conan [hello world starter project](https://github.com/conan-io/hello). ### Build a Conan package @@ -505,4 +505,4 @@ The output should appear similar to the following: mypypipackage-0.0.1-py3-none-any.whl mypypipackage-0.0.1.tar.gz ``` -The package is now ready to be published to the Package Registry. +The package is now ready to be published to the package registry. diff --git a/doc/user/packages/workflows/project_registry.md b/doc/user/packages/workflows/project_registry.md index 4db77348bd4..bb91ca7c483 100644 --- a/doc/user/packages/workflows/project_registry.md +++ b/doc/user/packages/workflows/project_registry.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Store all of your packages in one GitLab project **(FREE ALL)** -You can store all of your packages in one project's Package Registry. Rather than using +You can store all of your packages in one project's package registry. Rather than using a GitLab repository to store code, you can use the repository to store all your packages. Then you can configure your remote repositories to point to the project in GitLab. @@ -36,7 +36,7 @@ Let's take a look at how you might create one project to host all of your packag 1. Create a new project in GitLab. The project doesn't require any code or content. 1. On the left sidebar, select **Project overview**, and note the project ID. -1. Create an access token for authentication. All package types in the Package Registry can be published by using: +1. Create an access token for authentication. All package types in the package registry can be published by using: - A [personal access token](../../profile/personal_access_tokens.md). - A [CI/CD job token](../../../ci/jobs/ci_job_token.md) (`CI_JOB_TOKEN`) in a CI/CD job. @@ -56,7 +56,7 @@ If you're using npm, create an `.npmrc` file. Add the appropriate URL for publis packages to your project. Finally, add a section to your `package.json` file. Follow the instructions in the -[GitLab Package Registry npm documentation](../npm_registry/index.md#authentication-to-the-package-registry). After +[GitLab package registry npm documentation](../npm_registry/index.md#authentication-to-the-package-registry). After you do this, you can publish your npm package to your project using `npm publish`, as described in the [publishing packages](../npm_registry/index.md#publish-to-gitlab-package-registry) section. diff --git a/doc/user/packages/yarn_repository/index.md b/doc/user/packages/yarn_repository/index.md index 942e62ae3e7..d10768552b2 100644 --- a/doc/user/packages/yarn_repository/index.md +++ b/doc/user/packages/yarn_repository/index.md @@ -17,11 +17,11 @@ You can use the Yarn documentation to get started with [Yarn Classic](https://classic.yarnpkg.com/en/docs/getting-started) and [Yarn 2+](https://yarnpkg.com/getting-started/). -## Publish to GitLab Package Registry +## Publish to GitLab package registry -You can use Yarn to publish to the GitLab Package Registry. +You can use Yarn to publish to the GitLab package registry. -### Authentication to the Package Registry +### Authentication to the package registry You need a token to publish a package. Different tokens are available depending on what you're trying to achieve. For more information, review the [guidance on tokens](../../../user/packages/package_registry/index.md#authenticate-with-the-registry). @@ -54,7 +54,7 @@ In this configuration: Scoped registry does not work in Yarn Classic in `package.json` file, based on this [issue](https://github.com/yarnpkg/yarn/pull/7829). Therefore, under `publishConfig` there should be `registry` and not `@scope:registry` for Yarn Classic. -You can publish using your command line or a CI/CD pipeline to the GitLab Package Registry. +You can publish using your command line or a CI/CD pipeline to the GitLab package registry. ### Publishing via the command line - Manual Publish @@ -66,7 +66,7 @@ yarn publish yarn npm publish ``` -Your package should now publish to the Package Registry. +Your package should now publish to the package registry. ### Publishing via a CI/CD pipeline - Automated Publish @@ -163,7 +163,7 @@ deploy: - yarn npm publish ``` -Your package should now publish to the Package Registry when the pipeline runs. +Your package should now publish to the package registry when the pipeline runs. ## Install a package @@ -191,7 +191,7 @@ You can use one of two API endpoints to install packages: If you plan to install a package through the [project level](#install-from-the-project-level), you do not have to adhere to the naming convention. -| Project URL | Package Registry | Organization Scope | Full package name | +| Project URL | Package registry | Organization Scope | Full package name | |-------------------------------------------------------------------|----------------------|--------------------|-----------------------------| | `https://gitlab.com/<my-org>/<group-name>/<package-name-example>` | Package Name Example | `@my-org` | `@my-org/package-name` | | `https://gitlab.com/<example-org>/<group-name>/<project-name>` | Project Name | `@example-org` | `@example-org/project-name` | @@ -301,7 +301,7 @@ Then you can use `yarn add` to install your packages. ## Troubleshooting -### Error running Yarn with the Package Registry for the npm registry +### Error running Yarn with the package registry for the npm registry If you are using [Yarn](https://classic.yarnpkg.com/en/) with the npm registry, you may get an error message like: diff --git a/doc/user/project/deploy_tokens/index.md b/doc/user/project/deploy_tokens/index.md index 351762228fb..8459ffdde86 100644 --- a/doc/user/project/deploy_tokens/index.md +++ b/doc/user/project/deploy_tokens/index.md @@ -25,7 +25,7 @@ A deploy token is a pair of values: You can use a deploy token for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) to the following endpoints: -- GitLab Package Registry public API. +- GitLab package registry public API. - [Git commands](https://git-scm.com/docs/gitcredentials#_description). You can create deploy tokens at either the project or group level: @@ -37,7 +37,7 @@ By default, a deploy token does not expire. You can optionally set an expiry dat it. Expiry occurs at midnight UTC on that date. WARNING: -You cannot use new or existing deploy tokens for Git operations and Package Registry operations if +You cannot use new or existing deploy tokens for Git operations and package registry operations if [external authorization](../../admin_area/settings/external_authorization.md) is enabled. ## Scope @@ -79,7 +79,7 @@ name and token of the group deploy token. ### GitLab public API Deploy tokens can't be used with the GitLab public API. However, you can use deploy tokens with some -endpoints, such as those from the Package Registry. For more information, see +endpoints, such as those from the package registry. For more information, see [Authenticate with the registry](../../packages/package_registry/index.md#authenticate-with-the-registry). ## Create a deploy token diff --git a/doc/user/project/merge_requests/reviews/img/multi-line-suggestion-preview.png b/doc/user/project/merge_requests/reviews/img/multi-line-suggestion-preview.png Binary files differdeleted file mode 100644 index 476c50b9098..00000000000 --- a/doc/user/project/merge_requests/reviews/img/multi-line-suggestion-preview.png +++ /dev/null diff --git a/doc/user/project/merge_requests/reviews/img/multi-line-suggestion-preview_v16_6.png b/doc/user/project/merge_requests/reviews/img/multi-line-suggestion-preview_v16_6.png Binary files differnew file mode 100644 index 00000000000..f35a2c5e8a1 --- /dev/null +++ b/doc/user/project/merge_requests/reviews/img/multi-line-suggestion-preview_v16_6.png diff --git a/doc/user/project/merge_requests/reviews/img/suggestion_code_block_output_v12_8.png b/doc/user/project/merge_requests/reviews/img/suggestion_code_block_output_v16_6.png Binary files differindex 6f29107146d..6f29107146d 100644 --- a/doc/user/project/merge_requests/reviews/img/suggestion_code_block_output_v12_8.png +++ b/doc/user/project/merge_requests/reviews/img/suggestion_code_block_output_v16_6.png diff --git a/doc/user/project/merge_requests/reviews/suggestions.md b/doc/user/project/merge_requests/reviews/suggestions.md index 90a276dc303..bc41c9672c2 100644 --- a/doc/user/project/merge_requests/reviews/suggestions.md +++ b/doc/user/project/merge_requests/reviews/suggestions.md @@ -18,9 +18,8 @@ merge request, authored by the user who suggested the changes. 1. Select **Code > Merge requests** and find your merge request. 1. On the secondary menu, select **Changes**. 1. Find the lines of code you want to change. - - To select a single line: - - Hover over the line number, and - select **Add a comment to this line** (**{comment}**). + - To select a single line, hover over the line number and + select **Add a comment to this line** (**{comment}**). - To select multiple lines: 1. Hover over the line number, and select **Add a comment to this line** (**{comment}**). 1. Select and drag your selection until all desired lines are included. To @@ -35,8 +34,11 @@ merge request, authored by the user who suggested the changes. ```` 1. Edit the pre-populated code block to add your suggestion. -1. Select either **Start a review** or **Add to review** to add your comment to a - [review](index.md), or **Add comment now** to add the comment to the thread immediately. +1. Select whether you want your comment to appear immediately: + + - **Start a review** or **Add to review** creates your comment in a pending state + as part of a [review](index.md). + - **Add comment now** adds your comment immediately. ### Multi-line suggestions @@ -45,23 +47,24 @@ in a single suggestion, by either: - Selecting and dragging, as described in [Create suggestions](#create-suggestions). GitLab creates a suggestion block for you. -- Selecting a single line, then manually adjusting the range offsets. +- Selecting a single line, then manually editing the range offsets in the suggestion block. The range offsets in the first line of the suggestion describe line numbers relative to the line you selected. The offsets specify the lines your suggestion intends to replace. -For example, this suggestion covers 3 lines above and 4 lines below the +For example, this suggestion covers 2 lines above and 2 lines below the commented line: ````markdown -```suggestion:-3+4 - "--talk-name=ca.desrt.dconf", - "--socket=wayland", +```suggestion:-2+2 +## Prevent approval by author + +By default, the author of a merge request cannot approve it. To change this setting: ``` ```` -When applied, the suggestion replaces from 3 lines above to 4 lines below the commented line: +When applied, the suggestion replaces from 2 lines above to 2 lines below the commented line: -![Multi-line suggestion preview](img/multi-line-suggestion-preview.png) +![Multi-line suggestion preview](img/multi-line-suggestion-preview_v16_6.png) Suggestions for multiple lines are limited to 100 lines _above_ and 100 lines _below_ the commented diff line. This allows for up to 200 changed lines per @@ -74,7 +77,7 @@ suggestion. > - Feature flag `content_editor_on_issues` removed in GitLab 16.5. When you insert suggestions, you can use the WYSIWYG -[rich text editor](https://about.gitlab.com/direction/plan/knowledge/content_editor/) to move +[rich text editor](../../../rich_text_editor.md) to move up and down the source file's line numbers in the UI. To add or subtract changed lines, next to **From line**, select **+** or **-**. @@ -119,7 +122,7 @@ git config --global receive.advertisepushoptions true ```` ````` -![Output of a comment with a suggestion with a fenced code block](img/suggestion_code_block_output_v12_8.png) +![Output of a comment with a suggestion with a fenced code block](img/suggestion_code_block_output_v16_6.png) ## Configure the commit message for applied suggestions @@ -133,9 +136,14 @@ Apply 3 suggestion(s) to 2 file(s) ``` Merge requests created from forks use the template defined in the target project. +To meet your project's needs, customize these messages and include other +placeholder variables. + +Prerequisites: -To meet your project's needs, you can customize these messages and include other -placeholder variables: +- You must have the Maintainer role. + +To do this: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Settings > Merge requests**. @@ -166,12 +174,16 @@ For example, to customize the commit message to output > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/326168) custom commit messages for batch suggestions in GitLab 14.4. -To reduce the number of commits added to your branch, you can apply multiple +Prerequisites: + +- You must have a role in the project that allows you to commit to the source branch. + +To reduce the number of commits added to your branch, apply multiple suggestions in a single commit. 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Code > Merge requests** and find your merge request. -1. For each suggestion you want to apply, and select **Add suggestion to batch**. +1. For each suggestion you want to apply, select **Add suggestion to batch**. 1. Optional. To remove a suggestion, select **Remove from batch**. 1. After you add your desired suggestions, select **Apply suggestions**. diff --git a/doc/user/project/releases/release_cli.md b/doc/user/project/releases/release_cli.md index 9daa6705ad8..c97b438b784 100644 --- a/doc/user/project/releases/release_cli.md +++ b/doc/user/project/releases/release_cli.md @@ -29,7 +29,7 @@ release-cli create --name "Release $CI_COMMIT_SHA" --description \ ## Install the `release-cli` for the Shell executor **(FREE ALL)** > - [Introduced](https://gitlab.com/gitlab-org/release-cli/-/issues/21) in GitLab 13.8. -> - [Changed](https://gitlab.com/gitlab-org/release-cli/-/merge_requests/108) in GitLab 14.2, the `release-cli` binaries are also [available in the Package Registry](https://gitlab.com/gitlab-org/release-cli/-/packages). +> - [Changed](https://gitlab.com/gitlab-org/release-cli/-/merge_requests/108) in GitLab 14.2, the `release-cli` binaries are also [available in the package registry](https://gitlab.com/gitlab-org/release-cli/-/packages). When you use a runner with the Shell executor, you can download and install the `release-cli` manually for your [supported OS and architecture](https://release-cli-downloads.s3.amazonaws.com/latest/index.html). @@ -37,7 +37,7 @@ Once installed, [the `release` keyword](../../../ci/yaml/index.md#release) is av ### Install on Unix/Linux -1. Download the binary for your system from the GitLab Package Registry. +1. Download the binary for your system from the GitLab package registry. For example, if you use an amd64 system: ```shell diff --git a/doc/user/project/releases/release_fields.md b/doc/user/project/releases/release_fields.md index d26ca87e384..3beff5eccb1 100644 --- a/doc/user/project/releases/release_fields.md +++ b/doc/user/project/releases/release_fields.md @@ -182,7 +182,7 @@ to store any artifacts from a release or tag pipeline, that can also be used for attaching binary files to an individual release entry. You basically need to: -1. [Push the artifacts to the Generic Package Registry](../../packages/generic_packages/index.md#publish-a-package-file). +1. [Push the artifacts to the Generic package registry](../../packages/generic_packages/index.md#publish-a-package-file). 1. [Attach the package link to the release](#links). The following example generates release assets, publishes them diff --git a/doc/user/project/settings/project_access_tokens.md b/doc/user/project/settings/project_access_tokens.md index d09eb69a4c1..2be22eaacc3 100644 --- a/doc/user/project/settings/project_access_tokens.md +++ b/doc/user/project/settings/project_access_tokens.md @@ -89,8 +89,8 @@ See the warning in [create a project access token](#create-a-project-access-toke | Scope | Description | |:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `api` | Grants complete read and write access to the scoped project API, including the [Package Registry](../../packages/package_registry/index.md). | -| `read_api` | Grants read access to the scoped project API, including the [Package Registry](../../packages/package_registry/index.md). | +| `api` | Grants complete read and write access to the scoped project API, including the [package registry](../../packages/package_registry/index.md). | +| `read_api` | Grants read access to the scoped project API, including the [package registry](../../packages/package_registry/index.md). | | `read_registry` | Grants read access (pull) to the [container registry](../../packages/container_registry/index.md) images if a project is private and authorization is required. | | `write_registry` | Grants write access (push) to the [container registry](../../packages/container_registry/index.md). | | `read_repository` | Grants read access (pull) to the repository. | diff --git a/doc/user/read_only_namespaces.md b/doc/user/read_only_namespaces.md index d5697ec5a94..e84b3194d4b 100644 --- a/doc/user/read_only_namespaces.md +++ b/doc/user/read_only_namespaces.md @@ -35,7 +35,7 @@ To restore a namespace to its standard state, you can: |---------|-------------------| | Container Registry | Create, edit, and delete cleanup policies <br> Push an image to the container registry | | Merge Requests | Create and update an MR | -| Package Registry | Publish a package | +| Package registry | Publish a package | | Repositories | Add tags <br> Create new branches <br> Create and update commit status <br> Push and force push to non-protected branches <br> Push and force push to protected branches <br> Upload files <br> Create merge requests | | CI/CD | Create, edit, admin, and run pipelines <br> Create, edit, admin, and run builds <br> Create and edit admin environments <br> Create and edit admin deployments <br> Create and edit admin clusters <br> Create and edit admin releases | | Namespaces | **For exceeded free user limits:** Invite new users | diff --git a/doc/user/storage_management_automation.md b/doc/user/storage_management_automation.md index 5a0c841eeda..f5d49577719 100644 --- a/doc/user/storage_management_automation.md +++ b/doc/user/storage_management_automation.md @@ -892,7 +892,7 @@ echo '{"container_expiration_policy_attributes":{"cadence":"1month","enabled":tr You can optimize container images to reduce the image size and overall storage consumption in the container registry. Learn more in the [pipeline efficiency documentation](../ci/pipelines/pipeline_efficiency.md#optimize-docker-images). -## Manage Package Registry storage +## Manage package registry storage Package registries are available [for projects](../api/packages.md#for-a-project) or [for groups](../api/packages.md#for-a-group). |