Skip to main content
ドキュメントへの更新が頻繁に発行されており、このページの翻訳はまだ行われている場合があります。 最新の情報については、「英語のドキュメント」を参照してください。

npmレジストリの利用

GitHub Packages にパッケージを公開するよう npm を設定し、GitHub Packages に保存されたパッケージを依存関係として npm プロジェクトで利用できます。

注: サイト管理者はそれぞれのサポートされているパッケージの種類を有効化あるいは無効化できるので、このパッケージの種類はインスタンスで利用できないかもしれません。 詳細については、「エンタープライズ向けのパッケージ サポートの構成」を参照してください。

公開したnpmバージョンに対する制限

GitHub Packagesに公開したnpmパッケージのバージョンが1000を超える場合、使用中にパフォーマンスの問題やタイムアウトが発生することがあります。

サービスのパフォーマンスを向上させるため、将来的には1,000を超えるパッケージのバージョンをGitHubに公開できなくなります。 この制限に達しないバージョンであれば、今後も読み取り可能です。

この制限に達した場合は、パッケージのバージョンを削除するよう検討するか、サポートにお問い合わせください。 この制限が施行されるようになると、ドキュメントが更新され、この制限を回避する方法が記載されることになります。 詳細については、「パッケージを削除および復元する」または「サポートに問い合わせる」を参照してください。

GitHub Packages への認証を行う

非公開パッケージ、内部パッケージ、公開パッケージを発行、インストール、削除するには、アクセス トークンが必要です。

personal access token を使って、GitHub Packages または GitHub Enterprise Server API の認証を受けることができます。 personal access token を作成するときは、必要に応じてさまざまなスコープをトークンに割り当てることができます。 personal access token のパッケージ関連のスコープについて詳しくは、「GitHub パッケージのアクセス許可について」をご覧ください。

GitHub Actionsワークフロー内でGitHub Packagesレジストリに認証を受けるには、以下の方法が使えます。

  • GITHUB_TOKEN では、ワークフロー リポジトリに関連付けられているパッケージを発行します。
  • read:packages 以上のスコープが設定された personal access token では、他のプライベート リポジトリ (GITHUB_TOKEN ではアクセスできない) に関連付けられているパッケージがインストールされます。

personal access token で認証を行う

GitHub Packages でパッケージを発行およびインストールするには、適切なスコープで personal access token を使う必要があります。 詳しくは、「GitHub Packages について」をご覧ください。

npm で GitHub Packages に対して認証を行うには、ユーザーごとの ~/.npmrc ファイルを編集して personal access token を含めるか、コマンド ラインでユーザー名と personal access token を使って npm にログインします。

~/.npmrc ファイルに personal access token を追加して認証を行うには、プロジェクトの ~/.npmrc ファイルを編集して次の行を含めます。HOSTNAME は your GitHub Enterprise Server instance のホスト名に、TOKEN は personal access token に置き換えます。 存在しない場合は、新しい ~/.npmrc ファイルを作成します。

インスタンスで Subdomain Isolation が有効になっている場合:

//npm.HOSTNAME//:_authToken=TOKEN

インスタンスで Subdomain Isolation が無効になっている場合:

//HOSTNAME/_registry/npm/:_authToken=TOKEN

npm にログインして認証を行うには、npm login コマンドを使用します。USERNAME は GitHub ユーザー名に、TOKEN は personal access token に、PUBLIC-EMAIL-ADDRESS はメール アドレスに置き換えます。

npm CLI バージョン 9 以上を使用していて、コマンド ラインを使用してプライベート レジストリにログインまたはログアウトしている場合は、ブラウザー経由で既定のログイン フローを使用する代わりに、プロンプトから認証の詳細を読み取る --auth-type=legacy オプションを使用する必要があります。 詳細については、「npm-login」を参照してください。

GitHub Packages が npm を使用するための既定のパッケージ レジストリではなく、npm audit コマンドを使用する場合は、GitHub Packages に対する認証時に、パッケージの所有者と共に --scope フラグを使用することをお勧めします。

インスタンスで Subdomain Isolation が有効になっている場合:

$ npm login --scope=@OWNER --auth-type=legacy --registry=https://npm.HOSTNAME/

> Username: USERNAME
> Password: TOKEN

インスタンスで Subdomain Isolation が無効になっている場合:

