Gérer les packages Node.js

Cette page décrit les tâches suivantes :

• Afficher et supprimer des packages et des versions de packages
• Afficher, créer, mettre à jour et supprimer des tags

Avant de commencer

1. Si le dépôt cible n'existe pas, créez un dépôt.
2. Vérifiez que vous disposez des autorisations requises pour le dépôt.
3. Configurez l'authentification pour npm.
4. (Facultatif) Configurez des valeurs par défaut pour les commandes gcloud.
5. Si vous utilisez l'assistant d'identification npm pour l'authentification, procurez-vous un jeton d'accès avant de vous connecter à un dépôt avec npm.

Rôles requis

Pour obtenir les autorisations dont vous avez besoin pour gérer les packages, demandez à votre administrateur de vous attribuer les rôles IAM suivants sur le dépôt:

• Affichez les packages, les fichiers dans les packages et les tags : Lecteur Artifact Registry (roles/artifactregistry.reader)
• Téléchargez ou installez des packages : Lecteur Artifact Registry (roles/artifactregistry.reader)
• Ajoutez des packages à un dépôt : Artifact Registry Writer (roles/artifactregistry.writer)
• Supprimer les packages : Administrateur de dépôt Artifact Registry (roles/artifactregistry.repoAdmin)

Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

Obtenir un jeton d'accès

Les jetons d'accès sont valides pendant 60 minutes. Générez un jeton d'accès peu de temps avant d'exécuter des commandes qui interagissent avec les dépôts.

Pour obtenir un jeton, utilisez l'une des options suivantes:

• Utilisez la commande npx pour actualiser le jeton d'accès.

  1. Assurez-vous que les identifiants de connexion au registre npm public se trouvent dans votre fichier de configuration npm d'utilisateur ~/.npmrc.

  2. Exécutez la commande suivante dans le répertoire de votre projet Node.js.

     npx google-artifactregistry-auth
     

     Si votre dépôt Artifact Registry est défini comme registre global et que le champ d'application de vos packages n'est pas défini, utilisez plutôt la commande suivante afin qu'elle puisse télécharger l'assistant d'identification à partir du registre npm public plutôt que depuis votre dépôt Artifact Registry.

     npm_config_registry=https://registry.npmjs.org npx google-artifactregistry-auth
     

• Ajoutez un script au fichier package.json dans votre projet.

  "scripts": {
   "artifactregistry-login": "npx google-artifactregistry-auth"
  }
  

  Exécutez le script dans le répertoire de votre projet Node.js.

  npm run artifactregistry-login
  

Artifact Registry lit les paramètres du dépôt Artifact Registry dans le fichier .npmrc de votre projet et les utilise pour ajouter des identifiants de jeton au fichier .npmrc de votre utilisateur. Le stockage du jeton dans votre fichier utilisateur .npmrc isole vos identifiants de votre code source et de votre système de contrôle des sources.

Ajouter des packages

Modes de dépôt: standard

Vous ne pouvez publier une version spécifique d'un package qu'une seule fois. Il s'agit d'une restriction npm pour garantir que le contenu d'une version de package publiée est toujours le même. Par conséquent, vous ne pouvez pas :

• Écraser une version de package en la republiant dans le dépôt
• Supprimer un package ou sa version du dépôt, puis publier un package portant le même nom et le même numéro de version

Si vous ne spécifiez pas de balise lorsque vous publiez un package, npm ajoute la balise latest. Pour simplifier l'installation de vos packages à une étape de développement spécifique, envisagez de les publier avec une balise telle que beta ou dev.

Artifact Registry applique les noms de package alphanumériques en minuscules pour les packages npm.

Pour ajouter un package :

1. Assurez-vous que le nom du package dans package.json inclut le champ d'application configuré pour votre dépôt. L'exemple suivant montre un package avec le niveau d'accès dev-repo.

   "name": "@dev-repo/my-package"
   

2. Si vous utilisez l'assistant d'identification pour vous authentifier avec un jeton d'accès, procurez-vous un nouveau jeton.

