Partager via


Npm@1 - tâche npm v1

Utilisez cette tâche pour installer et publier des packages npm ou pour exécuter une npm commande. Prend en charge npmjs.com et les registres authentifiés comme Azure Artifacts.

Notes

La tâche d’authentification npm est la méthode recommandée pour s’authentifier auprès d’Azure Artifacts. Cette tâche ne se verra plus ajouter de nouvelles fonctionnalités et seuls les bogues critiques sont traités.

Syntax

# npm v1
# Install and publish npm packages, or run an npm command. Supports npmjs.com and authenticated registries like Azure Artifacts.
- task: Npm@1
  inputs:
    command: 'install' # 'ci' | 'install' | 'publish' | 'custom'. Required. Command. Default: install.
    #workingDir: # string. Working folder that contains package.json. 
    #customCommand: # string. Required when command = custom. Command and arguments. 
  # Advanced
    #verbose: # boolean. Optional. Use when command = install || command = ci || command = publish. Verbose logging. 
    #publishPackageMetadata: true # boolean. Optional. Use when command = publish && publishRegistry = useFeed && command = install || command = ci || command = publish. Publish pipeline metadata. Default: true.
  # Custom registries and authentication
    #customRegistry: 'useNpmrc' # 'useNpmrc' | 'useFeed'. Optional. Use when command = install || command = ci || command = custom. Registries to use. Default: useNpmrc.
    #customFeed: # string. Required when customRegistry = useFeed && command = install || command = ci || command = custom. Use packages from this Azure Artifacts/TFS registry. 
    #customEndpoint: # string. Optional. Use when customRegistry = useNpmrc && command = install || command = ci || command = custom. Credentials for registries outside this organization/collection. 
  # Destination registry and authentication
    #publishRegistry: 'useExternalRegistry' # 'useExternalRegistry' | 'useFeed'. Optional. Use when command = publish. Registry location. Default: useExternalRegistry.
    #publishFeed: # string. Required when publishRegistry = useFeed && command = publish. Target registry. 
    #publishEndpoint: # string. Required when publishRegistry = useExternalRegistry && command = publish. External Registry.
# npm v1
# Install and publish npm packages, or run an npm command. Supports npmjs.com and authenticated registries like Azure Artifacts.
- task: Npm@1
  inputs:
    command: 'install' # 'install' | 'publish' | 'custom'. Required. Command. Default: install.
    #workingDir: # string. Working folder that contains package.json. 
    #customCommand: # string. Required when command = custom. Command and arguments. 
  # Advanced
    #verbose: # boolean. Optional. Use when command = install || command = publish. Verbose logging. 
    #publishPackageMetadata: true # boolean. Optional. Use when command = publish && publishRegistry = useFeed && command = install || command = publish. Publish pipeline metadata. Default: true.
  # Custom registries and authentication
    #customRegistry: 'useNpmrc' # 'useNpmrc' | 'useFeed'. Optional. Use when command = install || command = custom. Registries to use. Default: useNpmrc.
    #customFeed: # string. Required when customRegistry = useFeed && command = install || command = custom. Use packages from this Azure Artifacts/TFS registry. 
    #customEndpoint: # string. Optional. Use when customRegistry = useNpmrc && command = install || command = custom. Credentials for registries outside this organization/collection. 
  # Destination registry and authentication
    #publishRegistry: 'useExternalRegistry' # 'useExternalRegistry' | 'useFeed'. Optional. Use when command = publish. Registry location. Default: useExternalRegistry.
    #publishFeed: # string. Required when publishRegistry = useFeed && command = publish. Target registry. 
    #publishEndpoint: # string. Required when publishRegistry = useExternalRegistry && command = publish. External Registry.
