Yarnでパッケージを公開する

1. プロジェクトまたはグループの認証トークンを作成します:

   1. 左側のサイドバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
   2. 左側のサイドバーで、設定 > リポジトリ > Deploy Tokens（デプロイトークン）を選択します。
   3. read_package_registryおよびwrite_package_registryスコープを持つデプロイトークンを作成し、生成されたトークンをコピーします。
   4. 左側のサイドバーで、設定 > CI/CD > 変数を選択します。
   5. Add variableを選択し、次の設定を使用します:

   フィールド	値
   キー:	NPM_AUTH_TOKEN
   値	<DEPLOY-TOKEN>
   タイプ:	変数
   保護された変数	CHECKED
   マスクされた変数	CHECKED
   変数を展開します。	CHECKED

2. オプション。保護された変数を使用するには:

   1. Yarnパッケージのコードソースを含むリポジトリに移動します。
   2. 左側のサイドバーで、設定 > リポジトリを選択します。
      • タグ付けのあるブランチからビルドする場合は、保護されたタグを選択し、セマンティックバージョニングのためにv*（ワイルドカード）を追加します。
      • タグ付けのないブランチからビルドする場合は、ブランチルールを選択します。

3. 作成したNPM_AUTH_TOKENを、パッケージプロジェクトのルートディレクトリにある、package.jsonが見つかる.yarnrc.yml設定に追加します:

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

   この設定で、@記号を除外して、<my-org>を組織スコープに置き換えます。

1. package.jsonが配置されているパッケージプロジェクトのルートディレクトリにある.yarnrc.yml設定に、CI_JOB_TOKENを追加します:

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

   この設定で、@記号を除外して、<my-org>を組織スコープに置き換えます。

2. .yarnrc.ymlを含むGitLabプロジェクトで、.gitlab-ci.ymlファイルを編集または作成します。たとえば、任意のタグプッシュでのみトリガーするには:

   Yarn 1の場合:

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

   Yarn 2以降:

   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

パイプラインが実行されると、パッケージがパッケージレジストリに追加されます。

1. グループスコープを設定します。.yarnrc.ymlファイルで、以下を追加します:

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

   • インストール元のグループを含む、<my-org>をトップレベルグループに置き換えます。@記号を除外します。
   • <domain_name>をドメイン名に置き換えます（例: gitlab.com）。
   • <group_id>を、グループの概要ページにあるグループIDに置き換えます。

2. オプション。パッケージがプライベートの場合は、レジストリを設定する必要があります:

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

   • <domain_name>をドメイン名に置き換えます（例: gitlab.com）。
   • <token>を、デプロイトークン（推奨）、グループアクセス、プロジェクトアクセス、またはパーソナルアクセスに置き換えます。
   • <group_id>を、グループの概要ページにあるグループIDに置き換えます。

3. Yarnでパッケージをインストール。

1. プロジェクトスコープを設定します。.yarnrc.ymlファイルで、以下を追加します:

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

   • インストール元のプロジェクトを含む、<my-org>をトップレベルグループに置き換えます。@記号を除外します。
   • <domain_name>をドメイン名に置き換えます（例: gitlab.com）。
   • <project_id>を、プロジェクトの概要ページのプロジェクトIDに置き換えます。

2. オプション。パッケージがプライベートの場合は、レジストリを設定する必要があります:

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

   • <domain_name>をドメイン名に置き換えます（例: gitlab.com）。
   • <token>を、デプロイトークン（推奨）、グループアクセス、プロジェクトアクセス、またはパーソナルアクセスに置き換えます。
   • <project_id>を、プロジェクトの概要ページのプロジェクトIDに置き換えます。

3. Yarnでパッケージをインストール。

• コマンドラインから、またはCI/CDパイプラインからyarn addを実行します:

yarn add @scope/my-package

Yarn Classicには、.npmrcファイルと.yarnrcファイルの両方が必要です。詳細については、Yarn issue 4451を参照してください。

1. .npmrcファイルに認証情報を配置し、.yarnrcファイルにスコープレジストリを配置します:

   # .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. コマンドラインから、またはCI/CDパイプラインからyarn addを実行します:

   yarn add @scope/my-package