Erste Schritte mit npm-Paketen in Azure Artifacts

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019 | TFS 2018

Mithilfe von Azure Artifacts können Sie npm-Pakete aus Feeds und öffentlichen Registrierungen wie npmjs.com veröffentlichen und herunterladen. Diese Schnellstartanleitung führt Sie durch den Prozess zum Erstellen Ihres Feeds, zum Konfigurieren Ihres Projekts und zum Veröffentlichen und Herunterladen von npm-Paketen in und aus Ihrem Azure Artifacts-Feed.

Lizenz für die Azure Artifacts-Erweiterung

Wenn die Azure Artifacts-Erweiterung entfernt wurde, können Sie sie aus dem Visual Studio Marketplace installieren. Jede Organisation erhält fünf kostenlose Lizenzen. Wenn Sie mehr als fünf Lizenzen benötigen, wechseln Sie zum Visual Studio Marketplace, und wählen Sie "Kostenlos abrufen" aus.

Wenn Sie nicht sicher sind, können Sie die kostenlose Testversion "30 Tage starten" auswählen. Jeder Benutzer in Ihrer Organisation erhält dann 30 Tage Lang Zugriff auf Azure Artifacts. Nach dem 30-Tage-Testzeitraum rückgängig machen Ihre Organisation zurück zu fünf berechtigten Benutzern, und Sie müssen einzelnen Benutzern Lizenzen zuweisen. Wenn Sie zu diesem Zeitpunkt zusätzliche Lizenzen benötigen, können Sie sie über Visual Studio Marketplace erwerben. Wenn Sie über eine Lizenz für Visual Studio Enterprise verfügen, haben Sie bereits Zugriff auf Azure Artifacts und müssen keine Lizenz zugewiesen werden. Stellen Sie einfach sicher, dass Ihnen die Zugriffsebene "Visual Studio Enterprise" zugewiesen wurde.

Hinweis

Wenn Sie die kostenlose Testversion "30 Tage starten" ausgewählt haben und sich noch im Testzeitraum befinden, erhält jeder Benutzer Zugriff. Lizenzen müssen erst zugewiesen werden, wenn der Testzeitraum endet.

  1. Zeigen Sie in einer beliebigen Sammlung in Team Foundation Server auf das Menü "Einstellungen", und wählen Sie "Benutzer" aus. Wählen Sie dann "Paketverwaltung" aus.

    Screenshot showing the user page in TFS 2018

  2. Wählen Sie "Zuweisen" aus, geben Sie die Benutzer ein, die Sie Lizenzen zuweisen möchten, und wählen Sie dann "OK" aus.

    • Benutzer mit Visual Studio Enterprise-Abonnements erhalten azure Artifacts kostenlos. Stellen Sie sicher, dass Ihre Visual Studio Enterprise-Abonnenten über die entsprechende Zugriffsebene verfügen. Weitere Informationen finden Sie unter Ändern von Zugriffsebenen.

    • Benutzer, die eine Instanz von Team Foundation Server verwenden, die vom Internet getrennt ist (und daher keine Lizenzen von Visual Studio Marketplace erwerben kann) können weiterhin Lizenzen zuweisen, die über einen Enterprise-Vertrag erworben wurden.

Erstellen eines Feeds

Ein Feed ist ein Organisationskonstrukt, mit dem Benutzer ihre Pakete speichern und steuern können, wer darauf zugreifen kann. Azure Artifacts unterstützen das Speichern mehrerer Pakettypen in einem einzigen Feed wie NuGet, npm, Maven, Python, Cargo und Universal-Pakete.

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

  2. Wählen Sie Artefakte und dann "Feed erstellen" aus, um einen neuen Feed zu erstellen.

  3. Geben Sie einen beschreibenden Namen für Ihren Feed ein, und definieren Sie die Sichtbarkeit (die angibt, wer Pakete innerhalb des Feeds anzeigen kann). Geben Sie den Bereich Ihres Feeds an, und wenn Sie Pakete aus öffentlichen Quellen einschließen möchten, markieren Sie das Kontrollkästchen "Upstream-Quellen ".

  4. Wählen Sie Erstellen, wenn Sie fertig sind.

    A screenshot showing how to create a need feed.

Hinweis

Standardmäßig haben neu erstellte Feeds den Builddienst ihres Projekts auf "Mitarbeiter" festgelegt.

