開発覚書はてな版

個人的な開発関連の備忘録

【GitHub】GitHub Package RegistryでNPMを公開する(2019/10/21現在)

目次

概要

  • 2019/10/21現在のGitHub Package Registry β版を使用した情報です。
  • GitHub Package Registry β版でNPM公開をしてみたいと思います。
  • 基本的には公式の手順通りで対応できます。

help.github.com

前提知識

  • NPMコマンドが使えること
  • GitHubがある程度使えること

公開手順

1. GitHub上でアクセストークンを発行する

f:id:kakkoya:20191021202955p:plain

2. ~/.npmrc の編集

  • ~/.npmrc に1で発行したアクセストークンを設定する
    //npm.pkg.github.com/:_authToken=PERSONAL-ACCESS-TOKEN
  • Windows の場合は、C:\Users\(ユーザ名)\.npmrc を編集する。

3. ローカルの .npmrc の編集

  • 公開したいリポジトリの直下にの .npmrc を編集する。OWNER箇所にGithubのユーザー名を設定する。
    @OWNER:registry=https://npm.pkg.github.com

4. package.json の編集

  • package.jsonの以下の箇所を修正する。
    • name:@OWNER/packageName - パッケージ名を指定する。npm-scope形式。
    • version:"1.0.0" - 公開したいバージョンを指定する。
    • repository:githubリポジトリを指定する。
    • publishConfig:"registry":"https://npm.pkg.github.com/" を指定する。
{
  "name": "@OWNER/packageName",
  "version": "1.0.0",
  "repository": "https://github.com/OWNER/repositoryName.git",
  "publishConfig": {
    "registry":"https://npm.pkg.github.com/"
  }
}

5. npm publish の実行

  • npm publish を実行する。エラーがなければ成功です。

f:id:kakkoya:20191021205111p:plain

6. 公開したパッケージの確認

公開したパッケージ

ソース一式

github.com

参考URL

help.github.com

help.github.com

docs.npmjs.com