Administra módulos de Go

En esta página, se explica cómo administrar los módulos de Go empaquetados y almacenados en Artifact Registry.

Antes de comenzar

1. Si el repositorio de destino no existe, crea un repositorio nuevo. Elegir Go como el formato del repositorio.
2. Verifica que tengas los permisos necesarios para el repositorio.
3. (Opcional) Configura valores predeterminados para los comandos de gcloud.
4. Instalación Ir 1.15 o superior.

5. Instala el complemento package-go-module de gcloud CLI:

   gcloud components install package-go-module

6. Configura Go para autenticar con Artifact Registry.

Funciones requeridas

A fin de obtener los permisos que necesitas para administrar los módulos, solicita a tu administrador que te otorgue el los siguientes roles de IAM en el repositorio:

• Ver módulos: Lector de Artifact Registry (roles/artifactregistry.reader)
• Descarga o instala módulos: Lector de Artifact Registry (roles/artifactregistry.reader)
• Agrega módulos a un repositorio: Escritor de Artifact Registry (roles/artifactregistry.writer)
• Borra módulos: Administrador del repositorio de Artifact Registry (roles/artifactregistry.repoAdmin)

Si quieres obtener más información para otorgar roles, consulta Administra el acceso.

También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

Subir un módulo

Modos de repositorio: Estándar

Para empaquetar y subir un módulo a tu repositorio, ejecuta el siguiente comando:

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

Reemplaza lo siguiente:

• PROJECT por el ID del proyecto de Google Cloud.
• REPOSITORY por el nombre del repositorio en el que se almacena el paquete.
• LOCATION por la configuración regional o multirregional ubicación del repositorio.
• MODULE_PATH por la ruta del módulo Por ejemplo: example.com/foo Consulta la Referencia de los módulos de Go para obtener más información.
• VERSION con el versión semántica del módulo con el formato vX.Y.Z, en el que X es la versión principal, Y es la versión versión secundaria, y Z es la versión del parche.
• SOURCE_LOCATION por la ruta de acceso al directorio raíz de tu cuenta de Go módulo. Si omites la marca --source, el valor predeterminado será el directorio actual.

El módulo se sube a Artifact Registry.

Para obtener más información sobre cómo crear módulos de Go, consulta este instructivo.

Subir una nueva versión del módulo

Modos de repositorio: Estándar

Para subir una versión nueva de tu módulo al proyecto, al repositorio y al ubicación cuando los valores predeterminados están configurados Ejecuta el siguiente comando con el nuevo número de versión:

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

Reemplaza VERSION por la versión del módulo actualizado. Por ejemplo: Para subir la versión 0.1.1 de un módulo con la ruta example.com/foo, ejecuta el comando siguiente comando:

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

Para marcar un módulo como versión previa al lanzamiento, agrega un guion después del VERSION y adjunta los identificadores previos al lanzamiento de tu módulo:

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

Reemplaza PRE_RELEASE_IDENTIFIERS con caracteres alfanuméricos ASCII separados por puntos caracteres y guiones. Por ejemplo, para subir una versión previa al lanzamiento de un módulo con el módulo de la ruta de acceso example.com/foo identificado por alpha.x.12m.5, ejecuta siguiente comando:

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

Nota: Los identificadores previos al lanzamiento deben estar separados por puntos en formato ASCII alfanumérico caracteres y guiones. No se admiten los metadatos. Para obtener más información control de versiones, consulta Control de versiones semántico 2.0.0 y esta entrada de blog para los detalles específicos de Go.

Sube una nueva versión principal

Modos de repositorio: Estándar

Las versiones principales no son retrocompatibles con versiones anteriores. Para evitar que los usuarios importen un cambio rotundo, las versiones principales posteriores a v1 deben tener rutas de módulo diferentes a las de versiones anteriores. A partir de v2, la principal se agrega al final de la ruta del módulo.

Por ejemplo, la ruta del módulo para v2.0.0 de example.com/foo sería la siguiente: example.com/foo/v2.

La práctica recomendada es desarrollar versiones principales después de v1 en directorios separados que llevan el nombre de su sufijo de versión principal.

Para subir una nueva versión principal 2.0.0 de un módulo con la ruta de acceso example.com/foo al proyecto, repositorio y ubicación predeterminados cuando se configuran valores predeterminados:

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

Enumerar módulos

Modos de repositorio: Estándar

Ejecuta el siguiente comando para inspeccionar un módulo de Go subido en la configuración predeterminada el proyecto, el repositorio y la ubicación se configuran valores predeterminados:

  gcloud artifacts packages list

El resultado será similar al siguiente:

  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

