Pulling a Go module to the registry

Before pushing, prepare a ZIP archive of your Go module. For more information, see Creating a Go module.

1. Create the following environment variables depending on the authentication method:

   IAM token

   API key

   1. Get an IAM token for the Yandex account or service account you are going to use for authentication.

   2. Create the REGISTRY_USERNAME and REGISTRY_PASSWORD environment variables:

      export REGISTRY_USERNAME="iam"
      export REGISTRY_PASSWORD="<IAM_token>"
      

      Where:

      • REGISTRY_USERNAME: Authentication method.
      • REGISTRY_PASSWORD: Body of the previously obtained IAM token.

   Note

   The IAM token's lifetime is limited to 12 hours.

   1. Create an API key for the service account you are going to use for authentication.

   2. Create the REGISTRY_USERNAME and REGISTRY_PASSWORD environment variables:

      export REGISTRY_USERNAME="api_key"
      export REGISTRY_PASSWORD="<API_key>"
      

      Where:

      • REGISTRY_USERNAME: Authentication method.
      • REGISTRY_PASSWORD: Body of the previously created API key.

   Note

   The API key maximum lifetime is set manually when you create the key.

2. Push the Go module using a PUT HTTP request:

   curl \
     --request PUT \
     --user "$REGISTRY_USERNAME:$REGISTRY_PASSWORD" \
     --header "X-Checksum-SHA256: <file_hash>" \
     --upload-file <local_path_to_ZIP_file> \
     https://registry.yandexcloud.net/go/<registry_ID>/<module_name>/<module_version>/<file_name_in_registry>
   

   Where:

   • --request: Method.

   • --user: Authentication data.

   • --header: API request header. This is an optional setting.

     In the X-Checksum-SHA256 header, you can specify the hash of the file you are pushing to check the file’s integrity after it is pushed. You can generate the hash, e.g., using this command:

     openssl dgst -sha256 <file_path> | awk '{print $2}'
     

   • --upload-file: Local path to the ZIP file.

   • The request URL contains the registry URL, the Go module name and version, and the file name in the registry. For example:

     https://registry.yandexcloud.net/go/cn15fqbr806r********/mymodule/1.0.0/mymodule-v1.0.0.zip
     

   Warning

   In the URL, provide the Go module version without the v prefix; e.g., for version v1.0.0, specify 1.0.0.

   Warning

   When publishing a Go module, do not prefix its name with registry.yandexcloud.net/go/<registry_ID>/. If your Go module's major version is greater than 1, omit the /vN suffix as well; e.g., for a registry.yandexcloud.net/go/<registry_ID>/sample/module/v4 Go module, use sample/module as its name.