Utilisation du registre npm

URL pour le npm registry

Si vous accédez à GitHub via GitHub.com, vous publierez des packages sur https://npm.pkg.github.com. Les exemples de cet article utilisent cette URL.

Si vous accédez à GitHub sur un autre domaine, tel que octocorp.ghe.comemplacez « https://npm.pkg.github.com par https://npm.SUBDOMAIN.ghe.com, où SUBDOMAINse trouve le sous-domaine unique de votre entreprise.

Authentification auprès de GitHub Packages

Vous avez besoin d’un jeton d’accès pour publier, installer et supprimer des packages privés, internes et publics.

Vous pouvez utiliser un personal access token (classic) pour vous authentifier auprès de GitHub Packages ou de l’API GitHub. Quand vous créez un personal access token (classic), vous pouvez l’attribuer à différentes étendues selon vos besoins. Pour plus d’informations sur les étendues liées aux packages pour un personal access token (classic), consultez À propos des autorisations pour les packages GitHub.

Pour vous authentifier sur un registre GitHub Packages dans un workflow GitHub Actions, vous pouvez utiliser :

• GITHUB_TOKEN pour publier des packages associés au dépôt du workflow.
• Un personal access token (classic) avec au moins read:packages la possibilité d'installer des paquets associés à d'autres référentiels privés (GITHUB_TOKEN peut être utilisé si le référentiel a un accès en lecture au paquet. Consultez Configuration du contrôle d’accès et de la visibilité d’un package.

Authentification dans un workflow GitHub Actions

Ce registre prend en charge les autorisations granulaires. Pour les registres prenant en charge les autorisations granulaires, si votre workflow GitHub Actions utilise un personal access token pour s’authentifier auprès d’un registre, nous vous recommandons vivement de mettre à jour votre workflow pour utiliser GITHUB_TOKEN. Pour obtenir des conseils sur la mise à jour de vos flux de travail qui s’authentifient auprès d’un registre avec un personal access token, consultez Publication et installation d’un package avec GitHub Actions.

Vous pouvez utiliser un GITHUB_TOKEN dans un workflow GitHub Actions pour supprimer ou restaurer un package via l’API REST si le jeton dispose de l’autorisation admin sur le package. Les référentiels qui publient des packages à l’aide d’un workflow et les référentiels que vous avez explicitement connectés à des packages se voient automatiquement accorder l’autorisation admin aux packages dans le référentiel.

Pour plus d’informations sur GITHUB_TOKEN, consultez Utiliser GITHUB_TOKEN pour l’authentification dans les flux de travail. Pour plus d’informations sur les bonnes pratiques lors de l’utilisation d’un registre dans des actions, consultez Informations de référence sur l’utilisation sécurisée.

Vous pouvez également choisir d’accorder des autorisations d’accès aux packages indépendamment pour GitHub Codespaces et GitHub Actions. Pour plus d’informations, consultez « Configuration du contrôle d’accès et de la visibilité d’un package » et « Configuration du contrôle d’accès et de la visibilité d’un package ».

S'authentifier en utilisant un personal access token

Vous devez utiliser un personal access token (classic) avec les étendues appropriées pour publier et installer des packages dans GitHub Packages. Pour plus d’informations, consultez « Introduction aux packages GitHub ».

Vous pouvez vous authentifier auprès de GitHub Packages avec npm en modifiant votre fichier ~/.npmrc spécifique à l’utilisateur pour y inclure votre personal access token (classic), ou en vous connectant à npm sur la ligne de commande en utilisant votre nom d’utilisateur et personal access token.

Pour vous authentifier en ajoutant votre personal access token (classic) à votre fichier ~/.npmrc, modifiez le fichier ~/.npmrc pour votre projet afin d'y inclure la ligne suivante, en remplaçant TOKEN par votre personal access token. Créer un nouveau fichier ~/.npmrc s’il n’existe pas.

//npm.pkg.github.com/:_authToken=TOKEN

Pour vous authentifier en vous connectant à npm, utilisez la commande npm login, en remplaçant USERNAME par votre nom d’utilisateurGitHub, TOKEN par votre personal access token (classic) et PUBLIC-EMAIL-ADDRESS par votre adresse e-mail.

Si vous utilisez l’interface CLI NPM version 9 ou ultérieure, et que vous vous connectez un registre privé ou que vous vous en déconnectez à l’aide de la ligne de commande, vous devez utiliser l’option --auth-type=legacy pour lire les détails de votre authentification à partir d’invites au lieu d’utiliser le flux de connexion par défaut via un navigateur. Pour plus d’informations, consultez npm-login.

Si GitHub Packages n’est pas votre registre de packages par défaut pour utiliser npm et que vous souhaitez utiliser la commande npm audit, nous vous recommandons d’utiliser l’indicateur --scope avec l’espace de noms qui héberge le package (le compte personnel ou l’organisation auxquels le package est délimité) lorsque vous vous authentifiez auprès de GitHub Packages.

$ npm login --scope=@NAMESPACE --auth-type=legacy --registry=https://npm.pkg.github.com

> Username: USERNAME
> Password: TOKEN

Publication d'un package

• Les noms et les étendues des packages doivent utiliser seulement des lettres minuscules.
• Le tarball d’une version npm doit être inférieur à 256 Mo.

Le registre GitHub Packages stocke les packages npm au sein de votre compte d’organisation ou personnel, et vous permet d’associer un package à un dépôt. Vous pouvez choisir d’hériter des autorisations d’un dépôt ou de définir des autorisations granulaires indépendamment d’un dépôt.

Lorsque vous publiez un package pour la première fois, la visibilité par défaut est privée. Pour modifier la visibilité ou définir les autorisations d’accès, consultez Configuration du contrôle d’accès et de la visibilité d’un package. Pour plus d’informations sur la liaison d’un package publié à un référentiel, consultez Connexion d’un dépôt à un package.

Vous pouvez connecter un package à un dépôt dès que le package est publié en incluant un champ repository dans le fichier package.json. Vous pouvez également utiliser cette méthode pour connecter plusieurs packages au même dépôt. Pour plus d’informations, consultez Publication de plusieurs packages sur le même référentiel.

Vous pouvez configurer le mappage d’étendue pour votre projet en utilisant un fichier .npmrc local dans le projet ou en utilisant l’option publishConfig dans le package.json. GitHub Packages prend en charge seulement les packages npm délimités. Les packages délimités ont des noms au format @NAMESPACE/PACKAGE-NAME. Les packages délimités commencent toujours par un symbole @. Il peut être nécessaire de mettre à jour le nom dans votre package.json pour utiliser le nom délimité. Par exemple, si vous êtes l’utilisateur octocat et que votre package s’appelle test, vous devez affecter le nom de package délimité comme suit : "name": "@octocat/test".

Après avoir publié un package, vous pouvez l'afficher sur GitHub. Pour plus d’informations, consultez « Affichage de packages ».

Publication d’un package en utilisant un fichier .npmrc local

Vous pouvez utiliser un fichier .npmrc pour configurer le mappage d’étendue pour votre projet. Dans le fichier .npmrc, utilisez l’URL et le propriétaire du compte GitHub Packages pour permettre à GitHub Packages de savoir où router les demandes de package. L’utilisation d’un fichier .npmrc empêche d’autres développeurs de publier accidentellement le package sur npmjs.org au lieu de le faire sur GitHub Packages.

1. Authentifiez-vous sur GitHub Packages. Pour plus d’informations, consultez Authentification auprès de GitHub Packages.

2. Dans le même répertoire que votre fichier package.json, créez ou modifiez un fichier .npmrc pour inclure une ligne spécifiant l’URL de GitHub Packages et l’espace de noms où le package est hébergé. Remplacez NAMESPACE par le nom du compte d’utilisateur ou d’organisation auquel le package sera délimité.

   @NAMESPACE:registry=https://npm.pkg.github.com
   

3. Ajoutez le fichier .npmrc au dépôt où GitHub Packages peut trouver votre projet. Pour plus d’informations, consultez « Ajout d’un fichier à un référentiel ».

4. Vérifiez le nom de votre package dans le package.json de votre projet. Le champ name doit contenir l’étendue et le nom du package. Par exemple, si votre package est appelé « test » et que vous le publiez sur l'organisation GitHub « My-org », le champ name de votre package.json doit être @my-org/test.

5. Vérifiez le champ repository dans le fichier package.json de votre projet. Le champ repository doit correspondre à l’URL de votre référentiel GitHub. Par exemple, si l’URL de votre référentiel est github.com/my-org/test, le champ du référentiel doit être https://github.com/my-org/test.git.

6. Publiez le package :

   npm publish
   

Publication d’un package en utilisant publishConfig dans le fichier package.json

Vous pouvez utiliser l’élément publishConfig dans le fichier package.json pour spécifier le registre où vous voulez que le package soit publié. Pour plus d’informations, consultez publishConfig dans la documentation npm.

1. Modifiez le fichier package.json pour votre package et incluez-y une entrée publishConfig.

   "publishConfig": {
     "registry": "https://npm.pkg.github.com"
   },
   

2. Vérifiez le champ repository dans le fichier package.json de votre projet. Le champ repository doit correspondre à l’URL de votre référentiel GitHub. Par exemple, si l’URL de votre référentiel est github.com/my-org/test, le champ du référentiel doit être https://github.com/my-org/test.git.

3. Publiez le package :

   npm publish
   

Publication de plusieurs packages sur le même référentiel

Pour publier plusieurs packages et les lier sur le même dépôt, vous pouvez inclure l’URL du dépôt GitHub dans le champ repository du fichier package.json pour chaque package. Pour plus d’informations, consultez Création d’un fichier package.json et Création de modules Node.js dans la documentation npm.

Pour garantir que l’URL du dépôt est correcte, remplacez REPOSITORY par le nom du dépôt contenant le package que vous voulez publier, et OWNER par le nom du compte personnel ou de l’organisation sur GitHub qui est propriétaire du dépôt.

GitHub Packages établira une correspondance avec le dépôt en fonction de l’URL.

"repository":"https://github.com/OWNER/REPOSITORY",

Installation d’un package

Vous pouvez installer des packages depuis GitHub Packages en ajoutant les packages en tant que dépendances dans le fichier package.json pour votre projet. Pour plus d’informations sur l’utilisation d’un fichier package.json dans votre projet, consultez Utilisation d’un package.json dans la documentation npm.

Par défaut, vous pouvez ajouter des packages provenant d’une seule organisation. Pour plus d’informations, consultez Installation de packages provenant d’autres organisations.

Vous devez aussi ajouter le fichier .npmrc à votre projet afin que toutes les demandes d’installation de packages passent par GitHub Packages. Quand vous routez toutes les demandes de package via GitHub Packages, vous pouvez utiliser à la fois des packages délimités et des packages non délimités provenant de npmjs.org. Pour en savoir plus, consultez npm-scopedans la documentation npm.

1. Authentifiez-vous sur GitHub Packages. Pour plus d’informations, consultez Authentification auprès de GitHub Packages.

2. Dans le même répertoire que votre fichier package.json, créez ou modifiez un fichier .npmrc pour inclure une ligne spécifiant l’URL de GitHub Packages et l’espace de noms où le package est hébergé. Remplacez NAMESPACE par le nom du compte d’utilisateur ou d’organisation auquel le package sera délimité.

   @NAMESPACE:registry=https://npm.pkg.github.com
   

3. Ajoutez le fichier .npmrc au dépôt où GitHub Packages peut trouver votre projet. Pour plus d’informations, consultez « Ajout d’un fichier à un référentiel ».

4. Configurez package.json dans votre projet afin d’utiliser le package que vous installez. Pour ajouter vos dépendances de package au fichier package.json pour GitHub Packages, spécifiez le nom du package entièrement délimité, comme @my-org/server. Pour les packages provenant de npmjs.com, spécifiez le nom complet, comme @babel/core ou lodash. Remplacez ORGANIZATION_NAME/PACKAGE_NAME par votre dépendance de package.

   {
     "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"
     }
   }
   

5. Installez le package.

   npm install
   

Installation de packages provenant d’autres organisations

Par défaut, vous pouvez seulement utiliser des packages GitHub Packages provenant d’une seule organisation. Si vous souhaitez acheminer les demandes de package vers plusieurs organisations et utilisateurs, vous pouvez ajouter des lignes supplémentaires à votre fichier .npmrc, en remplaçant NAMESPACE par le nom du compte personnel ou de l'organisation auxquels le package est délimité.

@NAMESPACE:registry=https://npm.pkg.github.com
@NAMESPACE:registry=https://npm.pkg.github.com