3. Ajoutez des packages au dépôt. Vous pouvez utiliser une commande npm ou yarn.

   Pour ajouter un tag au package, incluez l'option --tag et remplacez TAG par la balise que vous souhaitez utiliser. Si vous n'incluez pas l'indicateur --tag, npm définit automatiquement le tag sur latest.

   npm publish --tag=TAG
   

   yarn publish --tag TAG
   

Afficher des packages et des versions

Modes de dépôt:standard, distant, virtuel

Pour obtenir des informations sur un package avec npm ou yarn, procédez comme suit:

1. Si vous utilisez l'assistant d'identification pour vous authentifier avec un jeton d'accès, procurez-vous un nouveau jeton.

2. Exécutez la commande appropriée:

   npm view
   

   yarn info
   

Pour afficher des packages et des versions de package à l'aide de la console Google Cloud ou de gcloud, procédez comme suit:

Console

1. Ouvrez la page Dépôts de la console Google Cloud.

   Ouvrir la page "Dépôts"

2. Dans la liste des dépôts, cliquez sur le dépôt approprié.

   La page Packages répertorie les packages du dépôt.

3. Cliquez sur un package pour afficher ses versions.

gcloud

Pour répertorier les packages d'un dépôt, exécutez la commande suivante :

gcloud artifacts packages list [--repository=REPOSITORY] [--location=LOCATION]

Où

• REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.
• LOCATION est un emplacement régional ou multirégional. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.

Pour afficher les versions d'un package, exécutez la commande suivante :

gcloud artifacts versions list --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION]

Où :

• PACKAGE est l'ID ou l'identifiant complet du package.
• REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cet indicateur pour utiliser le dépôt par défaut.
• LOCATION est un emplacement régional ou multirégional. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.

L'affichage des packages et des versions à partir de la console Google Cloud ou de gcloud CLI n'est disponible que pour les dépôts standards et distants.

Pour les dépôts distants, la liste renvoyée doit inclure toutes les dépendances directes et transitives mises en cache dans le dépôt.

Répertorier les fichiers

Modes de dépôt:standard, distant

Vous pouvez répertorier les fichiers d'un dépôt, les fichiers de toutes les versions d'un package spécifié ou les fichiers d'une version spécifique d'un package.

Pour toutes les commandes suivantes, vous pouvez définir un nombre maximal de fichiers à renvoyer en ajoutant l'option --limit à la commande.

Pour répertorier tous les fichiers du projet, du dépôt et de l'emplacement par défaut lorsque les valeurs par défaut sont configurées:

gcloud artifacts files list

Pour répertorier les fichiers dans un projet, un dépôt et un emplacement spécifiés, exécutez la commande suivante:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION

Pour répertorier les fichiers de toutes les versions d’un package spécifique:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE

Pour répertorier les fichiers d'une version de package spécifique:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE \
    --version=VERSION

Pour répertorier les fichiers d'une balise spécifique:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE \
    --tag=TAG

Remplacez les valeurs suivantes :

• LOCATION est l'emplacement régional ou multirégional du dépôt.
• PROJECT est l'ID du projet Google Cloud. Si l'ID du projet contient le signe deux-points (:), consultez la section Projets à l'échelle du domaine.
• REPOSITORY est le nom du dépôt où l'image est stockée.
• PACKAGE est le nom du package.
• VERSION est la version du package.
• TAG est la balise associée au package.

Examples

Examinez les informations sur le package suivantes:

• Projet : my-project
• Dépôt: my-repo
• Emplacement du dépôt : us-central1
• Colis: my-app

La commande suivante permet de lister tous les fichiers du dépôt my-repo à l'emplacement us-central1 dans le projet par défaut:

gcloud artifacts files list \
    --location=us-central1 \
    --repository=my-repo

La commande suivante répertorie les fichiers dans la version 1.0 du package.

gcloud artifacts files list \
    --project=my-project \
    --location=us-central1 \
    --repository=my-repo \
    --package=my-app \
    --version=1.0

La commande suivante répertorie les fichiers de la version du package avec le tag 1.0-dev.