# npm v1
# Install and publish npm packages, or run an npm command. Supports npmjs.com and authenticated registries like Package Management.
- task: Npm@1
  inputs:
    command: 'install' # 'install' | 'publish' | 'custom'. Required. Command. Default: install.
    #workingDir: # string. Working folder with package.json. 
    #customCommand: # string. Required when command = custom. Command and arguments. 
  # Advanced
    #verbose: # boolean. Optional. Use when command = install || command = publish. Verbose logging. 
  # Custom registries and authentication
    #customRegistry: 'useNpmrc' # 'useNpmrc' | 'useFeed'. Optional. Use when command = install || command = custom. Registries to use. Default: useNpmrc.
    #customFeed: # string. Required when customRegistry = useFeed && command = install || command = custom. Use packages from this Azure Artifacts/TFS registry. 
    #customEndpoint: # string. Optional. Use when customRegistry = useNpmrc && command = install || command = custom. Credentials for registries outside this account/collection. 
  # Destination registry and authentication
    #publishRegistry: 'useExternalRegistry' # 'useExternalRegistry' | 'useFeed'. Optional. Use when command = publish. Registry location. Default: useExternalRegistry.
    #publishFeed: # string. Required when publishRegistry = useFeed && command = publish. Target registry. 
    #publishEndpoint: # string. Required when publishRegistry = useExternalRegistry && command = publish. External Registry.

Entrées

command - Commande
string. Obligatoire. Valeurs autorisées : ci, install, publish, custom. Valeur par défaut : install.

Spécifie la commande et les arguments, qui sont passés à npm pour exécution.

Si vos arguments contiennent des guillemets doubles ("), placez-les dans une séquence d’échappement avec une barre oblique (\) et entourez la chaîne d’échappement de guillemets doubles (").


command - Commande
string. Obligatoire. Valeurs autorisées : install, publish, custom. Valeur par défaut : install.

Spécifie la commande et les arguments, qui sont passés à npm pour exécution.

Si vos arguments contiennent des guillemets doubles ("), placez-les dans une séquence d’échappement avec une barre oblique (\) et entourez la chaîne d’échappement de guillemets doubles (").


workingDir - Dossier de travail contenant package.json
string.

Spécifie le chemin d’accès au dossier contenant la cible package.json et les .npmrc fichiers. Sélectionnez le dossier, pas le fichier. Exemple : /packages/mypackage.


workingDir - Dossier de travail avec package.json
string.

Spécifie le chemin d’accès au dossier contenant la cible package.json et les .npmrc fichiers. Sélectionnez le dossier, pas le fichier. Exemple : /packages/mypackage.


verbose - Journalisation détaillée
boolean. facultatif. Utilisez quand command = install || command = ci || command = publish.

Imprime plus d’informations sur la console lorsque la tâche s’exécute.


verbose - Journalisation détaillée
boolean. facultatif. Utilisez quand command = install || command = publish.

Imprime plus d’informations sur la console lorsque la tâche s’exécute.


customCommand - Commande et arguments
string. Nécessaire lorsque command = custom.

Exécute une commande personnalisée. Exemple : dist-tag ls mypackage.


customRegistry - Registres à utiliser
string. facultatif. Utilisez quand command = install || command = ci || command = custom. Valeurs autorisées : useNpmrc (Registres dans mon fichier .npmrc), useFeed (Registre que je sélectionne ici). Valeur par défaut : useNpmrc.

Spécifie les registres à utiliser. Validez un .npmrc fichier dans votre référentiel de code source et définissez son chemin comme valeur, ou spécifiez un registre à partir d’Azure Artifacts comme valeur.


customRegistry - Registres à utiliser
string. facultatif. Utilisez quand command = install || command = custom. Valeurs autorisées : useNpmrc (Registres dans mon fichier .npmrc), useFeed (Registre que je sélectionne ici). Valeur par défaut : useNpmrc.

Spécifie les registres à utiliser. Validez un .npmrc fichier dans votre référentiel de code source et définissez son chemin comme valeur, ou spécifiez un registre à partir d’Azure Artifacts comme valeur.


customFeed - Utiliser des packages de ce registre Azure Artifacts/TFS
string. Nécessaire lorsque customRegistry = useFeed && command = install || command = ci || command = custom.

Inclut le flux sélectionné dans le généré .npmrc. Pour les flux délimités au projet, utilisez ProjectName/FeedName ou ProjectID/FeedID. Pour les flux organization délimités, la valeur doit être le nom du flux.


