Go-Module verwalten

Auf dieser Seite wird beschrieben, wie Sie verpackte Go-Module verwalten, die in Artifact Registry gespeichert sind.

Hinweise

1. Wenn das Ziel-Repository nicht vorhanden ist, erstellen Sie ein neues Repository. Wählen Sie „Go“ als Repository-Format aus.
2. Prüfen Sie, ob Sie die erforderlichen Berechtigungen für das Repository haben.
3. (Optional) Konfigurieren Sie die Standardeinstellungen für gcloud-Befehle.
4. Installieren Sie Go 1.15 oder höher.

5. Installieren Sie das gcloud CLI-Add-on „package-go-module“:

   gcloud components install package-go-module

6. Konfigurieren Sie Go für die Authentifizierung bei Artifact Registry.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen für das Repository zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Verwalten von Modulen benötigen:

• Module ansehen: Artifact Registry-Leser (roles/artifactregistry.reader)
• Module herunterladen oder installieren: Artifact Registry-Leser (roles/artifactregistry.reader)
• Module zu einem Repository hinzufügen: Artifact Registry-Autor (roles/artifactregistry.writer)
• Module löschen: Repository-Administrator für Artifact Registry (roles/artifactregistry.repoAdmin)

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Modul hochladen

Repository-Modi:Standard

Führen Sie den folgenden Befehl aus, um ein Modul zu packen und in Ihr Repository hochzuladen:

  gcloud artifacts go upload --project=PROJECT \
      --repository=REPOSITORY \
      --location=LOCATION \
      --module-path=MODULE_PATH \
      --version=VERSION \
      --source=SOURCE_LOCATION

Ersetzen Sie Folgendes:

• PROJECT durch Ihre Google Cloud Projekt-ID.
• REPOSITORY durch den Namen des Repositorys, in dem das Paket gespeichert ist.
• Ersetzen Sie LOCATION durch den regionalen oder multiregionalen Speicherort des Repositorys.
• MODULE_PATH durch den Modulpfad. Beispiel: example.com/foo Weitere Informationen finden Sie in der Go-Modulreferenz.
• VERSION mit der semantischen Version des Moduls im Format vX.Y.Z, wobei X die Hauptversion, Y die Nebenversion und Z die Patchversion ist.
• SOURCE_LOCATION durch den Pfad zum Stammverzeichnis Ihres Go-Moduls. Wenn Sie das Flag --source weglassen, wird standardmäßig das aktuelle Verzeichnis verwendet.

Das Modul wird in Artifact Registry hochgeladen.

Weitere Informationen zum Erstellen von Go-Modulen finden Sie in dieser Anleitung.

Neue Modulversion hochladen

Repository-Modi:Standard

Wenn die Standardwerte konfiguriert sind, führen Sie den folgenden Befehl mit der neuen Versionsnummer aus, um eine neue Version Ihres Moduls in das Standardprojekt, das Standard-Repository und am Standard-Speicherort hochzuladen:

  gcloud artifacts go upload \
      --module-path=MODULE_PATH \
      --version=VERSION \
      --source=SOURCE_LOCATION

Ersetzen Sie VERSION durch die Version Ihres aktualisierten Moduls. Wenn Sie beispielsweise die Version 0.1.1 eines Moduls mit dem Pfad example.com/foo hochladen möchten, führen Sie den folgenden Befehl aus:

  gcloud artifacts go upload \
      --module-path=example.com/foo \
      --version=v0.1.1 \
      --source=SOURCE_LOCATION

Wenn Sie ein Modul als Vorrelease-Version kennzeichnen möchten, fügen Sie nach VERSION einen Bindestrich und dann die Vorrelease-Kennzeichnungen des Moduls ein:

  gcloud artifacts go upload \
      --module-path=MODULE_PATH \
      --version=VERSION-PRE_RELEASE_IDENTIFIERS \
      --source=SOURCE_LOCATION

Ersetzen Sie PRE_RELEASE_IDENTIFIERS durch durch Punkte getrennte alphanumerische ASCII-Zeichen und Bindestriche. Wenn Sie beispielsweise eine Vorabversion eines Moduls mit dem Pfad example.com/foo hochladen möchten, das durch alpha.x.12m.5 identifiziert wird, führen Sie den folgenden Befehl aus:

  gcloud artifacts go upload \
      --module-path=example.com/foo \
      --version=v1.0.0-alpha.x.12m.5 \
      --source=SOURCE_LOCATION

Neue Hauptversion hochladen

Repository-Modi:Standard

Hauptversionen sind nicht mit früheren Versionen abwärtskompatibel. Damit Nutzer keine funktionsgefährdende Änderung importieren, müssen Hauptversionen nach v1 andere Modulpfade als frühere Versionen haben. Ab v2 wird die Hauptversion am Ende des Modulpfads hinzugefügt.

Der Modulpfad für v2.0.0 von example.com/foo wäre beispielsweise example.com/foo/v2.

