Gérer les packages npm

Alpha

Ce produit ou cette fonctionnalité est couvert par les Conditions des offres avant disponibilité générale des conditions d'utilisation de Google Cloud Platform. Les fonctionnalités et produits avant disponibilité générale sont susceptibles de présenter une compatibilité limitée, et les modifications apportées à ces fonctionnalités ou produits peuvent ne pas être compatibles avec d'autres versions avant disponibilité générale. Pour en savoir plus, consultez les descriptions des étapes de lancement.

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

La gestion des packages est disponible en version alpha. Elle n'est disponible que pour les utilisateurs alpha et peut ne pas inclure toutes les fonctionnalités disponibles pour la gestion des conteneurs. Pour demander à participer à la version alpha, remplissez le formulaire d'inscription.

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.

Ajouter des packages

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 identique. 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

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 présente un package dont le champ d'application est dev-repo.

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

2. Actualisez le jeton d'accès pour vous connecter au dépôt. google-artifactregistry-auth est une bibliothèque cliente qui met à jour les identifiants pour les dépôts Artifact Registry.

   Pour actualiser les identifiants, utilisez l'une des options suivantes :

   • Utilisez npx directement pour actualiser le jeton d'accès. Si vous utilisez npm 5.2.0 ou une version ultérieure, il est inclus dans npm.

     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 dossier situé au-dessus de votre projet npm.

     npx google-artifactregistry-auth PROJECT-NPMRC
     

     Où PROJECT-NPMRC est le chemin d'accès au fichier .npmrc dans le répertoire de votre projet.

     Vous devez exécuter la commande en dehors du répertoire de votre projet pour que npx utilise vos identifiants de registre npm public dans ~/.npmrc pour télécharger google-artifactregistry-auth.

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

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

     npm run artifactregistry-login PROJECT-NPMRC --registry https://registry.npmjs.org/
     

     Où PROJECT-NPMRC est le chemin d'accès au fichier .npmrc dans le répertoire de votre projet.

   • Pour les versions de npm antérieures à 5.2.0, procédez comme suit :

     1. Exécutez la commande suivante :

     npm install google-artifactregistry-auth --save-dev --registry https://registry.npmjs.org/
     

     1. Ajoutez-la à un script d'authentification :

     "scripts": {
         "artifactregistry-login": "./node_modules/.bin/artifactregistry-auth",
     }
     

     Exécuter le script

     npm run artifactregistry-login PROJECT-NPMRC
     

     Où PROJECT-NPMRC est le chemin d'accès au fichier .npmrc dans le répertoire de votre projet.

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

   npm publish
   

   yarn publish
   

Afficher des packages et des versions

Pour obtenir des informations sur le package avec npm ou yarn, exécutez la commande appropriée :

npm view

yarn info

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

Console

1. Ouvrez la page Dépôts dans Google Cloud Console.

   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 du package 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.

Ajout de tags aux packages

Vous pouvez ainsi afficher, ajouter, mettre à jour et supprimer des tags.

Afficher des tags

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

Console

1. Ouvrez la page Dépôts dans Cloud Console.

   Ouvrir la page "Dépôts"

2. Cliquez sur le package pour afficher les versions et les tags associés.

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 un tag 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 dans Cloud Console.

   Ouvrir la page "Dépôts"

2. Cliquez dessus pour afficher les versions du package.

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 le tag 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 un tag associé à une version du package.

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

Console

1. Ouvrez la page Dépôts dans Cloud Console.

   Ouvrir la page "Dépôts"

2. Cliquez dessus pour afficher les versions du package.

3. Sélectionnez la version du package contenant le tag à 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 le tag 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 un tag existant dans une version de package.

Pour supprimer un tag, procédez comme suit :

Console

1. Ouvrez la page Dépôts dans Cloud Console.

   Ouvrir la page "Dépôts"

2. Cliquez sur l'image pour voir les versions de l'image.

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 le tag 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

Pour installer un package à partir du dépôt npm, utilisez la commande npm install ou yarn add.

npm install @SCOPE/PACKAGE

yarn add @SCOPE/PACKAGE

Où :

• SCOPE est le champ d'application associé au dépôt.
• PACKAGE est le nom du package dans le dépôt.

Si votre dépôt npm n'est pas configuré avec un champ d'application, omettez le champ d'application dans la commande :

npm install PACKAGE

yarn add PACKAGE

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

Supprimer des packages

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.

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 identique.

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.

Pour supprimer un package, procédez comme suit :

Console

1. Ouvrez la page Dépôts dans Google Cloud Console.

   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ù :

• 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 dans Google Cloud Console.

   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 \
    [--repository=REPOSITORY] [--location=LOCATION] [--async]

Où :

• 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 le résultat, sans attendre la fin de l'opération en cours.

Étape suivante

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