$ npm login --scope=@OWNER --auth-type=legacy --registry=https://HOSTNAME/_registry/npm/
> Username: USERNAME
> Password: TOKEN

パッケージの公開

注: パッケージ名とスコープには小文字のみを使用する必要があります。

既定では、GitHub Packages は package.json ファイルの name フィールドで指定された GitHub リポジトリにパッケージを公開します。 たとえば、@my-org/test という名前のパッケージは、my-org/test GitHub リポジトリに公開することになります。 npm v8.5.3 以降を実行している場合は、パッケージ ディレクトリに README.md ファイルを含めることで、パッケージのリスト ページの概要を追加できます。 詳しくは、package.json の利用Node.js モジュールの作成方法に関する npm のドキュメントをご覧ください。

URL フィールドを package.json ファイルに含めることで、同じ GitHub リポジトリに複数のパッケージを公開できます。 詳しくは、「同じリポジトリへの複数パッケージの公開」をご覧ください。

プロジェクト内にあるローカルの .npmrc ファイルか、package.jsonpublishConfig オプションを使用して、プロジェクトのスコープのマッピングを設定できます。 GitHub Packagesはスコープ付きのnpmパッケージのみをサポートしています。 スコープ付きのパッケージには、@owner/name 形式の名前が付いています。 スコープ付きのパッケージの先頭には常に @ 記号が付いています。 スコープ付きの名前を使うには、package.json で名前を更新する必要がある場合があります。 たとえば、"name": "@codertocat/hello-world-npm" のようにします。

パッケージを公開した後は、GitHub上でそのパッケージを見ることができます。 詳しくは、「パッケージの表示」をご覧ください。

ローカルの .npmrc ファイルを使用したパッケージの公開

.npmrc ファイルを使用して、プロジェクトのスコープのマッピングを設定できます。 .npmrc ファイルで GitHub Packages の URL とアカウント所有者を使い、GitHub Packages がパッケージ要求のルーティング先を把握できるようにしてください。 .npmrc ファイルを使うことで、他の開発者がパッケージを GitHub Packages ではなく npmjs.org に誤って公開することを防止できます。

  1. GitHub Packagesに認証を受けてください。 詳細については、「GitHub Packages への認証」を参照してください。 2. package.json ファイルと同じディレクトリで、.npmrc ファイルを作成するか編集し、GitHub Packages URL とアカウント所有者を指定する行を含めます。 OWNER を、プロジェクトを含むリポジトリを所有しているユーザーもしくは組織アカウント名で置換します。

    サブドメイン分離が有効な場合:

    @OWNER:registry=https://npm.HOSTNAME

    Subdomain Isolationが無効な場合:

    @OWNER:registry=https://HOSTNAME/_registry/npm
  2. GitHub Packages でプロジェクトを見つけられるリポジトリに .npmrc ファイルを追加します。 詳細については、「リポジトリにファイルを追加する」を参照してください。

  3. プロジェクトの package.json にあるパッケージの名前を確認します。 name フィールドには、スコープとパッケージの名前が含まれている必要があります。 たとえば、パッケージの名前が "test" で、"My-org" GitHub Organization に公開する場合、package.jsonname フィールドは @my-org/test にする必要があります。

  4. プロジェクトの package.jsonrepository フィールドを確認します。 repository フィールドは、GitHub リポジトリの URL と一致している必要があります。 たとえば、リポジトリの URL が github.com/my-org/test である場合、repository フィールドは https://github.com/my-org/test.git でなければなりません。 1. パッケージを公開してください。

    $ npm publish

package.json ファイルでの publishConfig を使用したパッケージの公開

package.json ファイルで publishConfig 要素を使用して、パッケージを公開するレジストリを指定できます。 詳細については、npm ドキュメントの「publishConfig」を参照してください。

  1. パッケージの package.json ファイルを編集して、publishConfig のエントリを含めるようにします。 インスタンスで Subdomain Isolation が有効になっている場合:

    "publishConfig": {
      "registry": "https://npm.HOSTNAME/"
    },

    インスタンスで Subdomain Isolation が無効になっている場合:

    "publishConfig": {
       "registry": "https://HOSTNAME/_registry/npm/"
     },
    1. プロジェクトの package.jsonrepository フィールドを確認します。 repository フィールドは、GitHub リポジトリの URL と一致している必要があります。 たとえば、リポジトリの URL が github.com/my-org/test である場合、repository フィールドは https://github.com/my-org/test.git でなければなりません。 1. パッケージを公開してください。
    $ npm publish