customFeed - Utiliser des packages de ce registre Azure Artifacts/TFS
string. Nécessaire lorsque customRegistry = useFeed && command = install || command = custom.

Inclut le flux sélectionné dans le généré .npmrc. Pour les flux délimités au projet, utilisez ProjectName/FeedName ou ProjectID/FeedID. Pour les flux organization délimités, la valeur doit être le nom du flux.


customEndpoint - Informations d’identification pour les registres en dehors de cette organization/collection
string. facultatif. Utilisez quand customRegistry = useNpmrc && command = install || command = ci || command = custom.

Informations d’identification à utiliser pour les registres externes situés dans le projet ..npmrc Laissez ce champ vide pour les registres de ce compte/collection ; la tâche utilise automatiquement les informations d’identification de la build.


customEndpoint - Informations d’identification pour les registres en dehors de cette organization/collection
string. facultatif. Utilisez quand customRegistry = useNpmrc && command = install || command = custom.

Informations d’identification à utiliser pour les registres externes situés dans le projet ..npmrc Laissez ce champ vide pour les registres de ce compte/collection ; la tâche utilise automatiquement les informations d’identification de la build.


customEndpoint - Informations d’identification pour les registres en dehors de ce compte/collection
string. facultatif. Utilisez quand customRegistry = useNpmrc && command = install || command = custom.

Informations d’identification à utiliser pour les registres externes situés dans le projet ..npmrc Laissez ce champ vide pour les registres de ce compte/collection ; la tâche utilise automatiquement les informations d’identification de la build.


publishRegistry - Emplacement du Registre
string. facultatif. Utilisez quand command = publish. Valeurs autorisées : useExternalRegistry (Registre npm externe (y compris d’autres comptes/collections)), useFeed (Registre que je sélectionne ici). Valeur par défaut : useExternalRegistry.

Spécifie le registre que la commande ciblera.


publishFeed - Registre cible
string. Nécessaire lorsque publishRegistry = useFeed && command = publish.

Spécifie un registre hébergé dans le compte. La gestion des packages doit être installée et concédée sous licence pour sélectionner un registre ici.


publishPackageMetadata - Publier des métadonnées de pipeline
boolean. facultatif. Utilisez quand command = publish && publishRegistry = useFeed && command = install || command = ci || command = publish. Valeur par défaut : true.

Associe les métadonnées du pipeline de build/mise en production (le numéro d’exécution et les informations de code source) au package.


publishPackageMetadata - Publier des métadonnées de pipeline
boolean. facultatif. Utilisez quand command = publish && publishRegistry = useFeed && command = install || command = publish. Valeur par défaut : true.

Associe les métadonnées du pipeline de build/mise en production (le numéro d’exécution et les informations de code source) au package.


publishEndpoint - Registre externe
string. Nécessaire lorsque publishRegistry = useExternalRegistry && command = publish.

Spécifie les informations d’identification à utiliser pour la publication dans un registre externe.


Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Notes

Vous devez définir l’identité du Service de build de collection de projets et du Service de build de votre projet sur Contributeur pour publier vos packages dans un flux avec Azure Pipelines. Pour obtenir des informations plus détaillées, consultez Ajouter de nouveaux utilisateurs/groupes.

Où puis-je découvrir les commandes et les arguments de npm ?

Exemples

Configuration requise

Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes Les agents auto-hébergés doivent avoir des fonctionnalités qui correspondent aux exigences suivantes pour exécuter des travaux qui utilisent cette tâche : npm
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande Quelconque
Variables paramétrables Quelconque
Version de l’agent 2.115.0 ou version ultérieure
Catégorie de la tâche Paquet
Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes Les agents auto-hébergés doivent avoir des fonctionnalités qui correspondent aux exigences suivantes pour exécuter des travaux qui utilisent cette tâche : npm
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande Quelconque
Variables paramétrables Quelconque
Version de l’agent 1.91.0 ou version ultérieure
Catégorie de la tâche Paquet