Verbinden Ihres npm-Projekts mit Azure Artifacts

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

Mit Azure Artifacts können Entwickler ihre Pakete aus verschiedenen Quellen verwalten, einschließlich öffentlicher Registrierungen wie npmjs.com und privaten Feeds. Um sich mit Azure Artifacts zu authentifizieren, müssen Sie Ihre npm-Konfigurationsdatei konfigurieren. Diese Datei enthält Feed-URLs und Anmeldeinformationen, die von npm verwendet werden, und bietet Optionen zum Anpassen des npm-Clientverhaltens, z. B. das Einrichten von Proxys, das Definieren von Standardpaketspeicherorten oder das Konfigurieren privater Paketfeeds. Die NPMRC-Datei befindet sich in der Regel im Startverzeichnis des Benutzers, kann aber auch auf Projektebene erstellt werden, um die Standardeinstellungen außer Kraft zu setzen.

Voraussetzungen

• Eine Azure DevOps-Organisation. Erstellen Sie ein kostenloses Konto.

• Ein Azure DevOps-Projekt. Erstellen Sie ein neues Projekt, wenn Sie noch keins haben.

• Ein Azure Artifacts-Feed. Erstellen Sie ein kostenloses Konto.

• Laden Sie Node.js und npm herunter, und installieren Sie es.

Verbindung mit Feed herstellen

Azure Artifacts empfiehlt die Verwendung von zwei separaten Konfigurationsdateien. Der erste dient der Authentifizierung mit Azure Artifacts, während die zweite lokal aufbewahrt werden sollte, um Ihre Anmeldeinformationen zu speichern. Mit diesem Ansatz können Sie Ihre Konfigurationsdatei freigeben, während Ihre Anmeldeinformationen sicher bleiben.

Um die zweite Datei einzurichten, platzieren Sie sie einfach in Ihrem Startverzeichnis auf Ihrem Entwicklungscomputer, und fügen Sie alle Ihre Registrierungsanmeldeinformationen ein. Dadurch kann der npm-Client auf einfache Weise auf Ihre Anmeldeinformationen für die Authentifizierung zugreifen.

Die folgenden Schritte führen Sie durch das Einrichten der ersten Konfigurationsdatei:

Windows

1. Melden Sie sich bei Ihrer Azure DevOps-Organisation an, und navigieren Sie dann zu Ihrem Projekt.

2. Wählen Sie Artefakte und dann "Mit Feed verbinden" aus.

   

3. Wählen Sie npm aus der linken Randleiste aus. Wenn Sie azure Artifacts mit npm zum ersten Mal verwenden, stellen Sie sicher, dass Sie die erforderlichen Komponenten installiert haben.

4. Folgen Sie den Anweisungen im Abschnitt "Project-Setup ", um eine Verbindung mit Ihrem Feed herzustellen.

   

Andere

1. Fügen Sie eine NPMRC-Datei im Verzeichnis Ihres Projekts im selben Verzeichnis wie Ihre package.json-Datei hinzu, und fügen Sie den folgenden Codeausschnitt in das Verzeichnis ein.

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

Einrichten von Anmeldeinformationen

1. Kopieren Sie den folgenden Codeausschnitt, und fügen Sie ihn in die npmrc-Datei auf Benutzerebene ein:

   • Feed mit Organisationsbereich:

     ; 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
     

   • Projektbezogener Feed:

     ; 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. Generieren Sie ein persönliches Zugriffstoken mit Lese- und Schreibbereichen .

3. Führen Sie den folgenden Befehl in einem Eingabeaufforderungsfenster aus, und fügen Sie dann Ihr persönliches Zugriffstoken ein, wenn Sie dazu aufgefordert werden. Kopieren Sie anschließend den generierten Base64-codierten Wert.

   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(); })"
   

4. Wenn Sie Linux/Mac verwenden, können Sie alternativ den folgenden Befehl verwenden, um Ihr persönliches Zugriffstoken in Base 64 zu konvertieren. Kopieren Sie den resultierenden Base64-codierten Wert.

   echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
   

5. Ersetzen Sie die Platzhalter [BASE64_ENCODED_PERSONAL_ACCESS_TOKEN] in Ihrer Npmrc-Datei des Benutzers durch das codierte persönliche Zugriffstoken, das aus dem vorherigen Schritt abgerufen wurde.