Azure Artifacts ist in TFS 2018 vorinstalliert. Wenn Sie Ihren Feed zum ersten Mal verwenden, werden Sie möglicherweise aufgefordert, eine Lizenz zuzuweisen.

  1. Navigieren Sie zu Ihrem Projekt http://ServerName:8080/tfs/DefaultCollection/<ProjectName>.

  2. Wählen Sie "Build & release" und dann "Pakete" aus.

  3. Wählen Sie +Neuer Feed aus, um einen neuen Feed zu erstellen.

  4. Geben Sie einen aussagekräftigen Namen und eine beschreibung für Ihren Feed an. Geben Sie die Berechtigungen für die Personen an, die gelesen werden können und wer mitwirken kann, und entscheiden Sie, ob externe Pakete eingeschlossen werden sollen.

  5. Wählen Sie Erstellen, wenn Sie fertig sind.

    A screenshot showing how to create a new feed in TFS 2018.

Einrichten Ihrer NPMRC-Dateien

Hinweis

vsts-npm-auth wird in TFS und Azure DevOps Server nicht unterstützt.

Es wird empfohlen, zwei NPMRC-Dateien zu verwenden. Der erste sollte sich im selben Verzeichnis wie die Datei "package.json" befinden. Die zweite sollte im $home Verzeichnis (Linux/macOS) oder $env platziert werden. HOME (Windows), um Ihre Anmeldeinformationen sicher zu speichern. Der npm-Client kann diese Datei dann nachschlagen und Ihre Anmeldeinformationen für die Authentifizierung abrufen. Auf diese Weise können Sie Ihre Konfigurationsdatei freigeben, während Ihre Anmeldeinformationen sicher bleiben.

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

  2. Wählen Sie Artefakte aus, und wählen Sie dann Verbinden aus, um zu feeden.

  3. Wählen Sie npm aus dem linken Navigationsbereich aus. Wenn Sie Azure Artifacts zum ersten Mal mit npm verwenden, wählen Sie "Tools abrufen" aus, und führen Sie die Schritte aus, um Node.js herunterzuladen und Ihren Computer einzurichten.

  4. Fügen Sie den folgenden Codeausschnitt in die NPMRC-Datei ein, die sich im selben Verzeichnis wie ihre package.json-Datei befindet. Ersetzen Sie die Platzhalter durch die entsprechenden Werte.

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

Einrichten von Anmeldeinformationen

Wichtig

npm unterstützt eine einzelne registry in Ihrer NPMRC-Datei. Mehrere Register sind mit Bereichen und vorgelagerten Quellen möglich.

Wenn Sie unter Windows entwickeln, empfehlen wir die Verwendung der vsts-npm-auth zur Authentifizierung mit Azure Artifacts. Stellen Sie sicher, dass vsts-npm-auth über "Tools abrufen" installiert ist, und führen Sie dann vsts-npm-auth aus, um ein Azure Artifacts-Token abzurufen, das Ihrer NPMRC-Datei auf Benutzerebene hinzugefügt wurde:

vsts-npm-auth -config .npmrc

Verbindung mit Feed herstellen

  1. Navigieren Sie zu Ihrem Projekt http://ServerName:8080/tfs/DefaultCollection/<ProjectName>.

  2. Wählen Sie "Build & release" und dann "Pakete" aus.

  3. Wählen Sie Verbinden zum Feed aus, und wählen Sie dann npm aus.

  4. Wählen Sie "npm-Anmeldeinformationen generieren" aus. Kopieren Sie die Anmeldeinformationen, und fügen Sie sie ihrer NPMRC-Datei auf Benutzerebene hinzu.

    A screenshot showing how to generate npm credentials in TFS 2018.

Veröffentlichen von Paketen

Führen Sie zum Veröffentlichen des npm-Pakets den folgenden Befehl in Ihrem Projektverzeichnis aus:

npm publish

Wichtig

Die Verwendung der publishConfig Eigenschaft zum Überschreiben des Registrierungskonfigurationsparameters zur Veröffentlichungszeit wird nicht unterstützt.

Pakete wiederherstellen

Führen Sie zum Wiederherstellen eines npm-Pakets den folgenden Befehl in Ihrem Projektverzeichnis aus:

npm install --save <package>

Führen Sie zum Wiederherstellen aller npm-Pakete den folgenden Befehl aus Ihrem Projektverzeichnis aus:

npm install