Node.jsパッケージの公開

はじめに

本ガイドでは、継続的インテグレーション（CI）テストにパスした後、Node.jsのパッケージをGitHub Packages及びnpmレジストリに公開するワークフローの作成方法を紹介します。

前提条件

ワークフローの設定オプションと、ワークフローファイルの作成方法についての基本的な知識を持っておくことをおすすめします。詳しくは、「GitHub Actions について」を参照してください。

Node.js プロジェクト用に CI ワークフローを作る方法については、「Node.js のビルドとテスト」をご覧ください。

また、以下の基本的な理解があれば役立ちます。

パッケージの設定について

package.json ファイル内の name および version フィールドでは、パッケージをレジストリにリンクするためにレジストリで使用される一意識別子を作成します。 package.json ファイルに description フィールドを含めることによって、パッケージのリストページの概要を追加できます。詳細については、npm ドキュメントの「package.json ファイルの作成」と「Node.js モジュールの作成」を参照してください。

ローカルの .npmrc ファイルが存在し、registry 値が指定されている場合、npm publish コマンドでは .npmrc ファイルに構成されたレジストリが使用されます。 setup-node アクションを使用して、既定のレジストリとスコープを構成するローカルの .npmrc ファイルをランナーに作成できます。 setup-node アクションは、プライベートリポジトリへのアクセスや node パッケージの公開に使われる認証トークンも入力として受け付けます。詳細については、setup-node をご覧ください。

setup-node アクションを使用して、ランナーにインストールされている Node.js バージョンを指定できます。

package.json ファイルに publishConfig フィールドを構成するステップをワークフローに追加する場合は、setup-node アクションを使用して registry-url を指定する必要はありませんが、パッケージを公開するレジストリは 1 つに限られます。詳細については、npm ドキュメントの「publishConfig」を参照してください。

npmレジストリへのパッケージの公開

新しいリリースを公開するたびに、パッケージを公開するワークフローをトリガーできます。次の例のプロセスは、type が published のリリースイベントがトリガーされたときに実行されます。 CI テストに合格すると、プロセスによってパッケージが npm レジストリにアップロードされます。詳しくは、「リポジトリのリリースを管理する」を参照してください。

ワークフロー中で npm レジストリに対して認証を受けた操作を行うためには、npm の認証トークンをシークレットとして保存しなければなりません。たとえば、NPM_TOKEN というリポジトリシークレットを作成します。詳しくは、「GitHub Actions でのシークレットの使用」を参照してください。

既定では、npm はpackage.json ファイルのname フィールドを使用して、公開されたパッケージの名前を判断します。グローバルな名前空間に公開する場合は、パッケージ名だけを含める必要があります。たとえば、my-package という名前のパッケージを https://www.npmjs.com/package/my-package に公開します。

スコープのプレフィックスを含むパッケージを公開している場合は、そのスコープを package.json ファイルの名前に含めます。たとえば、npm スコープのプレフィックスが "octocat" で、パッケージ名が "hello-world" の場合、package.json ファイル内の name は @octocat/hello-worldである必要があります。 npm パッケージでスコーププレフィックスが使用され、そのパッケージがパブリックである場合は、オプション npm publish --access public を使用する必要があります。これは、意図せずプライベートパッケージを公開してしまうことを防ぐためにnpmが必要とするオプションです。

この例では、NODE_AUTH_TOKEN 環境変数に NPM_TOKEN シークレットを格納します。 setup-node アクションによって .npmrc ファイルが作成されると、NODE_AUTH_TOKEN 環境変数からトークンが参照されます。

YAML

name: Publish Package to npmjs
on:
  release:
    types: [published]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # Setup .npmrc file to publish to npm
      - uses: actions/setup-node@v4
        with:
          node-version: '16.x'
          registry-url: 'https://registry.npmjs.org'
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

name: Publish Package to npmjs
on:
  release:
    types: [published]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # Setup .npmrc file to publish to npm
      - uses: actions/setup-node@v4
        with:
          node-version: '16.x'
          registry-url: 'https://registry.npmjs.org'
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

上の例では、setup-node アクションによって、ランナーに次の内容の .npmrc ファイルが作成されます。

//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}
registry=https://registry.npmjs.org/
always-auth=true

資格情報を適切に構成するには、setup-node で registry-url を https://registry.npmjs.org/ に設定する必要があることに注意してください。

GitHub Packagesへのパッケージの公開

新しいリリースを公開するたびに、パッケージを公開するワークフローをトリガーできます。次の例のプロセスは、type が published のリリースイベントがトリガーされたときに実行されます。 CI テストに合格すると、プロセスによってパッケージが GitHub Packagesにアップロードされます。詳しくは、「リポジトリのリリースを管理する」を参照してください。