Tipp

Die Verwendung mehrerer Registrierungen in NPMRC-Dateien wird mit Bereichen und Upstreamquellen unterstützt.

Pipelineauthentifizierung

Um sich bei Ihrer Pipeline zu authentifizieren, empfiehlt Azure Artifacts die Verwendung der npm-Authentifizierungsaufgabe.

Wenn Sie Aufgabenläufer wie gulp oder Grunt verwenden, müssen Sie die Festlegung Ihrer npm-Authentifizierungsaufgabe am Anfang Ihrer Pipeline priorisieren. Dieser Schritt garantiert, dass Ihre Anmeldeinformationen in die NPMRC-Datei Ihres Projekts eingefügt und während der gesamten Pipelineausführung aufbewahrt werden, sodass nachfolgende Schritte auf die Anmeldeinformationen in der Konfigurationsdatei zugreifen können.

Klassisch

1. Navigieren Sie zu Ihrem Projekt, wählen Sie "Pipelines" aus, und wählen Sie dann Ihre Pipelinedefinition aus.

2. Wählen Sie Bearbeiten aus, um Ihre Pipeline zu bearbeiten.

3. Wählen Sie diese Option + aus, um Ihrer Pipeline eine neue Aufgabe hinzuzufügen.

   

4. Suchen Sie nach der npm-Authentifizierungsaufgabe, und wählen Sie dann "Hinzufügen" aus.

   

5. Wählen Sie Ihre NPMRC-Datei aus, und wählen Sie dann "Speichern und Warteschlange " aus, wenn Sie fertig sind.

   

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

Hinweis

Um von Ihrer Pipeline aus auf Ihren Feed zuzugreifen, stellen Sie sicher, dass die Builddienstrolle auf Feed und Upstream Reader (Mitwirkender) in den Feedeinstellungen>Berechtigungen festgelegt ist.

Hinweis

Wenn Ihre Organisation eine Firewall oder einen Proxyserver verwendet, stellen Sie sicher, dass Sie die entsprechenden Domänen-URLs zulassen. Details finden Sie unter Zulässige IP-Adressen und Domänen-URLs .

Problembehandlung

vsts-npm-auth wird nicht erkannt.

Dieser Fehler gibt an, dass der Ordner "npm modules" ihrem Pfad nicht hinzugefügt wurde. Führen Sie das Node.js Setup erneut aus, und stellen Sie sicher, dass Sie die Add to PATH Option auswählen. Alternativ können Sie den Ordner "npm modules" zu Ihrem Pfad hinzufügen, indem Sie die PATH-Variable %APPDATA%\npm in der Eingabeaufforderung oder $env:APPDATA\npm in PowerShell ändern.

Die Authentifizierung kann nicht ausgeführt werden.

• Fehler: Code E401 npm ERR! Authentifizierung nicht möglich: -> Führen Sie den vsts-npm-auth Befehl mit -F-Flag aus, um die Authentifizierung erneut zu authentifizieren:

  vsts-npm-auth -config .npmrc -F
  

Zurücksetzen der vsts-npm-auth

Führen Sie die folgenden Schritte aus, um Ihre vsts-npm-auth-Anmeldeinformationen zurückzusetzen:

1. Deinstallieren Sie vsts-npm-auth:

   npm uninstall -g vsts-npm-auth
   

2. Löschen Sie den npm-Cache:

   npm cache clean --force
   

3. Löschen Sie die NPMRC-Datei .

4. Erneutes Installieren von vsts-npm-auth:

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

Veröffentlichen nicht möglich

Wenn ein 403-Fehler auftritt, kann ein Namenskonflikt angezeigt werden. In Azure Artifacts sind Pakete unveränderlich, d. h., nachdem Sie ein Paket in Ihrem Feed veröffentlicht haben, ist die Versionsnummer dauerhaft reserviert. Selbst wenn Sie es löschen, können Sie kein neues Paket mit derselben Versionsnummer veröffentlichen. Um dieses Problem zu beheben, aktualisieren Sie die Paketversion in Ihrer package.json-Datei , und versuchen Sie es dann erneut.

Verwandte Artikel

• Veröffentlichen und Wiederherstellen von npm-Paketen (CLI)
• Veröffentlichen von npm-Paketen (YAML/Classic)
• Verwenden von Paketen aus npmjs.com