Gestire i moduli Go

Questa pagina spiega come gestire i moduli Go in pacchetto archiviati in Artifact Registry.

Prima di iniziare

  1. Se il repository di destinazione non esiste, creane uno nuovo. Scegli Go come formato del repository.
  2. Verifica di disporre delle autorizzazioni richieste per il repository.
  3. (Facoltativo) Configura le impostazioni predefinite per i comandi gcloud.
  4. Installa Go 1.15 o versioni successive.

  5. Installa il componente aggiuntivo package-go-module di gcloud CLI:

    gcloud components install package-go-module

  6. Configura Go per l'autenticazione con Artifact Registry.

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per gestire i moduli, chiedi all'amministratore di concederti i seguenti ruoli IAM per il repository:

Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Caricare un modulo

Modalità repository: standard

Per creare il pacchetto e caricare un modulo nel repository, esegui il comando seguente:

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

Sostituisci quanto segue:

  • PROJECT con l' Google Cloud ID progetto.
  • REPOSITORY con il nome del repository in cui è archiviato il pacchetto.
  • LOCATION con la località regionale o multiregionale località del repository.
  • MODULE_PATH con il percorso del modulo. Ad esempio: example.com/foo Per saperne di più, consulta la documentazione di riferimento sui moduli Go.
  • VERSION con la versione semantica del modulo nel formato vX.Y.Z, dove X è la versione principale, Y è la versione secondaria e Z è la versione patch.
  • SOURCE_LOCATION con il percorso della directory principale del modulo Go. Se ometti il flag --source, il valore predefinito è la directory attuale.

Il modulo viene caricato in Artifact Registry.

Per saperne di più sulla creazione di moduli Go, consulta questo tutorial.

Caricare una nuova versione del modulo

Modalità repository: standard

Per caricare una nuova versione del modulo nel progetto, nel repository e nella località predefiniti quando i valori predefiniti sono configurati, esegui il comando seguente con il nuovo numero di versione:

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

Sostituisci VERSION con la versione del modulo aggiornato. Ad esempio, per caricare la versione 0.1.1 di un modulo con il percorso example.com/foo, esegui il comando seguente:

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

Per contrassegnare un modulo come versione di pre-release, aggiungi un trattino dopo il VERSION e aggiungi gli identificatori di pre-release del modulo:

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

Sostituisci PRE_RELEASE_IDENTIFIERS con caratteri alfanumerici ASCII e trattini separati da punti. Ad esempio, per caricare una pre-release di un modulo con il percorso example.com/foo identificato da alpha.x.12m.5, esegui il comando seguente:

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

Caricare una nuova versione principale

Modalità repository: standard

Le versioni principali non sono compatibili con le versioni precedenti. Per impedire agli utenti di importare una modifica che causa interruzioni, le versioni principali successive a v1 devono avere percorsi di modulo diversi rispetto alle versioni precedenti. A partire da v2, la versione principale viene aggiunta alla fine del percorso del modulo.

Ad esempio, il percorso del modulo per v2.0.0 di example.com/foo sarebbe example.com/foo/v2.

La best practice consigliata è sviluppare le versioni principali successive a v1 in directory separate denominate in base al suffisso della versione principale.

Per caricare una nuova versione principale 2.0.0 di un modulo con il percorso example.com/foo nel progetto, nel repository e nella località predefiniti quando i valori predefiniti sono configurati:

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

Elencare i moduli

Modalità repository: standard, remoto, virtuale

Esegui il comando seguente per esaminare un modulo Go caricato nel progetto, nel repository e nella località predefiniti quando i valori predefiniti sono configurati:

  gcloud artifacts packages list

L'output sarà simile al seguente:

  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

Visualizzare i dettagli della versione del modulo

Modalità repository: standard, remoto, virtuale

Esegui il comando seguente per visualizzare le versioni di un modulo nel progetto, nel repository e nella località predefiniti quando i valori predefiniti sono configurati:

  gcloud artifacts versions list --package=MODULE_PATH

L'output sarà simile al seguente:

  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

Utilizzare un modulo come dipendenza

Modalità repository: standard, remoto, virtuale