gcloud artifacts files list \
    --project=my-project \
    --location=us-central1 \
    --repository=my-repo \
    --package=my-app \
    --tag=1.0-dev

Ajout de tags aux packages

Modes de dépôt: standard

Vous pouvez afficher, ajouter, mettre à jour et supprimer des tags. Les tags peuvent vous aider à gérer les versions sémantiques de vos packages et à simplifier leur installation à un stade spécifique du développement.

Par exemple, vous pouvez ajouter le tag rc à la version candidate actuelle. Votre équipe peut ensuite installer la version appropriée en fonction de la balise au lieu d'un spécificateur de version. L'annulation de la publication des versions préliminaires inutilisées n'a pas d'incidence sur vos dépendances sur le package de version finale.

Afficher des tags

Pour afficher les tags d'un package, procédez comme suit :

Console

1. Ouvrez la page Dépôts de la console Google Cloud.

   Ouvrir la page "Dépôts"

2. Cliquez sur le package pour afficher les versions et les balises associées.

3. Sélectionnez la version du package à taguer.

4. Sur la ligne de la version sélectionnée, cliquez sur Autres actions (), puis sur Modifier les tags.

5. Saisissez de nouveaux tags dans le champ, puis cliquez sur ENREGISTRER.

gcloud

Exécutez la commande suivante :

gcloud artifacts tags list --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION]

Où :

• PACKAGE est le nom du package dans le dépôt.
• REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cet indicateur pour utiliser le dépôt par défaut.
• LOCATION est un emplacement régional ou multirégional. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.

Par exemple, pour afficher les tags du package my-package dans le dépôt my-repo à l'emplacement par défaut, exécutez la commande suivante:

gcloud artifacts tags list --package=my-pkg --repository=my-repo

Créer des tags

Vous pouvez créer une balise pour une version spécifique d'un package.

Pour ajouter un tag à une image existante d'un dépôt, procédez comme suit :

Console

1. Ouvrez la page Dépôts de la console Google Cloud.

   Ouvrir la page "Dépôts"

2. Cliquez sur le package pour en afficher les versions.

3. Sélectionnez la version du package à taguer.

4. Sur la ligne de la version sélectionnée, cliquez sur Autres actions (), puis sur Modifier les tags.

5. Saisissez de nouveaux tags dans le champ, puis cliquez sur ENREGISTRER.

gcloud

Exécutez la commande suivante :

gcloud artifacts tags create TAG --package=PACKAGE \
    version=VERSION [--location=LOCATION] [--repository=REPOSITORY]

Où :

• TAG est la balise que vous souhaitez appliquer au package.
• PACKAGE est le nom du package dans le dépôt.
• VERSION est la version du package que vous souhaitez taguer.
• LOCATION est un emplacement régional ou multirégional. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.
• REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cet indicateur pour utiliser le dépôt par défaut.

Par exemple, pour créer le tag release-candidate pour la version 1.0.0 du package my-package dans le dépôt my-repo à l'emplacement par défaut, exécutez la commande suivante :

gcloud artifacts tags create release-candidate --version=1.0.0 \
    --package=my-pkg --repository=my-repo

Mettre à jour des tags

Vous pouvez modifier une balise associée à une version de package.

Pour modifier un tag existant, procédez comme suit :

Console

1. Ouvrez la page Dépôts de la console Google Cloud.

   Ouvrir la page "Dépôts"

2. Cliquez sur le package pour en afficher les versions.

3. Sélectionnez la version du package contenant la balise à modifier.

4. Sur la ligne de la version sélectionnée, cliquez sur Autres actions (), puis sur Modifier les tags.

5. Modifiez le tag, puis cliquez sur ENREGISTRER.

gcloud

Exécutez la commande suivante :

gcloud artifacts tags update TAG --package=PACKAGE \
    version=VERSION [--location=LOCATION] [--repository=REPOSITORY]

Où :

• TAG est la balise que vous souhaitez appliquer au package.
• PACKAGE est le nom du package dans le dépôt.
• VERSION est la version du package que vous souhaitez taguer.
• LOCATION est un emplacement régional ou multirégional. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.
• REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cet indicateur pour utiliser le dépôt par défaut.

