From dfad8b55a7118fd437268519d98e1245d79b15a8 Mon Sep 17 00:00:00 2001 From: Phillip Wells <pwells@gitlab.com> Date: Tue, 14 Nov 2023 19:19:14 +0000 Subject: [PATCH] Sentence-case package registry in docs --- .../geo/replication/datatypes.md | 2 +- .../geo/replication/troubleshooting.md | 2 +- doc/administration/instance_limits.md | 14 ++-- doc/administration/maintenance_mode/index.md | 4 +- doc/administration/packages/index.md | 12 ++-- .../settings/continuous_integration.md | 2 +- .../settings/package_registry_rate_limits.md | 4 +- doc/administration/settings/rate_limits.md | 2 +- doc/api/packages/composer.md | 2 +- doc/api/packages/npm.md | 2 +- doc/api/packages/nuget.md | 2 +- doc/api/packages/pypi.md | 2 +- doc/api/settings.md | 2 +- doc/ci/examples/index.md | 2 +- doc/ci/examples/semantic-release.md | 8 +-- doc/ci/jobs/ci_job_token.md | 2 +- doc/ci/yaml/signing_examples.md | 2 +- .../fe_guide/registry_architecture.md | 4 +- .../packages/new_format_development.md | 2 +- doc/development/packages/settings.md | 2 +- doc/development/packages/structure.md | 2 +- doc/update/index.md | 2 +- doc/user/gitlab_com/index.md | 2 +- doc/user/group/import/index.md | 2 +- .../group/settings/group_access_tokens.md | 4 +- .../packages/composer_repository/index.md | 16 ++--- doc/user/packages/conan_repository/index.md | 48 +++++++------- doc/user/packages/debian_repository/index.md | 4 +- doc/user/packages/generic_packages/index.md | 6 +- doc/user/packages/go_proxy/index.md | 2 +- doc/user/packages/helm_repository/index.md | 6 +- doc/user/packages/index.md | 2 +- doc/user/packages/maven_repository/index.md | 24 +++---- doc/user/packages/npm_registry/index.md | 32 ++++----- doc/user/packages/nuget_repository/index.md | 66 +++++++++---------- doc/user/packages/package_registry/index.md | 40 +++++------ .../reduce_package_registry_storage.md | 6 +- .../supported_functionality.md | 6 +- .../supported_package_managers.md | 4 +- doc/user/packages/pypi_repository/index.md | 14 ++-- doc/user/packages/rubygems_registry/index.md | 12 ++-- doc/user/packages/workflows/build_packages.md | 4 +- .../packages/workflows/project_registry.md | 6 +- doc/user/packages/yarn_repository/index.md | 16 ++--- doc/user/project/deploy_tokens/index.md | 6 +- doc/user/project/releases/release_cli.md | 4 +- doc/user/project/releases/release_fields.md | 2 +- .../project/settings/project_access_tokens.md | 4 +- doc/user/read_only_namespaces.md | 2 +- doc/user/storage_management_automation.md | 2 +- 50 files changed, 210 insertions(+), 210 deletions(-) diff --git a/doc/administration/geo/replication/datatypes.md b/doc/administration/geo/replication/datatypes.md index 80ad1e5eb1f7..9d991a333ffe 100644 --- a/doc/administration/geo/replication/datatypes.md +++ b/doc/administration/geo/replication/datatypes.md @@ -203,7 +203,7 @@ successfully, you must replicate their data using some other means. |[Container registry](../../packages/container_registry.md) | **Yes** (12.3)<sup>1</sup> | **Yes** (15.10) | **Yes** (12.3)<sup>1</sup> | **Yes** (15.10) | See [instructions](container_registry.md) to set up the container registry replication. | |[Terraform Module Registry](../../../user/packages/terraform_module_registry/index.md) | **Yes** (14.0) | **Yes** (14.0) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [**Yes** (16.4)](object_storage.md) | Behind feature flag `geo_package_file_replication`, enabled by default. | |[Project designs repository](../../../user/project/issues/design_management.md) | **Yes** (12.7) | **Yes** (16.1) | Not applicable | Not applicable | Designs also require replication of LFS objects and Uploads. | -|[Package Registry](../../../user/packages/package_registry/index.md) | **Yes** (13.2) | **Yes** (13.10) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [**Yes** (16.4)](object_storage.md) | Behind feature flag `geo_package_file_replication`, enabled by default. | +|[Package registry](../../../user/packages/package_registry/index.md) | **Yes** (13.2) | **Yes** (13.10) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [**Yes** (16.4)](object_storage.md) | Behind feature flag `geo_package_file_replication`, enabled by default. | |[Versioned Terraform State](../../terraform_state.md) | **Yes** (13.5) | **Yes** (13.12) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [**Yes** (16.4)](object_storage.md) | Replication is behind the feature flag `geo_terraform_state_version_replication`, enabled by default. Verification was behind the feature flag `geo_terraform_state_version_verification`, which was removed in 14.0. | |[External merge request diffs](../../merge_request_diffs.md) | **Yes** (13.5) | **Yes** (14.6) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [**Yes** (16.4)](object_storage.md) | Replication is behind the feature flag `geo_merge_request_diff_replication`, enabled by default. Verification was behind the feature flag `geo_merge_request_diff_verification`, removed in 14.7.| |[Versioned snippets](../../../user/snippets.md#versioned-snippets) | [**Yes** (13.7)](https://gitlab.com/groups/gitlab-org/-/epics/2809) | [**Yes** (14.2)](https://gitlab.com/groups/gitlab-org/-/epics/2810) | Not applicable | Not applicable | Verification was implemented behind the feature flag `geo_snippet_repository_verification` in 13.11, and the feature flag was removed in 14.2. | diff --git a/doc/administration/geo/replication/troubleshooting.md b/doc/administration/geo/replication/troubleshooting.md index dd021695800d..a2bf8090f67e 100644 --- a/doc/administration/geo/replication/troubleshooting.md +++ b/doc/administration/geo/replication/troubleshooting.md @@ -839,7 +839,7 @@ This behavior affects only the following data types through GitLab 14.6: | Data type | From version | | ------------------------ | ------------ | -| Package Registry | 13.10 | +| Package registry | 13.10 | | CI Pipeline Artifacts | 13.11 | | Terraform State Versions | 13.12 | | Infrastructure Registry (renamed to Terraform Module Registry in GitLab 15.11) | 14.0 | diff --git a/doc/administration/instance_limits.md b/doc/administration/instance_limits.md index eb35ff10f2a2..402ecfeec7bd 100644 --- a/doc/administration/instance_limits.md +++ b/doc/administration/instance_limits.md @@ -21,7 +21,7 @@ Depending on which limits you have configured, you can see: - SSH host keys information - CI/CD limits - GitLab Pages limits -- Package Registry limits +- Package registry limits - Rate limits - Size limits @@ -88,10 +88,10 @@ Read more about [protected path rate limits](settings/protected_paths.md). - **Default rate limit**: After 10 requests, the client must wait 60 seconds before trying again. -### Package Registry +### Package registry This setting limits the request rate on the Packages API per user or IP. For more information, see -[Package Registry Rate Limits](settings/package_registry_rate_limits.md). +[package registry rate limits](settings/package_registry_rate_limits.md). - **Default rate limit**: Disabled by default. @@ -1052,11 +1052,11 @@ individual push events or a bulk push event are created. More information can be found in the [Push event activities limit and bulk push events documentation](settings/push_event_activities_limit.md). -## Package Registry Limits +## Package registry limits -### File Size Limits +### File size limits -The default maximum file size for a package that's uploaded to the [GitLab Package Registry](../user/packages/package_registry/index.md) varies by format: +The default maximum file size for a package that's uploaded to the [GitLab package registry](../user/packages/package_registry/index.md) varies by format: - Conan: 3 GB - Generic: 5 GB @@ -1105,7 +1105,7 @@ Set the limit to `0` to allow any file size. ### Package versions returned -When asking for versions of a given NuGet package name, the GitLab Package Registry returns a maximum of 300 versions. +When asking for versions of a given NuGet package name, the GitLab package registry returns a maximum of 300 versions. ## Dependency Proxy Limits diff --git a/doc/administration/maintenance_mode/index.md b/doc/administration/maintenance_mode/index.md index 5c13a124957f..f915d1a89038 100644 --- a/doc/administration/maintenance_mode/index.md +++ b/doc/administration/maintenance_mode/index.md @@ -166,9 +166,9 @@ Terraform integration depends on running CI pipelines, hence it is blocked. `docker push` fails with this error: `denied: requested access to the resource is denied`, but `docker pull` works. -### Package Registry +### Package registry -Package Registry allows you to install but not publish packages. +Package registry allows you to install but not publish packages. ### Background jobs diff --git a/doc/administration/packages/index.md b/doc/administration/packages/index.md index 2eb3da4b5d71..42b2dfc0420f 100644 --- a/doc/administration/packages/index.md +++ b/doc/administration/packages/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 --- -# GitLab Package Registry administration **(FREE SELF)** +# GitLab package registry administration **(FREE SELF)** -To use GitLab as a private repository for a variety of common package managers, use the Package Registry. +To use GitLab as a private repository for a variety of common package managers, use the package registry. You can build and publish packages, which can be consumed as dependencies in downstream projects. ## Supported formats -The Package Registry supports the following formats: +The package registry supports the following formats: | Package type | GitLab version | |-------------------------------------------------------------------|----------------| @@ -55,11 +55,11 @@ guides you through the process. When downloading packages as dependencies in downstream projects, many requests are made through the Packages API. You may therefore reach enforced user and IP rate limits. To address this issue, you -can define specific rate limits for the Packages API. For more details, see [Package Registry Rate Limits](../settings/package_registry_rate_limits.md). +can define specific rate limits for the Packages API. For more details, see [package registry rate limits](../settings/package_registry_rate_limits.md). -## Enable or disable the Package Registry +## Enable or disable the package registry -The Package Registry is enabled by default. To disable it: +The package registry is enabled by default. To disable it: ::Tabs diff --git a/doc/administration/settings/continuous_integration.md b/doc/administration/settings/continuous_integration.md index 0e2a512302d8..ce41950301e0 100644 --- a/doc/administration/settings/continuous_integration.md +++ b/doc/administration/settings/continuous_integration.md @@ -320,7 +320,7 @@ To select a CI/CD template for the required pipeline configuration: 1. Select a CI/CD template from the dropdown list. 1. Select **Save changes**. -## Package Registry configuration +## Package registry configuration ### Maven Forwarding **(PREMIUM SELF)** diff --git a/doc/administration/settings/package_registry_rate_limits.md b/doc/administration/settings/package_registry_rate_limits.md index 2ddb6bfcd170..0c098bb17497 100644 --- a/doc/administration/settings/package_registry_rate_limits.md +++ b/doc/administration/settings/package_registry_rate_limits.md @@ -5,9 +5,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: reference --- -# Package Registry Rate Limits **(FREE SELF)** +# Package registry rate limits **(FREE SELF)** -With the [GitLab Package Registry](../../user/packages/package_registry/index.md), +With the [GitLab package registry](../../user/packages/package_registry/index.md), you can use GitLab as a private or public registry for a variety of common package managers. You can publish and share packages, which others can consume as a dependency in downstream projects through the [Packages API](../../api/packages.md). diff --git a/doc/administration/settings/rate_limits.md b/doc/administration/settings/rate_limits.md index 2263455fa093..b6efb1e302f1 100644 --- a/doc/administration/settings/rate_limits.md +++ b/doc/administration/settings/rate_limits.md @@ -15,7 +15,7 @@ You can change network settings to limit the rate of connections with your insta - [Incident management](incident_management_rate_limits.md) - [Issue creation](rate_limit_on_issues_creation.md) - [Note creation](rate_limit_on_notes_creation.md) -- [Package Registry](package_registry_rate_limits.md) +- [Package registry](package_registry_rate_limits.md) - [Pipeline creation](rate_limit_on_pipelines_creation.md) - [Projects API](rate_limit_on_projects_api.md) - [Raw endpoints](rate_limits_on_raw_endpoints.md) diff --git a/doc/api/packages/composer.md b/doc/api/packages/composer.md index ae986b082d62..c14fb76b383d 100644 --- a/doc/api/packages/composer.md +++ b/doc/api/packages/composer.md @@ -17,7 +17,7 @@ package registry, see the [Composer package registry documentation](../../user/p NOTE: These endpoints do not adhere to the standard API authentication methods. -See the [Composer package registry documentation](../../user/packages/composer_repository/index.md) +See the [Composer Package Registry documentation](../../user/packages/composer_repository/index.md) for details on which headers and token types are supported. Undocumented authentication methods might be removed in the future. ## Base repository request diff --git a/doc/api/packages/npm.md b/doc/api/packages/npm.md index 0bfc39ab92b5..45bbc2215482 100644 --- a/doc/api/packages/npm.md +++ b/doc/api/packages/npm.md @@ -13,7 +13,7 @@ This API is used by the [npm package manager client](https://docs.npmjs.com/) and is not meant for manual consumption. For instructions on how to upload and install npm packages from the GitLab -package registry, see the [npm package registry documentation](../../user/packages/npm_registry/index.md). +Package Registry, see the [npm package registry documentation](../../user/packages/npm_registry/index.md). NOTE: These endpoints do not adhere to the standard API authentication methods. diff --git a/doc/api/packages/nuget.md b/doc/api/packages/nuget.md index 794c14fb5bce..1670587c10be 100644 --- a/doc/api/packages/nuget.md +++ b/doc/api/packages/nuget.md @@ -13,7 +13,7 @@ This API is used by the [NuGet package manager client](https://www.nuget.org/) and is generally not meant for manual consumption. For instructions on how to upload and install NuGet packages from the GitLab -package registry, see the [NuGet package registry documentation](../../user/packages/nuget_repository/index.md). +Package Registry, see the [NuGet package registry documentation](../../user/packages/nuget_repository/index.md). NOTE: These endpoints do not adhere to the standard API authentication methods. diff --git a/doc/api/packages/pypi.md b/doc/api/packages/pypi.md index f13665f16c95..df8e073a90cb 100644 --- a/doc/api/packages/pypi.md +++ b/doc/api/packages/pypi.md @@ -13,7 +13,7 @@ This API is used by the [PyPI package manager client](https://pypi.org/) and is generally not meant for manual consumption. For instructions on how to upload and install PyPI packages from the GitLab -package registry, see the [PyPI package registry documentation](../../user/packages/pypi_repository/index.md). +Package Registry, see the [PyPI package registry documentation](../../user/packages/pypi_repository/index.md). NOTE: These endpoints do not adhere to the standard API authentication methods. diff --git a/doc/api/settings.md b/doc/api/settings.md index 9c0a1e8e4a8f..8645191f1500 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -651,7 +651,7 @@ to be set, or _all_ of these values to be set: ::EndTabs -### Package Registry: Package file size limits +### Package registry: Package file size limits The package file size limits are not part of the Application settings API. Instead, these settings can be accessed using the [Plan limits API](plan_limits.md). diff --git a/doc/ci/examples/index.md b/doc/ci/examples/index.md index aa3be8f2ab09..ea3cb9fa1f73 100644 --- a/doc/ci/examples/index.md +++ b/doc/ci/examples/index.md @@ -27,7 +27,7 @@ The following table lists examples with step-by-step tutorials that are containe | GitLab Pages | See the [GitLab Pages](../../user/project/pages/index.md) documentation for a complete example of deploying a static site. | | End-to-end testing | [End-to-end testing with GitLab CI/CD and WebdriverIO](end_to_end_testing_webdriverio/index.md). | | Multi project pipeline | [Build, test deploy using multi project pipeline](https://gitlab.com/gitlab-examples/upstream-project). | -| npm with semantic-release | [Publish npm packages to the GitLab Package Registry using semantic-release](semantic-release.md). | +| npm with semantic-release | [Publish npm packages to the GitLab package registry using semantic-release](semantic-release.md). | | PHP with Laravel, Envoy | [Test and deploy Laravel applications with GitLab CI/CD and Envoy](laravel_with_gitlab_and_envoy/index.md). | | PHP with npm, SCP | [Running Composer and npm scripts with deployment via SCP in GitLab CI/CD](deployment/composer-npm-deploy.md). | | PHP with PHPUnit, `atoum` | [Testing PHP projects](php.md). | diff --git a/doc/ci/examples/semantic-release.md b/doc/ci/examples/semantic-release.md index 356a3d1d63e2..9c0c6a5e45a9 100644 --- a/doc/ci/examples/semantic-release.md +++ b/doc/ci/examples/semantic-release.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 --- -# Publish npm packages to the GitLab Package Registry using semantic-release **(FREE ALL)** +# Publish npm packages to the GitLab package registry using semantic-release **(FREE ALL)** -This guide demonstrates how to automatically publish npm packages to the [GitLab Package Registry](../../user/packages/npm_registry/index.md) by using [semantic-release](https://github.com/semantic-release/semantic-release). +This guide demonstrates how to automatically publish npm packages to the [GitLab package registry](../../user/packages/npm_registry/index.md) by using [semantic-release](https://github.com/semantic-release/semantic-release). You can also view or fork the complete [example source](https://gitlab.com/gitlab-examples/semantic-release-npm). ## Initialize the module 1. Open a terminal and navigate to the project's repository. -1. Run `npm init`. Name the module according to [the Package Registry's naming conventions](../../user/packages/npm_registry/index.md#naming-convention). For example, if the project's path is `gitlab-examples/semantic-release-npm`, name the module `@gitlab-examples/semantic-release-npm`. +1. Run `npm init`. Name the module according to [the package registry's naming conventions](../../user/packages/npm_registry/index.md#naming-convention). For example, if the project's path is `gitlab-examples/semantic-release-npm`, name the module `@gitlab-examples/semantic-release-npm`. 1. Install the following npm packages: @@ -82,7 +82,7 @@ publish: This example configures the pipeline with a single job, `publish`, which runs `semantic-release`. The semantic-release library publishes new versions of the npm package and creates new GitLab releases (if necessary). -The default `before_script` generates a temporary `.npmrc` that is used to authenticate to the Package Registry during the `publish` job. +The default `before_script` generates a temporary `.npmrc` that is used to authenticate to the package registry during the `publish` job. ## Set up CI/CD variables diff --git a/doc/ci/jobs/ci_job_token.md b/doc/ci/jobs/ci_job_token.md index 00d4fd5bff56..3e632f0a94c1 100644 --- a/doc/ci/jobs/ci_job_token.md +++ b/doc/ci/jobs/ci_job_token.md @@ -12,7 +12,7 @@ When a pipeline job is about to run, GitLab generates a unique token and injects You can use a GitLab CI/CD job token to authenticate with specific API endpoints: - Packages: - - [Package Registry](../../user/packages/package_registry/index.md#to-build-packages). + - [Package registry](../../user/packages/package_registry/index.md#to-build-packages). - [Packages API](../../api/packages.md) (project-level). - [Container registry](../../user/packages/container_registry/build_and_push_images.md#use-gitlab-cicd) (the `$CI_REGISTRY_PASSWORD` is `$CI_JOB_TOKEN`). diff --git a/doc/ci/yaml/signing_examples.md b/doc/ci/yaml/signing_examples.md index b808edebe7aa..a89bf7c81f62 100644 --- a/doc/ci/yaml/signing_examples.md +++ b/doc/ci/yaml/signing_examples.md @@ -142,7 +142,7 @@ You can use Sigstore and npm, together with GitLab CI/CD, to digitally sign buil CLI provenance generation allows users to trust and verify that the package they are downloading and using is from you and the build system that built it. -For more information on how to publish npm packages, see [GitLab npm Package Registry](../../user/packages/npm_registry/index.md). +For more information on how to publish npm packages, see [GitLab npm package registry](../../user/packages/npm_registry/index.md). ### Sigstore diff --git a/doc/development/fe_guide/registry_architecture.md b/doc/development/fe_guide/registry_architecture.md index cf267e80619e..f05f0406c1d5 100644 --- a/doc/development/fe_guide/registry_architecture.md +++ b/doc/development/fe_guide/registry_architecture.md @@ -12,7 +12,7 @@ already exists to unify the user and developer experiences. Existing registries: -- Package Registry +- Package registry - Container Registry - Terraform Module Registry - Dependency Proxy @@ -82,7 +82,7 @@ main pieces of the desired UI and UX of a registry page. The most important comp When adding a new registry: - Leverage the shared components that already exist. It's good to look at how the components are - structured and used in the more mature registries (for example, the Package Registry). + structured and used in the more mature registries (for example, the package registry). - If it's in line with the backend requirements, we suggest using GraphQL for the API. This helps in dealing with the innate performance issue of registries. - If possible, we recommend using [Vue Router](https://v3.router.vuejs.org/) diff --git a/doc/development/packages/new_format_development.md b/doc/development/packages/new_format_development.md index 0af0b8ad4806..08cf9dbd9f4b 100644 --- a/doc/development/packages/new_format_development.md +++ b/doc/development/packages/new_format_development.md @@ -229,7 +229,7 @@ in your local development environment. #### File size limits -Files uploaded to the GitLab Package Registry are [limited by format](../../administration/instance_limits.md#package-registry-limits). +Files uploaded to the GitLab package registry are [limited by format](../../administration/instance_limits.md#package-registry-limits). On GitLab.com, these are typically set to 5GB to help prevent timeout issues and abuse. When a new package type is added to the `Packages::Package` model, a size limit must be added diff --git a/doc/development/packages/settings.md b/doc/development/packages/settings.md index c744f2f351a5..b3306792ac7f 100644 --- a/doc/development/packages/settings.md +++ b/doc/development/packages/settings.md @@ -10,7 +10,7 @@ This page includes an exhaustive list of settings related to and maintained by t ## Instance Settings -### Package Registry +### Package registry Setting | Table | Description ------- | ----- | ----------- diff --git a/doc/development/packages/structure.md b/doc/development/packages/structure.md index 9ab6589c3445..f7eb97576ccb 100644 --- a/doc/development/packages/structure.md +++ b/doc/development/packages/structure.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Package Structure -## Package Registry +## Package registry ```mermaid erDiagram diff --git a/doc/update/index.md b/doc/update/index.md index f7e3a0e3403e..169805ed79e2 100644 --- a/doc/update/index.md +++ b/doc/update/index.md @@ -195,7 +195,7 @@ When upgrading: - GitLab 16: [`16.0.x`](versions/gitlab_16_changes.md#1600) (only instances with [lots of users](versions/gitlab_16_changes.md#long-running-user-type-data-change) or [large pipeline variables history](versions/gitlab_16_changes.md#1610)) > - [`16.1`](versions/gitlab_16_changes.md#1610)(instances with NPM packages in their Package Registry) > + [`16.1`](versions/gitlab_16_changes.md#1610)(instances with NPM packages in their package registry) > [`16.2.x`](versions/gitlab_16_changes.md#1620) (only instances with [large pipeline variables history](versions/gitlab_16_changes.md#1630)) > [`16.3`](versions/gitlab_16_changes.md#1630) > [latest `16.Y.Z`](https://gitlab.com/gitlab-org/gitlab/-/releases). diff --git a/doc/user/gitlab_com/index.md b/doc/user/gitlab_com/index.md index 6f809ae867a0..451c1235bb2c 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 3772ba32bc94..32d59cbb322e 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 938389b78316..842b7bc4d175 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 6eac299e71fe..2ebb1088edc0 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 741525151985..d1097e2a4661 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 45ebfb2ef730..5c304664d42d 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 1416dcde14f3..9ef7c440cfed 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 6dffd7371b6a..0a12ec153a9b 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 b7888fe2d181..0efea21635fd 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 a66662955f3e..e3fc3179c764 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 c8730c420228..e4c92acb6d5c 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 43defb29fd54..9b85e9d4b359 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 8db79dc6c5f0..a12f489d6fe7 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 e9c019deefa0..3934122ffedf 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 e6251034cb21..ff708e70d2ba 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 eb6b415ee060..ca054648d0dd 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 8d31399a36b6..b1d8396c9d19 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 c196e4144617..d29f4803e8eb 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 361114e6f9e9..e193130f8bc7 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 a0757e968bc6..fa72520dff26 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 4db77348bd4d..bb91ca7c4830 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 942e62ae3e7d..d10768552b2e 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 351762228fb8..8459ffdde863 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/releases/release_cli.md b/doc/user/project/releases/release_cli.md index 9daa6705ad8a..c97b438b784c 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 d26ca87e3845..3beff5eccb11 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 d09eb69a4c14..2be22eaacc3a 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 d5697ec5a947..e84b3194d4b7 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 5a0c841eeda0..f5d49577719c 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). -- GitLab