宛先リポジトリの設定

repository キーを使ってパッケージを GitHub Packages にリンクすることは省略可能です。 package.json ファイルに name キーを指定しないことを選択した場合、GitHub Packages は、package.json ファイルの repository フィールドで指定した GitHub リポジトリにパッケージを公開します。たとえば、@my-org/test という名前のパッケージは、my-org/test GitHub リポジトリに公開されます。 repository キーで指定された url が無効な場合でも、パッケージは公開される可能性があります。しかし、意図したとおりにリポジトリソースにリンクされません。

package.json ファイルに repository キーを指定すると、そのキーのリポジトリが GitHub Packages の宛先の npm レジストリとして使用されます。たとえば、以下の package.json を公開すると my-package という名前のパッケージが octocat/my-other-repo GitHub リポジトリに公開されます。公開されると、リポジトリソースのみが更新され、パッケージは宛先リポジトリからアクセス許可を継承しません。

{
  "name": "@octocat/my-package",
  "repository": {
    "type": "git",
    "url": "https://github.com/octocat/my-other-repo.git"
  },

宛先リポジトリへの認証

ワークフローの GitHub Packages レジストリに対して認証済み操作を行うために、GITHUB_TOKEN を使用することができます。ワークフロー内のジョブが開始されるたびに、GITHUB_TOKEN シークレットはそのリポジトリのアクセストークンに設定されます。ワークフローファイルでこのアクセストークンにアクセス許可を設定して、contents スコープに対する読み取りアクセス権と、packages スコープに対する書き込みアクセス権を付与する必要があります。詳しくは、「自動トークン認証」を参照してください。

パッケージを別のリポジトリに公開する場合は、宛先リポジトリ内のパッケージに書き込む権限を持つpersonal access token (classic)を使う必要があります。詳細については、「個人用アクセストークンを管理する」および「GitHub Actions でのシークレットの使用」を参照してください。

ワークフローの例

この例では、NODE_AUTH_TOKEN 環境変数に GITHUB_TOKEN シークレットを格納します。 setup-node アクションによって .npmrc ファイルが作成されると、NODE_AUTH_TOKEN 環境変数からトークンが参照されます。

YAML

name: Publish package to GitHub Packages
on:
  release:
    types: [published]
jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write
    steps:
      - uses: actions/checkout@v4
      # Setup .npmrc file to publish to GitHub Packages
      - uses: actions/setup-node@v4
        with:
          node-version: '16.x'
          registry-url: 'https://npm.pkg.github.com'
          # Defaults to the user or organization that owns the workflow file
          scope: '@octocat'
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

name: Publish package to GitHub Packages
on:
  release:
    types: [published]
jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write
    steps:
      - uses: actions/checkout@v4
      # Setup .npmrc file to publish to GitHub Packages
      - uses: actions/setup-node@v4
        with:
          node-version: '16.x'
          registry-url: 'https://npm.pkg.github.com'
          # Defaults to the user or organization that owns the workflow file
          scope: '@octocat'
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

setup-node アクションにより、ランナーに .npmrc ファイルが作成されます。 setup-node アクションに対して scope 入力を使用すると、.npmrc ファイルにスコーププレフィックスが含まれます。既定では、setup-node アクションにより、 .npmrc ファイルのスコープが、そのワークフローファイルを含むアカウントに設定されます。

//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}
@octocat:registry=https://npm.pkg.github.com
always-auth=true

yarnを利用したパッケージの公開

パッケージマネージャーのYarnを使う場合、Yarnを使ってパッケージのインストールと公開が行えます。

YAML

name: Publish Package to npmjs
on:
  release:
    types: [published]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # Setup .npmrc file to publish to npm
      - uses: actions/setup-node@v4
        with:
          node-version: '16.x'
          registry-url: 'https://registry.npmjs.org'
          # Defaults to the user or organization that owns the workflow file
          scope: '@octocat'
      - run: yarn
      - run: yarn npm publish // for Yarn version 1, use `yarn publish` instead
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

name: Publish Package to npmjs
on:
  release:
    types: [published]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # Setup .npmrc file to publish to npm
      - uses: actions/setup-node@v4
        with:
          node-version: '16.x'
          registry-url: 'https://registry.npmjs.org'
          # Defaults to the user or organization that owns the workflow file
          scope: '@octocat'
      - run: yarn
      - run: yarn npm publish // for Yarn version 1, use `yarn publish` instead
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

Node.jsパッケージの公開

この記事の内容