Publish packages with Yarn

1. Create an authentication token for your project or group:

   1. On the left sidebar, select Search or go to and find your project or group.
   2. On the left sidebar, select Settings > Repository > Deploy Tokens.
   3. Create a deployment token with read_package_registry and write_package_registry scopes and copy the generated token.
   4. On the left sidebar, select Settings > CI/CD > Variables.
   5. Select Add variable and use the following settings:

   Field	Value
   key	NPM_AUTH_TOKEN
   value	<DEPLOY-TOKEN>
   type	Variable
   Protected variable	CHECKED
   Mask variable	CHECKED
   Expand variable	CHECKED

2. Optional. To use protected variables:

   1. Go to the repository that contains the Yarn package source code.
   2. On the left sidebar, select Settings > Repository.
      • If you are building from branches with tags, select Protected Tags and add v* (wildcard) for semantic versioning.
      • If you are building from branches without tags, select Protected Branches.

3. Add the NPM_AUTH_TOKEN you created to the .yarnrc.yml configuration in your package project root directory where package.json is found:

   npmScopes:
     <my-org>:
       npmPublishRegistry: '${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/npm/'
       npmAlwaysAuth: true
       npmAuthToken: '${NPM_AUTH_TOKEN}'

   In this configuration, replace <my-org> with your organization scope, excluding the @ symbol.

1. Add your CI_JOB_TOKEN to the .yarnrc.yml configuration in the root directory of your package project, where package.json is located:

   npmScopes:
     <my-org>:
       npmPublishRegistry: '${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/npm/'
       npmAlwaysAuth: true
       npmAuthToken: '${CI_JOB_TOKEN}'

   In this configuration, replace <my-org> with your organization scope, excluding the @ symbol.

2. In the GitLab project with your .yarnrc.yml, edit or create a .gitlab-ci.yml file. For example, to trigger only on any tag push:

   In Yarn 1:

   image: node:lts
   
   stages:
     - deploy
   
   rules:
   - if: $CI_COMMIT_TAG
   
   deploy:
     stage: deploy
     script:
       - yarn publish

   In Yarn 2 and higher:

   image: node:lts
   
   stages:
     - deploy
   
   rules:
     - if: $CI_COMMIT_TAG
   
   deploy:
     stage: deploy
     before_script:
       - corepack enable
       - yarn set version stable
     script:
       - yarn npm publish

When the pipeline runs, your package is added to the package registry.

1. Configure the group scope. In your .yarnrc.yml file, add the following:

   npmScopes:
     <my-org>:
       npmRegistryServer: 'https://<domain_name>/api/v4/groups/<group_id>/-/packages/npm'

   • Replace <my-org> with the top-level group that contains the group you want to install from. Exclude the @ symbol.
   • Replace <domain_name> with your domain name, for example, gitlab.com.
   • Replace <group_id> with your group ID, found on the group overview page.

2. Optional. If your package is private, you must set the registry:

   npmRegistries:
     //<domain_name>/api/v4/groups/<group_id>/-/packages/npm:
       npmAlwaysAuth: true
       npmAuthToken: "<token>"

   • Replace <domain_name> with your domain name, for example, gitlab.com.
   • Replace <token> with a deployment token (recommended), group access token, project access token, or personal access token.
   • Replace <group_id> with your group ID, found on the group overview page.

3. Install the package with Yarn.

1. Configure the project scope. In your .yarnrc.yml file, add the following:

   npmScopes:
    <my-org>:
      npmRegistryServer: "https://<domain_name>/api/v4/projects/<project_id>/packages/npm"

   • Replace <my-org> with the top-level group that contains the project you want to install from. Exclude the @ symbol.
   • Replace <domain_name> with your domain name, for example, gitlab.com.
   • Replace <project_id> with your project ID, found on the project overview page.

2. Optional. If your package is private, you must set the registry:

   npmRegistries:
     //<domain_name>/api/v4/projects/<project_id>/packages/npm:
       npmAlwaysAuth: true
       npmAuthToken: "<token>"

   • Replace <domain_name> with your domain name, for example, gitlab.com.
   • Replace <token> with a deployment token (recommended), group access token, project access token, or personal access token.
   • Replace <project_id> with your project ID, found on the project overview page.

3. Install the package with Yarn.

• Run yarn add either from the command line, or from a CI/CD pipeline:

yarn add @scope/my-package

Yarn Classic requires both a .npmrc and a .yarnrc file. See Yarn issue 4451 for more information.

1. Place your credentials in the .npmrc file, and the scoped registry in the .yarnrc file:

   # .npmrc
   ## For the instance
   //<domain_name>/api/v4/packages/npm/:_authToken='<token>'
   ## For the group
   //<domain_name>/api/v4/groups/<group_id>/-/packages/npm/:_authToken='<token>'
   ## For the project
   //<domain_name>/api/v4/projects/<project_id>/packages/npm/:_authToken='<token>'
   
   # .yarnrc
   ## For the instance
   '@scope:registry' 'https://<domain_name>/api/v4/packages/npm/'
   ## For the group
   '@scope:registry' 'https://<domain_name>/api/v4/groups/<group_id>/-/packages/npm/'
   ## For the project
   '@scope:registry' 'https://<domain_name>/api/v4/projects/<project_id>/packages/npm/'

2. Run yarn add either from the command line, or from a CI/CD pipeline:

   yarn add @scope/my-package