Beberapa rule awal

• ✅ Mengenai package scope, kalau di npm kamu akan membuat organization kemudian publish ke organisasi yang telah kamu buat sebagai scope. Tidak jauh beda, cuma karena organisasinya akan nempel dengan GitHub, jadi kamu cuma bisa pakai satu scope dalam satu organisasi. Jadi kalau dalam satu organisasi ternyata yang akan menggunakan GitHub package itu bukan hanya timmu, sebaiknya sih tambahkan juga prefix tambahan di nama package nya, biar gak pusing nyari tim yang punya package.

• ✅ Setting package.json, ada beberapa setting yang jadinya required pas mau develop package yang akan di publish ke GitHub Package. Yang pertama repository, pastikan punya vallue yang tepat, nantinya kan package-nya akan nempel di sidebar dan bisa dilihat di masing-masing repo. Yang kedua publishConfig harus punya field registry yang diarahkan ke https://npm.pkg.github.com. Yang ketiga ya seperti maintain third-party package biasanya saja ya, seperti: setting private: true nya dihilangkan, setting files dengan benar, setting main ke file yang tepat, dan lainnya.

"repository": {
  "type": "git",
  "url": "https://github.com/YOUR_ORG/YOUR_REPO.git"
},
"publishConfig": {
  "registry": "https://npm.pkg.github.com"
},

Akses dari lokal

Karena saya akan mempublikasikan ke organisasi, jadi saya perlu login ke scope-nya organisasi yang dimaksud. Kamu bisa mengikuti perintah berikut:

npm login --scope=@YOUR_ORG --registry=https://npm.pkg.github.com

Setelah menjalankan perintah di atas, kamu akan ditanya beberapa hal

• ✅ Username: Isikan dengan username dari GitHub yang kamu gunakan untuk mengakses GitHub Packages
• ✅ Password: Isikan dengan personal access token (PAT) yang punya scope untuk read dan write (bila diperlukan) ke Github Package
• ✅ Email: Isikan dengan email yang terhubung dengan GitHub

Seperti terlihat, kamu membutuhkan PAT untuk mengakses ke Github Packages. kamu bisa mengunjungi halaman Setting Token di Github untuk membuat PAT milikmu. Pastikan punya scope yang sudah disebutkan di atas.

Validasi Akses Lokal

Perintah npm login, setelah sukses dikerjakan sebenarnya akan menyetel nilai baru ke ~/.npmrc kalian. Jadi untuk validasi, tinggal coba buka saja file ini, misal dengan vi:

vi ~/.npmrc

Berikutnya, kamu bisa cek user yang saat ini login dengan perintah:

npm whoami --registry=https://npm.pkg.github.com

Kalau-kalau kamu masih dianggap tidak login dengan benar, coba saja cara manual dengan langsung set ke config-nya npm, dengan perintah:

npm set email YOUR_GITHUB_EMAIL
npm set YOUR_ORG:registry https://npm.pkg.github.com
npm set //npm.pkg.github.com/:_authToken YOUR_GITHUB_TOKEN

Cara ini juga biasanya dilakukan ketika harus melakukan otentikasi di sistem CI, dimana kita tidak bisa menggunakan command line yang interaktif lagi.

Akses dari CI

Sedikit agak berbeda ketika menggunakan CI, disini saya hanya mencontohkan dengan Github Action

npm set email YOUR_GITHUB_EMAIL
npm set YOUR_ORG:registry https://npm.pkg.github.com
npm set //npm.pkg.github.com/:_authToken YOUR_GITHUB_TOKEN

name: Install Private Packages
on:
  push:

jobs:
  install:
    runs-on: ubuntu-latest

    permissions:
      contents: read
      packages: write

    steps:
      - name: Checkout repository
        uses: actions/checkout@v2

      - name: Setup Node
        uses: actions/setup-node@v2
        with:
          node-version: '14.x'
          registry-url: 'https://npm.pkg.github.com'
          scope: '@YOUR_ORGANIZATION'

      - name: Private package auth
        run: |
          npm set @YOUR_ORG:registry https://npm.pkg.github.com
          npm set email YOUR_EMAIL
          npm set //npm.pkg.github.com/:_authToken ${{ secrets.PAT }}

      - name: Install dependencies
        run: npm install

- name: Publish
  run: npm publish
  env:
    NODE_AUTH_TOKEN: ${{ secrets.PAT }}