同じリポジトリへの複数パッケージの公開

複数のパッケージを同じリポジトリに公開する場合は、GitHub リポジトリの URL を、各パッケージの package.json ファイルの repository フィールドに含めます。

リポジトリのURLが正しいことを確認するには、REPOSITORYを公開したいパッケージを含むリポジトリ名で、OWNERをリポジトリを所有しているGitHubのユーザもしくはOrganizationアカウント名で置き換えてください。

GitHub Packages は、パッケージ名の代わりに、このURLを元にしてリポジトリを照合します。

"repository":"https://HOSTNAME/OWNER/REPOSITORY",

パッケージのインストール

プロジェクトの package.json ファイルに依存関係としてパッケージを追加することで、GitHub Packages からパッケージをインストールできます。 プロジェクトで package.json を使用する方法について詳しくは、package.json の利用に関する npm のドキュメントをご覧ください。

デフォルトでは、パッケージは1つのOrganizationから追加できます。 詳しくは、「他の Organization からのパッケージのインストール」をご覧ください。

プロジェクトに .npmrc ファイルを追加して、パッケージをインストールするためのすべての要求が GitHub Packages を経由するようにする必要もあります。 すべてのパッケージ要求を GitHub Packages 経由になるようにルーティングすると、npmjs.org のスコープ付きおよびスコープなしのパッケージをどちらも使用できるようになります。詳しくは、npm のスコープに関する npm のドキュメントをご覧ください。

  1. GitHub Packagesに認証を受けてください。 詳細については、「GitHub Packages への認証」を参照してください。 2. package.json ファイルと同じディレクトリで、.npmrc ファイルを作成するか編集し、GitHub Packages URL とアカウント所有者を指定する行を含めます。 OWNER を、プロジェクトを含むリポジトリを所有しているユーザーもしくは組織アカウント名で置換します。

    サブドメイン分離が有効な場合:

    @OWNER:registry=https://npm.HOSTNAME

    Subdomain Isolationが無効な場合:

    @OWNER:registry=https://HOSTNAME/_registry/npm
  2. GitHub Packages でプロジェクトを見つけられるリポジトリに .npmrc ファイルを追加します。 詳細については、「リポジトリにファイルを追加する」を参照してください。

  3. インストールするパッケージを使用するように、プロジェクトの package.json を構成します。 GitHub Packages のためにパッケージの依存関係を package.json ファイルに追加するには、@my-org/server のように完全なスコープ付きのパッケージ名を指定してください。 npmjs.com のパッケージの場合は、@babel/core または @lodash のように完全な名前を指定してください。 <organization_name>/<package_name> をパッケージの依存関係と置き換えます。

    {
      "name": "@my-org/server",
      "version": "1.0.0",
      "description": "Server app that uses the <organization_name>/<package_name> package",
      "main": "index.js",
      "author": "",
      "license": "MIT",
      "dependencies": {
        "<organization_name>/<package_name>": "1.0.0"
      }
    }
    
  4. パッケージをインストールします。

    $ npm install

他のOrganizationからのパッケージのインストール

デフォルトでは、1つのOrganizationからのみGitHub Packagesパッケージを利用できます。 パッケージ要求を複数の組織とユーザーにルーティングする場合は、 .npmrc ファイルに行を追加できます。HOSTNAME は your GitHub Enterprise Server instance のホスト名に、OWNER はプロジェクトが含まれているリポジトリを所有するユーザーまたは組織アカウントの名前に置き換えます。

インスタンスで Subdomain Isolation が有効になっている場合:

@OWNER:registry=https://npm.HOSTNAME
@OWNER:registry=https://npm.HOSTNAME

インスタンスで Subdomain Isolation が無効になっている場合:

@OWNER:registry=https://HOSTNAME/_registry/npm
@OWNER:registry=https://HOSTNAME/_registry/npm

公式NPMレジストリを使用する

GitHub Packages では、registry.npmjs.com の公式 NPM レジストリにアクセスできます (GitHub Enterprise Server 管理者がこの機能を有効にしている場合)。 詳しくは、「公式 NPM レジストリに接続する」をご覧ください。