Auf dieser Seite wird erläutert, wie Sie mit Cloud Build Node.js
-Anwendungen erstellen und testen, erstellte Artefakte in einem npm-Repository in Artifact Registry speichern und Informationen zur Build-Herkunft generieren.
Mit Cloud Build können Sie jedes öffentlich verfügbare Container-Image zur Ausführung Ihrer Aufgaben verwenden. Das öffentliche node
-Image von Docker Hub ist im npm
-Tool vorinstalliert. Sie können Cloud Build so konfigurieren, dass Ihr Node.js
-Projekt mit diesem Tool erstellt wird.
Hinweise
Die Anleitung auf dieser Seite setzt voraus, dass Sie mit Node.js
vertraut sind. Außerdem gilt:
- Machen Sie sich mit npm vertraut.
- Halten Sie Ihr
Node.js
-Projekt bereit, einschließlich der Dateienpackage.json
undtest.js
. - Die Datei
package.json
muss einstart
- und eintest
-Skript enthalten. - Machen Sie sich damit vertraut, wie eine Cloud Build-Konfigurationsdatei geschrieben wird.
- Sie haben ein npm-Repository in Artifact Registry. Wenn Sie noch keines haben, erstellen Sie ein neues Repository.
- Zum Ausführen der
gcloud
-Befehle auf dieser Seite müssen Sie die Google Cloud CLI installieren.
Mit npm
erstellen
Damit die Aufgaben im Image node
von Docker Hub ausgeführt werden, geben Sie in der Cloud Build-Konfigurationsdatei im Feld name
die Image-URL an.
Cloud Build startet den im Feld name
angegebenen Container mithilfe des Standardeinstiegspunkts des Images. Wenn Sie den Standardeinstiegspunkt überschreiben und definieren möchten, wie der Build-Schritt ausgeführt werden soll, wenn er ausgelöst wird, fügen Sie dem Build-Schritt ein entrypoint
-Feld hinzu. Auf dem Image node
in Docker Hub ist das npm
-Tool vorinstalliert. Geben Sie die Tools im Feld entrypoint
an, um sie als Einstiegspunkt für den Build-Schritt aufzurufen.
Für die folgende Beispiel-Build-Konfigurationsdatei gilt:
- Das Feld
name
gibt an, dass das Imagenode
aus Docker Hub von Cloud Build zum Ausführen Ihrer Aufgabe verwendet wird. Wenn Sie das Imagenode
angeben, können Sie entweder die Knotenversion weglassen, um standardmäßig:latest
zu verwenden, oder eine Knotenversion angeben, um eine bestimmte Version zu verwenden. Beispiel:name: node
verwendet die neueste Version des Knotens undname: node:12
verwendetnode:12
. Das Feld
entrypoint
gibt an, dass dasnpm
-Tool verwendet wird, wenn dasnode
-Image aufgerufen wird.steps: - name: 'node' entrypoint: 'npm'
Node.js
-Builds konfigurieren
Erstellen Sie im Stammverzeichnis des Projekts eine Konfigurationsdatei mit dem Namen
cloudbuild.yaml
.Abhängigkeiten installieren: Bevor Sie die Anwendung erstellen können, müssen Sie dafür sorgen, dass alle Abhängigkeiten des Projekts über
npm
installiert werden. Sie können Abhängigkeiten mit dem Befehlinstall
imnpm
-Build-Schritt installieren. Im Feldargs
eines Build-Schritts wird eine Liste von Argumenten abgerufen und an das Image übergeben, auf das im Feld „name“ verwiesen wird. Fügen Sie in der Build-Konfigurationsdatei dem Feldargs
install
hinzu, um den Befehlinstall
aufzurufen:steps: - name: 'node' entrypoint: 'npm' args: ['install']
Tests hinzufügen: Wenn Sie in der
package.json
eintest
-Skript definiert haben, können Sie Cloud Build so konfigurieren, dass es das Skript ausführt, indem Sietest
zum Feldargs
hinzufügen:steps: - name: 'node' entrypoint: 'npm' args: ['install'] - name: 'node' entrypoint: 'npm' args: ['test']
Benutzerdefinierte Befehle ausführen: Wenn die
package.json
benutzerdefinierte Befehle enthält, können Sie Cloud Build für die Ausführung dieser Befehle konfigurieren. Fügen Sie im Feldargs
run
als erstes Argument hinzu, gefolgt vom Namen des benutzerdefinierten Befehls. Die folgende Build-Konfigurationsdatei enthält Argumente zum Ausführen eines benutzerdefinierten Befehls namensbuild
:steps: - name: 'node' entrypoint: 'npm' args: ['install'] - name: 'node' entrypoint: 'npm' args: ['test'] - name: 'node' entrypoint: 'npm' args: ['run', 'build']
In Artifact Registry hochladen:
Cloud Build generiert Supply Chain Levels for Software Artifacts (SLSA), Build-Herkunftsinformationen für eigenständige npm-Pakete, wenn Sie sie über das Feld
npmPackages
in Ihrer Cloud Build-Konfigurationsdatei in Artifact Registry hochladen.Fügen Sie in Ihrer Konfigurationsdatei das Feld
npmPackages
hinzu und geben Sie Ihr npm-Repository in Artifact Registry an:artifacts: npmPackages: - repository: 'https://LOCATION-npm.pkg.dev/PROJECT-ID/REPOSITORY_NAME' packagePath: 'PACKAGE_PATH'
Ersetzen Sie die folgenden Werte:
- LOCATION: der Speicherort Ihres Repositorys in Artifact Registry.
- PROJECT_ID: die ID des Google Cloud-Projekts, das Ihr Artifact Registry-Repository enthält.
- REPOSITORY_NAME: der Name Ihres npm-Repositorys in Artifact Registry.
- PACKAGE_PATH: der Pfad für das lokale Verzeichnis mit dem npm-Paket, das Sie in Artifact Registry hochladen möchten. Wir empfehlen die Verwendung eines absoluten Pfads. Der Wert
PACKAGE_PATH
kann.
sein, um das aktuelle Arbeitsverzeichnis zu verwenden. Das Feld darf jedoch nicht weggelassen oder leer gelassen werden. Dieses Verzeichnis muss einepackage.json
-Datei enthalten.
Optional: Herkunft für regionale Builds aktivieren
Wenn Sie einen regionalen Build verwenden, fügen Sie in der Build-Konfigurationsdatei das Feld
requestedVerifyOption
inoptions
ein. Legen Sie den Wert aufVERIFIED
fest, um das Generieren von Herkunftsmetadaten zu aktivieren. Wenn SierequestedVerifyOption: VERIFIED
nicht hinzufügen, generiert Cloud Build die Herkunft nur für globale Builds.options: requestedVerifyOption: VERIFIED
Build starten: manuell oder mit Build-Triggern
Sobald der Build abgeschlossen ist, können Sie die Repository-Details in Artifact Registry ansehen.
Sie können auch Build-Metadaten aufrufen und Herkunft prüfen, um Ihre Softwarelieferkette zu schützen.
Mehrere node
-Versionen testen
Manchmal muss Ihr Projekt in mehreren Versionen von node
funktionieren. Sie können Cloud Build-Trigger folgendermaßen erstellen und konfigurieren:
- Geben Sie in der Build-Konfigurationsdatei die
node
-Version als eine Substitutionsvariable an. - Erstellen Sie einen Trigger für jede Version von
node
, mit der Sie Ihre Anwendung erstellen möchten. - Verwenden Sie in den einzelnen Triggereinstellungen das Feld für den Wert der Substitutionsvariable, um die Version von
node
für den jeweiligen Trigger anzugeben.
In den folgenden Schritten wird erläutert, wie Sie die node
-Version mithilfe von triggerspezifischen Substitutionsvariablen angeben:
Fügen Sie im Stammverzeichnis Ihres Repositorys eine Build-Konfigurationsdatei hinzu, die die
node
-Version als Substitutionsvariable angibt. Im folgenden Beispiel für eine Build-Konfigurationsdatei ist$_NODE_VERSION
eine benutzerdefinierte Substitutionsvariable:steps: - name: 'node:$_NODE_VERSION' entrypoint: 'npm' args: ['install'] - name: 'node:$_NODE_VERSION' entrypoint: 'npm' args: ['test']
Erstellen Sie für jede Version von
node
, mit der Sie einen Build erstellen möchten, mithilfe der folgenden Schritte einen Build-Trigger:Öffnen Sie in der Google Cloud Console die Seite Trigger:
Wählen Sie oben auf der Seite im Drop-down-Menü zur Projektauswahl Ihr Projekt aus.
Klicken Sie auf Öffnen.
Klicken Sie auf Trigger erstellen.
Auf der Seite Erstellen Sie einen Trigger geben Sie die folgenden Einstellungen ein:
Geben Sie einen Namen für den Trigger ein.
Wählen Sie das Repository-Ereignis aus, das den Trigger aufrufen soll.
Wählen Sie das Repository aus, das Ihren Quellcode und die Build-Konfigurationsdatei enthält.
Geben Sie den regulären Ausdruck für den Zweig- oder Tag-Namen an, mit dem der Trigger gestartet wird.
Konfiguration: Wählen Sie die Build-Konfigurationsdatei aus, die Sie zuvor erstellt haben.
Klicken Sie unter Substitutionsvariablen auf Variable hinzufügen.
- Geben Sie unter Variable die
node
-Versionsvariable an, die Sie in der Build-Konfigurationsdatei verwendet haben, und unter Wert die Version vonnode
. Zum Beispiel:_NODE_VERSION
und12
- Geben Sie unter Variable die
Klicken Sie auf Erstellen, um den Build-Trigger zu speichern.
Sie können diese Trigger verwenden, um Ihren Code mit der Version von node
zu erstellen, die Sie im Trigger angegeben haben.
Nächste Schritte
- Build-Ergebnisse aufrufen
- Builds schützen
- Container-Images erstellen
- Go-Anwendungen erstellen
- Blau/Grün-Bereitstellungen in Compute Engine durchführen
- Build-Fehler beheben