Ver detalles de la versión del módulo

Modos de repositorio: Estándar

Ejecuta el siguiente comando para ver las versiones de un módulo en la configuración el proyecto, el repositorio y la ubicación se configuran valores predeterminados:

  gcloud artifacts versions list --package=MODULE_PATH

El resultado será similar al siguiente:

  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

Cómo usar un módulo como dependencia

Modos de repositorio: Estándar

Para importar módulos almacenados en Artifact Registry, debes indicar a Go en buscar dependencias de Artifact Registry y omite la suma de comprobación en la base de datos. Sigue las instrucciones para configurar la autenticación y Go en Configura la autenticación para Go.

1. Si usas credenciales de corta duración para la autenticación a Artifact Registry, deberás actualizar tu token de OAuth ejecutando el siguiente comando:

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

2. Si tu módulo aún no tiene un archivo go.mod, cambia de directorio a la carpeta de tu módulo y ejecuta go mod init para crear un archivo go.mod para tu paquete.

     go mod init MODULE_PATH
   

   Reemplaza MODULE_PATH por la ruta del módulo para el módulo almacenado en Artifact Registry. Consulta la Referencia de los módulos de Go para obtener más información.

3. Para solicitar la versión de tu módulo almacenada en Artifact Registry, edita Tu archivo go.mod se verá de la siguiente manera:

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

   Reemplaza lo siguiente:

   • example.com/foo es la ruta de acceso del módulo requerido.
   • v0.1.0 es la versión almacenada en Artifact Registry.

4. Incluye la ruta de acceso del módulo como de costumbre en la sección import de tu main.go. .

   Por ejemplo, para importar un módulo con la ruta de acceso example.com/foo almacenada en Artifact Registry, tu sección de importación podría parecerse a la siguiente:

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

5. Ejecuta go mod tidy para descargar dependencias:

     go mod tidy
   

6. Ejecuta tu módulo como de costumbre:

     go run .
   

   El módulo almacenado en Artifact Registry se descarga y se usa como un dependencia.

Borrar módulos de Go empaquetados

Modos de repositorio: Estándar

Puedes borrar un paquete y todas sus versiones, o bien borrar una versión específica.

• Una vez que borres un paquete, no podrás deshacer la acción.

Antes de borrar un paquete o una versión de un paquete, verifica que se haya comunicado o abordado cualquier dependencia importante en este.

Para borrar un paquete, haz lo siguiente:

Console

1. Abre la página Repositorios en la consola de Google Cloud.

   Abrir la página Repositorios

2. En la lista de repositorios, haz clic en el repositorio correspondiente.

   En la página Paquetes, se enumeran los paquetes del repositorio.

3. Selecciona el paquete que quieres borrar.

4. Haz clic en BORRAR.

5. En el cuadro de diálogo de confirmación, haz clic en BORRAR.

gcloud

Ejecuta el siguiente comando:

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

Dónde

• PACKAGE es el nombre del paquete en el repositorio.
• REPOSITORY es el nombre del repositorio. Si configuraste un repositorio predeterminado, puedes omitir esta marca para usarlo.
• LOCATION es un regional o multirregional location. Usa esta marca para ver los repositorios en una ubicación específica. Si configuraste una ubicación predeterminada, puedes omitir esta marca para usar el valor predeterminado.
• --async se muestra de inmediato, sin necesidad de esperar a que se complete la operación en curso.

Sigue estos pasos para borrar versiones de un paquete:

Console

1. Abre la página Repositorios en la consola de Google Cloud.

   Abrir la página Repositorios

2. En la lista de repositorios, haz clic en el repositorio correspondiente.

   En la página Paquetes, se enumeran los paquetes del repositorio.

3. Haz clic en un paquete para ver sus versiones.

4. Selecciona las versiones que deseas borrar.

5. Haz clic en BORRAR.

6. En el cuadro de diálogo de confirmación, haz clic en BORRAR.

gcloud

Ejecuta el siguiente comando:

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

Dónde

• PACKAGE es el nombre del paquete en el repositorio.
• REPOSITORY es el nombre del repositorio. Si configuraste un repositorio predeterminado, puedes omitir esta marca para usarlo.
• LOCATION es un regional o multirregional location. Usa esta marca para ver los repositorios en una ubicación específica. Si configuraste una ubicación predeterminada, puedes omitir esta marca para usar el valor predeterminado.
• --async se muestra de inmediato, sin necesidad de esperar a que se complete la operación en curso.

¿Qué sigue?

• Prueba la guía de inicio rápido de Go.
• Cómo descargar archivos individuales asociados con un módulo o una versión sin usar los comandos de Go.