Per importare i moduli archiviati in Artifact Registry, devi indicare a Go di cercare le dipendenze da Artifact Registry e di ignorare il database dei checksum. Segui le istruzioni per configurare l'autenticazione e l'ambiente Go in Configurare l'autenticazione per Go.

  1. Se utilizzi credenziali di breve durata per l'autenticazione ad Artifact Registry, devi aggiornare il token OAuth eseguendo il comando seguente:

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

  2. Se il modulo non ha ancora un file go.mod, cambia directory nella cartella del modulo ed esegui go mod init per creare un file go.mod per il pacchetto.

      go mod init MODULE_PATH

    Sostituisci MODULE_PATH con il percorso del modulo archiviato in Artifact Registry. Per saperne di più, consulta la documentazione di riferimento sui moduli Go.

  3. Per richiedere la versione del modulo archiviato in Artifact Registry, modifica il file go.mod in modo che sia simile al seguente:

    
module example.com/bar

go 1.19

require example.com/foo v0.1.0

    Sostituisci quanto segue:

    • example.com/foo è il percorso del modulo richiesto
    • v0.1.0 è la versione archiviata in Artifact Registry

  4. Includi il percorso del modulo come di consueto nella sezione import del file main.go.

    Ad esempio, per importare un modulo con il percorso example.com/foo archiviato in Artifact Registry, la sezione di importazione potrebbe essere simile alla seguente:

      
  package main

  import (
    foo "example.com/foo"
  )

  func main() {

    ...

  }

  5. Esegui go mod tidy per scaricare le dipendenze:

      go mod tidy

  6. Esegui il modulo come di consueto:

      go run .

    Il modulo archiviato in Artifact Registry viene scaricato e utilizzato come dipendenza.

Eliminare i moduli Go in pacchetto

Modalità repository: standard, remoto

Puoi eliminare un pacchetto e tutte le sue versioni oppure eliminare una versione specifica.

  • Una volta eliminato un pacchetto, non puoi annullare l'azione.

Prima di eliminare un pacchetto o una versione del pacchetto, verifica di aver comunicato o risolto eventuali dipendenze importanti.

Per eliminare un pacchetto:

Console

  1. Apri la pagina Repository nella console Google Cloud .

    Apri la pagina Repositori

  2. Nell'elenco dei repository, fai clic su quello appropriato.

    La pagina Pacchetti elenca i pacchetti nel repository.

  3. Seleziona il pacchetto che vuoi eliminare.

  4. Fai clic su ELIMINA.

  5. Nella finestra di dialogo di conferma, fai clic su ELIMINA.

gcloud

Esegui questo comando:

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

Sostituisci quanto segue:

  • PACKAGE è il nome del pacchetto nel repository.
  • REPOSITORY è il nome del repository. Se hai configurato un repository predefinito, puoi omettere questo flag per utilizzare quello predefinito.
  • LOCATION è la posizione regionale o multiregionale del repository. Utilizza questo flag per visualizzare i repository in una località specifica. Se hai configurato una località predefinita, puoi omettere questo flag per utilizzare quella predefinita.

Il flag --async fa sì che il comando venga restituito immediatamente, senza attendere il completamento dell'operazione in corso.

Per eliminare le versioni di un pacchetto:

Console

  1. Apri la pagina Repository nella console Google Cloud .

    Apri la pagina Repositori

  2. Nell'elenco dei repository, fai clic su quello appropriato.

    La pagina Pacchetti elenca i pacchetti nel repository.

  3. Fai clic su un pacchetto per visualizzarne le versioni.

  4. Seleziona le versioni da eliminare.

  5. Fai clic su ELIMINA.

  6. Nella finestra di dialogo di conferma, fai clic su ELIMINA.

gcloud

Esegui questo comando:

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

Sostituisci quanto segue:

  • VERSION è il nome della versione da eliminare.
  • PACKAGE è il nome del pacchetto nel repository.
  • REPOSITORY è il nome del repository. Se hai configurato un repository predefinito, puoi omettere questo flag per utilizzare quello predefinito.
  • LOCATION è la posizione regionale o multiregionale del repository. Utilizza questo flag per visualizzare i repository in una località specifica. Se hai configurato una località predefinita, puoi omettere questo flag per utilizzare quella predefinita.

Il flag --async fa sì che il comando venga restituito immediatamente, senza attendere il completamento dell'operazione in corso.

Passaggi successivi

  • Prova la guida rapida di Go.
  • Scarica i singoli file associati a un modulo o a una versione senza utilizzare i comandi Go.