GitHub Packagesで共通のnpmパッケージをチームで利用する方法

概要

GitHub Packagesでバックエンド・フロントエンドで共通のパッケージを公開し社内で利用してみました。

GitHub Packagesの利用方法について初めて利用される方に向けて備忘録として残します。

やり方

packageを管理するリポジトリを作成します

今回はgithub-packages-sampleというリポジトリを作成します

https://docs.github.com/ja/repositories/creating-and-managing-repositories/creating-a-new-repository

package.jsonを作成します

作成したリポジトリにチェックアウトしていることを確認しpackage.jsonファイルを作成します

https://docs.github.com/ja/packages/quickstart

package.json

{
  "name": "@プロジェクト名/リポジトリ名",
  "version": "1.0.0",
  "repository": {
    "type": "git",
    // GitHubリポジトリをCronする際のHTTPS
    "url": "https://github.com/xxx/test.git",
    "directory": "GitHub-Packages-sample"
  }
}

npmをinstallします

bash

npm install

任意の文字列をコンソールに出力する処理を記述します

ndex.jsを作成し以下を入力してください

index.js

console.log("初めてのGitHubpackages");

GitHubに認証するための設定を記述します

.npmrcファイルを作成し以下を入力してください

https://docs.github.com/ja/packages/working-with-a-github-packages-registry/working-with-the-npm-registry

https://docs.github.com/ja/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

.npmrc

//npm.pkg.github.com/:_authToken=作成した個人アクセストークン（個人アクセストークンを使用するを参照）
registry=https://npm.pkg.github.com/リポジトリ名

ここまでで作成したファイルをリポジトリにpushします

bash

git add .
git commit -m "feat:initialCommit"
git push

GitHub Packagesで公開します

bash

npm publish

完成

最後に

読んでいただきありがとうございます。
今回の記事はいかがでしたか？
・こういう記事が読みたい
・こういうところが良かった
・こうした方が良いのではないか
などなど、率直なご意見を募集しております。