Connecter votre projet npm vers les flux Azure Artifacts

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019

Azure Artifacts permet aux développeurs de publier et d’installer différents types de packages à partir de flux et de registres publics tels que npmjs.com. Pour vous authentifier auprès d’Azure Artifacts, il est nécessaire de configurer votre fichier de configuration npm. Ce fichier contient des URL de flux et des informations d’identification utilisées par npm, offrant des options pour personnaliser le comportement de votre client npm, telles que la configuration de proxys, la définition des emplacements de package par défaut ou la configuration des flux de package privés. Le fichier .npmrc se trouve généralement dans le répertoire de base de l’utilisateur, mais peut également être créé au niveau du projet pour remplacer les paramètres par défaut. En modifiant le fichier .npmrc, les utilisateurs peuvent personnaliser leur expérience npm pour répondre à leurs exigences spécifiques.

Prérequis

• Un organization Azure DevOps et un projet. Créez un organization ou un projet si ce n’est pas déjà fait.

• Un flux Azure Artifacts. Créez un flux si vous n’en avez pas déjà.

• Téléchargez et installez Node.js et npm.

Configuration du projet

Pour les bonnes pratiques, il est recommandé d’utiliser deux fichiers de configuration distincts. Le premier est utilisé pour l’authentification auprès d’Azure Artifacts, tandis que le deuxième est stocké localement et contient vos informations d’identification.

Pour configurer le deuxième fichier, placez-le simplement dans votre répertoire de base sur votre ordinateur de développement et incluez toutes vos informations d’identification de Registre. De cette façon, le client npm peut facilement accéder à vos informations d’identification pour l’authentification, ce qui vous permet de partager votre fichier de configuration tout en conservant vos informations d’identification sécurisées.

Les étapes suivantes vous guideront tout au long de la configuration du premier fichier de configuration :

Windows

1. Connectez-vous à votre organisation Azure DevOps puis accédez à votre projet.

2. Sélectionnez Artefacts, puis sélectionnez Connecter à alimenter.

   

3. Sélectionnez npm dans le volet de navigation gauche.

4. S’il s’agit de la première utilisation d’Azure Artifacts avec npm, sélectionnez Obtenir les outils et suivez les instructions pour installer les prérequis.

5. Suivez les instructions de la configuration de Project pour vous connecter à votre flux.

   

Autres

1. Ajoutez un fichier .npmrc dans le répertoire de votre projet, dans le même répertoire que votre fichier package.json, puis copiez l’extrait de code suivant dans celui-ci.

   registry=https://pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/registry/ 
   
   always-auth=true
   

Configurer les informations d’identification

1. Copiez l’extrait de code suivant dans votre fichier npmrc au niveau de l’utilisateur :

   • Flux d’étendue de l’organisation :

     ; begin auth token
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/registry/:username=[ENTER_ANY_VALUE_BUT_NOT_AN_EMPTY_STRING]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/registry/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/registry/:email=npm requires email to be set but doesn't use the value
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/:username=[ANY_VALUE_BUT_NOT_AN_EMPTY_STRING]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/:email=npm requires email to be set but doesn't use the value
     ; end auth token
     

   • Flux dans l’étendue du projet :

     ; begin auth token
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/registry/:username=[ENTER_ANY_VALUE_BUT_NOT_AN_EMPTY_STRING]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/registry/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/registry/:email=npm requires email to be set but doesn't use the value
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/:username=[ENTER_ANY_VALUE_BUT_NOT_AN_EMPTY_STRING]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/:email=npm requires email to be set but doesn't use the value
     ; end auth token
     

2. Générez un jeton d’accès personnel avec des étendues de lecture et d’écriture d’empaquetage.

3. Encoder votre jeton d’accès personnel nouvellement généré comme suit :

   1. Exécutez la commande suivante dans une fenêtre d’invite de commandes, puis collez votre jeton d’accès personnel lorsque vous y êtes invité :

      node -e "require('readline') .createInterface({input:process.stdin,output:process.stdout,historySize:0}) .question('PAT> ',p => { b64=Buffer.from(p.trim()).toString('base64');console.log(b64);process.exit(); })"
      

      Vous pouvez également utiliser la commande suivante pour convertir votre jeton d’accès personnel en Base 64.

      • Linux/Mac :

        echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
        

   2. Copiez la valeur encodée en Base 64.