Par exemple, pour remplacer le tag de la version 1.0.0 du package my-package par production dans le dépôt my-repo à l'emplacement par défaut, exécutez la commande suivante:

gcloud artifacts tags update production --version=1.0.0 \
    --package=my-pkg --repository=my-repo

Annuler l'ajout de tags sur les versions du package

Vous pouvez supprimer une balise existante d'une version de package.

Pour supprimer un tag, procédez comme suit :

Console

1. Ouvrez la page Dépôts de la console Google Cloud.

   Ouvrir la page "Dépôts"

2. Cliquez sur l'image pour en afficher les différentes versions.

3. Sélectionnez la version de l'image pour supprimer le tag.

4. Sur la ligne de la version sélectionnée, cliquez sur Autres actions (), puis sur Modifier les tags.

5. Supprimez le tag, puis cliquez sur ENREGISTRER.

gcloud

Exécutez la commande suivante :

gcloud artifacts tags delete TAG --package=PACKAGE \
    [--location=<LOCATION] [--repository=REPOSITORY]

Où :

• TAG est la balise que vous souhaitez appliquer au package.
• PACKAGE est le nom du package dans le dépôt.
• LOCATION est un emplacement régional ou multirégional. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.
• REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cet indicateur pour utiliser le dépôt par défaut.

Par exemple, pour supprimer le tag release-candidate du package my-package du dépôt my-repo à l'emplacement par défaut, exécutez la commande suivante:

gcloud artifacts tags delete release-candidate --package=my-pkg \
    --repository=my-repo

Installer des packages

Modes de dépôt:standard, distant, virtuel

Pour installer un package à partir du dépôt de packages Node.js:

1. Si vous utilisez l'assistant d'identification pour vous authentifier avec un jeton d'accès, procurez-vous un nouveau jeton.

2. Exécutez la commande npm install ou yarn add.

   npm

   Pour installer la version avec la balise latest, procédez comme suit:

   npm install @SCOPE/PACKAGE
   

   Pour installer la version avec une autre balise:

   npm install @SCOPE/PACKAGE@TAG
   

   Pour installer une version spécifique:

   npm install @SCOPE/PACKAGE@VERSION
   

   yarn

   Pour installer la version avec la balise latest, procédez comme suit:

   yarn add @SCOPE/PACKAGE
   

   Pour installer la version avec une autre balise:

   yarn add @SCOPE/PACKAGE@TAG
   

   Pour installer une version spécifique:

   yarn add @SCOPE/PACKAGE@VERSION
   

   Remplacez les valeurs suivantes :

   • SCOPE est le champ d'application associé au dépôt. Si votre dépôt de packages Node.js n'est pas configuré avec un champ d'application, omettez @SCOPE/ dans la commande.
   • PACKAGE est le nom du package dans le dépôt.
   • TAG est la balise de la version que vous souhaitez installer.
   • VERSION correspond au numéro de version que vous souhaitez installer.

Lorsque vous spécifiez un package en tant que dépendance dans package.json, veillez à inclure le champ d'application du dépôt. L'exemple suivant montre le champ d'application @dev-repo d'un package nommé my-package.

"dependencies": {
  "@dev-repo/my-package": ">=1.0.0"
}

Pour les dépôts standards, vous téléchargez un package directement à partir du dépôt.

Pour un dépôt distant, vous téléchargez une copie mise en cache du package et de ses dépendances. S'il n'existe aucune copie en cache, le dépôt distant télécharge le package depuis la source en amont et le met en cache avant de vous le diffuser. Vous pouvez vérifier que le dépôt distant a récupéré les packages depuis la source en amont en affichant la liste des packages dans le dépôt.

Pour un dépôt virtuel, Artifact Registry recherche le package demandé dans les dépôts en amont.

• Les dépôts distants en amont téléchargent et mettent en cache le package demandé si aucune copie mise en cache n'existe. Les dépôts virtuels ne diffusent que les packages demandés, ils ne les stockent pas.
• Si vous demandez une version disponible dans plusieurs dépôts en amont, Artifact Registry choisit un dépôt en amont à utiliser en fonction des paramètres de priorité configurés pour le dépôt virtuel.