Es wird empfohlen, Hauptversionen nach v1 in separaten Verzeichnissen zu entwickeln, die nach dem Suffix der Hauptversion benannt sind.

So laden Sie eine neue Hauptversion 2.0.0 eines Moduls mit dem Pfad example.com/foo in das Standardprojekt, das Standard-Repository und den Standardspeicherort hoch, wenn die Standardwerte konfiguriert sind:

  gcloud artifacts go upload --module-path=example.com/foo/v2 --version=v2.0.0

Module auflisten

Repository-Modi:Standard, Remote, virtuell

Führen Sie den folgenden Befehl aus, um ein hochgeladenes Go-Modul im Standardprojekt, im Standard-Repository und am Standard-Speicherort zu prüfen, wenn die Standardwerte konfiguriert sind:

  gcloud artifacts packages list

Die Ausgabe sollte in etwa so aussehen:

  Listing items under project my-project, location us-west1, repository my-repo.

  PACKAGE                   CREATE_TIME          UPDATE_TIME
  example.com/foo           2022-06-03T20:43:39  2022-06-20T20:37:40

Details zur Modulversion ansehen

Repository-Modi:Standard, Remote, virtuell

Führen Sie den folgenden Befehl aus, um die Versionen eines Moduls im Standardprojekt, im Standard-Repository und am Standard-Speicherort aufzurufen, wenn die Standardwerte konfiguriert sind:

  gcloud artifacts versions list --package=MODULE_PATH

Die Ausgabe sollte in etwa so aussehen:

  Listing items under project my-project, location us-west1, repository my-repo, package example.com/foo.

  VERSION  DESCRIPTION  CREATE_TIME          UPDATE_TIME
  v0.1.0                2022-06-03T20:43:39  2022-06-03T20:43:39
  v0.1.1                2022-06-20T20:37:40  2022-06-20T20:37:40

Modul als Abhängigkeit verwenden

Repository-Modi:Standard, Remote, virtuell

Wenn Sie in Artifact Registry gespeicherte Module importieren möchten, müssen Sie Go anweisen, nach Abhängigkeiten in Artifact Registry zu suchen und die Prüfsummen-Datenbank zu umgehen. Folgen Sie der Anleitung unter Authentifizierung für Go einrichten, um die Authentifizierung und die Go-Umgebung einzurichten.

1. Wenn Sie kurzlebige Anmeldedaten für die Authentifizierung bei Artifact Registry verwenden, müssen Sie Ihr OAuth-Token mit dem folgenden Befehl aktualisieren:

     GOPROXY=proxy.golang.org \
     go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@latest refresh
   

2. Wenn Ihr Modul noch keine go.mod-Datei hat, wechseln Sie in den Ordner Ihres Moduls und führen Sie go mod init aus, um eine go.mod-Datei für Ihr Paket zu erstellen.

     go mod init MODULE_PATH
   

   Ersetzen Sie MODULE_PATH durch den Modulpfad für das in Artifact Registry gespeicherte Modul. Weitere Informationen finden Sie in der Go-Module-Referenz.

3. Wenn Sie die in Artifact Registry gespeicherte Version Ihres Moduls benötigen, bearbeiten Sie die Datei go.mod so, dass sie so aussieht:

   
   module example.com/bar
   
   go 1.19
   
   require example.com/foo v0.1.0
   

   Ersetzen Sie Folgendes:

   • example.com/foo ist der Modulpfad des erforderlichen Moduls.
   • v0.1.0 ist die in Artifact Registry gespeicherte Version.

4. Fügen Sie den Modulpfad wie gewohnt in den Abschnitt import Ihrer main.go-Datei ein.

   Wenn Sie beispielsweise ein Modul mit dem Pfad example.com/foo importieren möchten, das in Artifact Registry gespeichert ist, könnte Ihr Importabschnitt so aussehen:

     
     package main
   
     import (
       foo "example.com/foo"
     )
   
     func main() {
   
       ...
   
     }
   
     
   

5. Führen Sie go mod tidy aus, um Abhängigkeiten herunterzuladen:

     go mod tidy
   

6. Führen Sie das Modul wie gewohnt aus:

     go run .
   

   Das in Artifact Registry gespeicherte Modul wird heruntergeladen und als Abhängigkeit verwendet.

Verpackte Go-Module löschen

Repository-Modi:Standard, Remote

Sie können ein Paket und alle seine Versionen oder eine bestimmte Version löschen.

• Das Löschen eines Pakets kann nicht rückgängig gemacht werden.

Bevor Sie ein Paket oder eine Paketversion löschen, prüfen Sie, ob Sie alle wichtigen Abhängigkeiten davon kommuniziert oder behoben haben.

So löschen Sie ein Paket:

gcloud artifacts packages delete PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] [--async]

So löschen Sie Versionen eines Pakets:

gcloud artifacts versions delete VERSION \
    --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] \
    [--async]

Nächste Schritte

• Go-Schnellstart ausprobieren.
• Einzelne Dateien herunterladen, die einem Modul oder einer Version zugeordnet sind, ohne Go-Befehle zu verwenden.