Github Package Registry

Оглавление

• Access token
• Публикация в GPR
• Установка пакетов из GPR

В этой статье я покажу как начать работать с GitHub Package Registry и npmjs.com одновременно.

Access token

В первую очередь нам нужен access token для прав публикации, установки, и удаления пакетов. Ниже я привел таблицу в которой описаны права и их возможности:

Генерируется токен в Github, в разделе настроек Settings -> Developer settings -> Personal access tokens.

Публикация в GPR

Ключевыми моментами для публикации пакета в GPR — являются два файла package.json и .npmrc. Для начала я покажу стандартный пример файла package.json:

"version": "1.0.0",
"name": "@yourOrganizationOrAccount/yourPackageName",
"description": "description",
"author": {
  "name": "authorName",
  "email": "email",
},
"repository": {
    "type": "git",
    "url": "urlToYourRepository"
},
"publishConfig": {
  "registry": "https://npm.pkg.github.com/yourOrganizationOrAccount"
},

В настройках package.json важно отметить две вещи:

1. "name": "@yourOrganizationOrAccount/yourPackageName" — указывается именно в таком формате, иначе ваш пакет не будет найден.
2. publishConfig.registry — эта настройка нужна для того, чтобы пакет публиковался именно в GPR, а не в npmjs.com.

В файле .npmrc нужно прописать способ авторизации по токену и указать откуда npm будет «подсасывать» наши пакеты. Это нужно если у вашего пакета нет внешних зависимостей.

//npm.pkg.github.com/:_authToken=YOUR_TOKEN_HERE
@yourOrganizationOrAccount:registry=https://npm.pkg.github.com

@yourOrganizationOrAccount:registry=https://npm.pkg.github.com
@yourOrganizationOrAccount2:registry=https://npm.pkg.github.com
@yourOrganizationOrAccount3:registry=https://npm.pkg.github.com

Теперь проект можно смело пробовать публиковать через команду:

npm publish

И при установке пакетов, npm установит как внешние зависимости, так и внутренние.

Установка пакетов из GPR

На самом деле для установки пакетов мы все уже сделали, вам нужно лишь создать файл .npmrc с нужными данными организации и выполнить команду:

npm i @yourOrganizationOrAccount/yourPackageName@0.0.1