Node.js-Pakete verwalten

Artifact Registry unterstützt Node.js-Pakete, die Sie mit npm verwalten.

Überblick

Wenn Sie sich mit Node.js-Paketen in Artifact Registry vertraut machen möchten, verwenden Sie die quickstart.

Wenn Sie mehr erfahren möchten, lesen Sie die folgenden Informationen:

  1. Wenn Sie npm noch nicht kennen, sollten Sie sich über die folgenden Konzepte informieren:
  2. Erstellen Sie ein Node.js-Paket-Repository für Ihre Pakete.
  3. Gewähren Sie Berechtigungen für das Konto, das mit dem Repository verbunden wird. Dienstkonten für gängige Integrationen mit Artifact Registry haben Standardberechtigungen für Repositories im selben Projekt.
  4. Konfigurieren Sie die Tools:
  5. Informationen zum Verwalten von Paketen.

Bereiche verwenden

Ein npm-Bereich ist ein Label zum Gruppieren von Paketen. Bereiche sind erforderlich, wenn Sie mit mehreren npm-Registries arbeiten, einschließlich:

  • Veröffentlichen und Installieren von Paketen in verschiedenen Registries, ohne dass Sie von einer Registry zu einer anderen wechseln müssen. Ihre Builds können beispielsweise Pakete aus der öffentlichen npm-Registry und einem Artifact Registry-Repository enthalten.
  • Veröffentlichen derselben Pakete in mehreren Artifact Registry-Repositories in Google Cloud-Projekten und anderen npm-Registries ohne Paketnamenkonflikte.

Es wird empfohlen, immer einen Bereich für Ihre Repositories festzulegen. Wenn Sie keinen Bereich angeben und das Paket veröffentlichen oder installieren, verwendet npm die konfigurierte Standard-Registry, z. B. die öffentliche npm-Registry.

Sie legen den Bereich für jedes Artifact Registry-Repository in der Konfigurationsdatei .npmrc fest. Die Anmeldedaten für die Authentifizierung gelten für alle Repositories.

Das folgende Beispiel zeigt die Konfiguration für zwei Artifact Registry-Repositories in verschiedenen Projekten.

  • Der Bereich @blue gilt für das Repository im Projekt blue-project.
  • Der Bereich @green gilt für das Repository im Projekt green-project.
@blue:registry=https://us-central1-npm.pkg.dev/blue-project/blue-npm-repo/
//us-central1-npm.pkg.dev/blue-project/blue-npm-repo/:always-auth=true

@green:registry=https://us-central1-npm.pkg.dev/green-project/green-npm-repo/
//us-central1-npm.pkg.dev/green-project/green-npm-repo/:_authToken=""
//us-central1-npm.pkg.dev/green-project/green-npm-repo/:always-auth=true

Nach der Authentifizierung bei Artifact Registry können Sie ein Paket mit dem entsprechenden Bereich in ein bestimmtes Repository hochladen. Beispiel: Mit dem folgenden Befehl wird ein Paket in blue-npm-repo im Projekt blue-project hochgeladen:

npm publish @blue/blue-npm-repo

Weitere Informationen zu Bereichen finden Sie in der npm-Dokumentation.

npm konfigurieren

Die für die Authentifizierung verwendeten Einstellungen werden in der Konfigurationsdatei .npmrc gespeichert. Sie können eine .npmrc-Datei auf Projekt-, Nutzer- oder globaler Ebene konfigurieren.

Wenn Sie die Authentifizierung mit Artifact Registry konfigurieren, definieren Sie die Repositories, zu denen Sie eine Verbindung herstellen möchten, sowie die Anmeldedaten für die Authentifizierung.

Artifact Registry-Repositories

Wir empfehlen, die Repository-Liste in der Konfigurationsdatei pro Projekt festzulegen. Diese Datei befindet sich normalerweise im selben Verzeichnis wie die Datei package.json in Ihrem npm-Projekt. Artifact Registry Credential Helper prüft diese .npmrc-Datei standardmäßig für Ihre Repositories.

Wenn Sie die Repository-Pfade in Ihrem Versionsverwaltungssystem nicht verfügbar machen möchten, haben Sie folgende Möglichkeiten:

  • Fügen Sie den Dateinamen .npmrc in die Liste der zu ignorierenden Dateien Ihrer Versionsverwaltung ein.
  • Speichern Sie die Repository-Liste stattdessen in der nutzerspezifischen Konfigurationsdatei. Die nutzerspezifische .npmrc-Datei befindet sich im Basisverzeichnis des Nutzers oder ist mit dem npm-Parameter --userconfig oder der Umgebungsvariablen $NPM_CONFIG_USERCONFIG festgelegt. Die Einstellungen in der nutzerspezifischen Konfigurationsdatei gelten für alle Ihre Projekte, sofern Sie sie nicht auf Projektebene überschreiben.
Artifact Registry-Anmeldedaten

Speichern Sie Ihre Anmeldedaten für Artifact Registry in der Konfigurationsdatei pro Nutzer, damit sie nicht für andere Nutzer verfügbar sind. Diese Datei befindet sich im Basisverzeichnis des Nutzers oder wird mit dem npm-Parameter --userconfig oder der Umgebungsvariable $NPM_CONFIG_USERCONFIG festgelegt.

Der Credential Helper von Artifact Registry wird in der öffentlichen npm-Registry gespeichert und erfordert für die Installation keine Authentifizierung.

Sie sollten die vorhandene Standard-Registry beibehalten, die in Ihrer .npmrc-Datei konfiguriert ist. Die Standardeinstellung ist normalerweise auf die öffentliche npm-Registry unter https://registry.npmjs.org/ festgelegt.

Führen Sie folgenden Befehl aus, um den aktuellen Standardwert der Registry zu prüfen:

npm get registry

Weitere Informationen zu npm-Konfigurationsdateien finden Sie in der Dokumentation zu npm-Konfigurationsdateien.