4. Remplacez les deux valeurs [BASE64_ENCODED_PERSONAL_ACCESS_TOKEN] dans votre fichier .npmrc utilisateur par votre jeton d’accès personnel à l’étape 3.

Conseil

L’utilisation de plusieurs registres dans les fichiers .npmrc est prise en charge avec des étendues et des sources amont.

Authentification de pipeline

Pour vous authentifier auprès de votre pipeline, Azure Artifacts recommande d’utiliser la tâche d’authentification npm.

Lorsque vous utilisez des exécuteurs de tâches tels que gulp ou Grunt, il est important d’inclure votre tâche d’authentification npm au début de votre pipeline. Cette action garantit que vos informations d’identification sont injectées dans le fichier .npmrc de votre projet et conservées tout au long de l’exécution du pipeline, ce qui permet d’accéder aux informations d’identification dans le fichier de configuration.

Classique

1. Accédez à votre projet, sélectionnez Pipelines, puis sélectionnez votre définition de pipeline.

2. Sélectionnez Modifier pour modifier votre pipeline.

3. Sélectionnez cette option + pour ajouter une nouvelle tâche à votre pipeline.

   

4. Recherchez la tâche d’authentification npm, puis sélectionnez Ajouter.

   

5. Sélectionnez votre fichier .npmrc , puis sélectionnez Enregistrer et file d’attente lorsque vous avez terminé.

   

YAML

- task: npmAuthenticate@0
  inputs:
    workingFile: .npmrc                ## Path to the npmrc file
    customEndpoint: #Optional          ## Comma-separated list of npm service connection names for registries from external organizations. For registries in your org, leave this blank

Remarque

Pour que votre pipeline accède à votre flux, vérifiez que le rôle de service de génération est défini sur Feed And Upstream Reader (Contributeur) dans vos paramètres de flux.

Remarque

Si votre organisation utilise un pare-feu ou un serveur proxy, veillez à autoriser les URL de domaine appropriées. Pour plus d’informations, consultez les adresses IP autorisées et les URL de domaine.

Résolution des problèmes

vsts-npm-auth n’est pas reconnu

Si vous rencontrez l’erreur suivante lors de l’exécution du projet :

• Cmd: 'vsts-npm-auth' is not recognized as an internal or external command, operable program or batch file.

• PowerShell : vsts-npm-auth : The term 'vsts-npm-auth' is not recognized as the name of a cmdlet, function, script file, or operable program.

Ensuite, il est probable que le dossier des modules npm n’a pas été ajouté à votre chemin d’accès. Pour résoudre ce problème, réexécutez la configuration de Node.js et veillez à sélectionner l’option Add to PATH .

Vous pouvez également ajouter le dossier des modules npm à votre chemin en modifiant la variable PATH à %APPDATA%\npm l’invite de commandes ou $env:APPDATA\npm dans PowerShell.

Impossible de s’authentifier

Si vous rencontrez une erreur E401 : code E401 npm ERR! Unable to authenticate. Exécutez la vsts-npm-auth commande avec l’indicateur -F pour réauthentifier.

vsts-npm-auth -config .npmrc -F

Réinitialiser vsts-npm-auth

Procédez comme suit pour réinitialiser vos informations d’identification vsts-npm-auth :

1. Désinstallez vsts-npm-auth :

   npm uninstall -g vsts-npm-auth
   

2. Effacez votre cache npm :

   npm cache clean --force
   

3. Supprimez votre fichier .npmrc .

4. Réinstallez vsts-npm-auth :

   npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false
   

Articles connexes

• Publier et restaurer des packages npm (CLI)
• Publier des packages npm (YAML/Classic)
• Utiliser des packages à partir de npmjs.com