Prenons l'exemple d'un dépôt virtuel avec les paramètres de priorité suivants pour les dépôts en amont:

• main-repo: priorité définie sur 100
• secondary-repo1: priorité définie sur 80.
• secondary-repo2: priorité définie sur 80.
• test-repo: priorité définie sur 20.

main-repo a la valeur de priorité la plus élevée. Le dépôt virtuel le recherche toujours en premier.

La priorité de secondary-repo1 et secondary-repo2 est définie sur 80. Si un package demandé n'est pas disponible dans main-repo, Artifact Registry recherche ensuite ces dépôts. Étant donné qu'ils ont tous deux la même valeur de priorité, Artifact Registry peut choisir de diffuser un package à partir de l'un ou l'autre des dépôts si la version est disponible dans les deux.

test-repo a la valeur de priorité la plus faible et diffuse un artefact stocké si aucun des autres dépôts en amont ne l'inclut.

Supprimer des packages

Modes de dépôt:standard, distant

Vous pouvez supprimer un package et toutes ses versions, ou supprimer une version spécifique.

• La suppression d'un package est irréversible.
• Pour les dépôts distants, seule la copie mise en cache du package est supprimée. La source en amont n'est pas affectée. Si vous supprimez un package mis en cache, Artifact Registry le téléchargera et le mettra à nouveau en cache la prochaine fois que le dépôt recevra une requête pour la même version de package.

Une fois la version de package publiée, vous ne pouvez pas republier un package du même nom et de la même version, même après la suppression de la version. Il s'agit d'une restriction npm pour garantir que le contenu d'une version de package publiée est toujours le même.

Si vous souhaitez encourager les utilisateurs à installer une version mise à jour du package, exécutez la commande npm deprecate pour marquer l'ancienne version du package comme étant obsolète. Lorsqu'un utilisateur tente d'installer le package obsolète, Artifact Registry renvoie un avertissement d'obsolescence.

Avant de supprimer un package ou une version de package, vérifiez que vous avez communiqué ou résolu toute dépendance importante associée.

Pour supprimer un package, procédez comme suit :

Console

1. Ouvrez la page Dépôts de la console Google Cloud.

   Ouvrir la page "Dépôts"

2. Dans la liste des dépôts, cliquez sur le dépôt approprié.

   La page Packages répertorie les packages du dépôt.

3. Sélectionnez le package que vous souhaitez supprimer.

4. Cliquez sur SUPPRIMER.

5. Dans la boîte de dialogue de confirmation, cliquez sur SUPPRIMER.

gcloud

Exécutez la commande suivante :

gcloud artifacts packages delete PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] [--async]

Où

• PACKAGE est le nom du package dans le dépôt.
• REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cet indicateur pour utiliser le dépôt par défaut.
• LOCATION est un emplacement régional ou multirégional. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.
• --async renvoie immédiatement une réponse, sans attendre la fin de l'opération en cours.

Pour supprimer des versions d'un package, procédez comme suit :

Console

1. Ouvrez la page Dépôts de la console Google Cloud.

   Ouvrir la page "Dépôts"

2. Dans la liste des dépôts, cliquez sur le dépôt approprié.

   La page Packages répertorie les packages du dépôt.

3. Cliquez sur un package pour afficher ses versions.

4. Sélectionnez les versions que vous souhaitez supprimer.

5. Cliquez sur SUPPRIMER.

6. Dans la boîte de dialogue de confirmation, cliquez sur SUPPRIMER.

gcloud

Exécutez la commande suivante :

gcloud artifacts versions delete VERSION \
    --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] \
    [--async]

Où

• PACKAGE est le nom du package dans le dépôt.
• REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cet indicateur pour utiliser le dépôt par défaut.
• LOCATION est un emplacement régional ou multirégional. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.
• --async est immédiatement renvoyé, sans attendre la fin de l'opération en cours.

Étapes suivantes

• En savoir plus sur la gestion des packages Maven
• En savoir plus sur la gestion des images de conteneurs