Guía de inicio rápido para Node.js

En esta guía de inicio rápido, se muestra cómo configurar un repositorio de paquetes de Node.js para Artifact Registry y subir un paquete a él.

Antes de comenzar

  1. Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.
  2. En la página del selector de proyectos de Google Cloud Console, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  3. Asegúrate de que la facturación esté habilitada para tu proyecto de Cloud. Descubre cómo confirmar que tienes habilitada la facturación en un proyecto.

  4. Habilita la API Artifact Registry.

    Habilita la API

  5. Instala e inicializa el SDK de Cloud.
  6. Instala PowerShell si deseas conectarte a un repositorio de paquetes de Node.js desde Windows.

Crea un repositorio de paquetes de Node.js

Crea el repositorio de tus artefactos de Node.js.

  1. Crea el repositorio.

    Console

    1. Abre la página Repositorios en Cloud Console.

      Abrir la página Repositorios

    2. Haz clic en Crear repositorio.

    3. Especifica quickstart-nodejs-repo como el nombre del repositorio.

    4. Elige npm como formato.

    5. En Tipo de ubicación, selecciona Región y, luego, elige la ubicación us-central1.

    6. Haga clic en Crear.

    El repositorio se agrega a la lista de repositorios.

    gcloud

    1. Ejecuta el siguiente comando para crear un nuevo repositorio de paquetes de Node.js llamado quickstart-nodejs-repo en la ubicación us-central1 con la descripción “Repositorio de Node.js”.

      gcloud artifacts repositories create quickstart-nodejs-repo --repository-format=npm \
      --location=us-central1 [--description="Node.js package repository"]
      
    2. Ejecuta el siguiente comando para verificar que se haya creado el repositorio:

      gcloud artifacts repositories list
      

    Para obtener más información sobre los comandos de Artifact Registry, ejecuta el comando gcloud artifacts.

  2. Para simplificar los comandos de gcloud, configura el repositorio predeterminado como quickstart-nodejs-repo y la ubicación predeterminada como us-central1. Una vez configurados los valores, no necesitas especificarlos en los comandos de gcloud que requieren un repositorio o una ubicación.

    Para configurar el repositorio, ejecuta el siguiente comando:

    gcloud config set artifacts/repository quickstart-nodejs-repo
    

    Para configurar la ubicación, ejecuta el siguiente comando:

    gcloud config set artifacts/location us-central1
    

    Para obtener más información sobre estos comandos, consulta la documentación de establecimiento de la configuración de gcloud.

Configura una cuenta de servicio para tu cliente

Crea o selecciona una cuenta de servicio existente que actúe en nombre de la Administración de socios de red.

  1. Crea una cuenta de servicio que actúe en nombre de tu aplicación o elige una cuenta de servicio existente que uses para la automatización.

    Necesitarás la ubicación del archivo de claves de la cuenta de servicio para configurar la autenticación con Artifact Registry. En las cuentas existentes, puedes ver claves y crear claves nuevas en la página Cuentas de servicio.

    Ir a la página Cuentas de servicio

  2. Otorga a la cuenta de servicio acceso de lectura y escritura a tu repositorio.

    gcloud artifacts repositories add-iam-policy-binding \
    quickstart-nodejs-repo --location=us-central1 --member=serviceAccount:ACCOUNT --role=roles/artifactregistry.writer
    

    En el ejemplo anterior, ACCOUNT es el ID de tu cuenta de servicio con el formato USERNAME@PROJECT-ID.iam.gserviceaccount.com.

  3. Asigna la ubicación del archivo de claves de la cuenta de servicio a la variable GOOGLE_APPLICATION_CREDENTIALS para que el auxiliar de credenciales de Artifact Registry pueda obtener tu clave cuando se conecta con repositorios.

    export GOOGLE_APPLICATION_CREDENTIALS=KEY-FILE
    

    En el ejemplo anterior, KEY-FILE es la ruta de acceso al archivo de claves de la cuenta de servicio.

    Para obtener información sobre cómo configurar la autenticación de la contraseña mediante el archivo de claves de la cuenta de servicio, consulta la documentación de authentication#auth-password.

Configura la Administración de socios de red

  1. Crea un paquete npm para subir. Si no tienes un paquete disponible para usar con esta guía de inicio rápido, ejecuta el siguiente comando a fin de crear un archivo package.json sin formato:

    npm init -y
    
  2. Configura tu proyecto de la Administración de socios de red para que se implemente en el repositorio de Artifact Registry que creaste.

    1. Ejecuta el siguiente comando. El comando muestra la configuración que se debe agregar a tu archivo de configuración de la Administración de socios de red.

      gcloud artifacts print-settings npm --scope=@quickstart
      

      El permiso quickstart está asociado con el repositorio. Cuando incluyes el alcance en comandos para publicar o instalar paquetes, npm usa tu repositorio. Cuando publicas o instalas paquetes sin un alcance, se usa el repositorio predeterminado que configuraste. Para obtener más información, consulta la descripción general de Node.js.

      El resultado del comando de gcloud se ve así:

      @quickstart:registry=https://us-central1-npm.pkg.dev/PROJECT/quickstart-nodejs-repo/
      //us-central1-npm.pkg.dev/PROJECT/quickstart-nodejs-repo/:_authToken=""
      //us-central1-npm.pkg.dev/PROJECT/quickstart-nodejs-repo/:always-auth=true
      
    2. Agrega la configuración del paso anterior al archivo .npmrc de tu proyecto. El archivo suele estar en el mismo directorio que el archivo package.json.

      Reemplaza PROJECT con el ID del proyecto.

      Para obtener más información sobre el archivo .npmrc, consulta la descripción general de Node.js.

Cada repositorio de paquetes de Node.js para Artifact Registry está asociado a un extremo de registro de npm https://LOCATION-npm.pkg.dev/PROJECT/REPOSITORY. Si creas otro repositorio de paquetes de Artifact Registry para Node.js, npm interactúa con él como un registro independiente con su propio alcance.

Sube un paquete al repositorio

  1. Elige un paquete que desees subir. Asegúrate de que el nombre del paquete en package.json incluya el permiso quickstart.

    "name": "@quickstart/my-package"
    
  2. Actualiza el token de acceso para conectarte al repositorio. google-artifactregistry-auth es una biblioteca cliente que actualiza las credenciales de los repositorios de Artifact Registry. Para actualizar las credenciales, usa una de estas opciones:

    • Agrega una secuencia de comandos al archivo package.json en tu proyecto.

      "scripts": {
        "artifactregistry-login": "npx google-artifactregistry-auth"
      }
      

      Ejecuta la secuencia de comandos mediante el siguiente comando:

      npm run artifactregistry-login PROJECT-NPMRC
      

      En el ejemplo anterior, PROJECT-NPMRC es la ruta de acceso al archivo .npmrc en el directorio de tu proyecto.

    • Para las versiones de la Administración de socios de red anteriores a 5.2.0, realiza los siguientes pasos:

      1. Ejecuta el comando:
      npm install google-artifactregistry-auth --save-dev --registry https://registry.npmjs.org/
      
      1. Agrégala a una secuencia de comandos de autenticación:
      "scripts": {
          "artifactregistry-login": "./node_modules/.bin/artifactregistry-auth",
      }
      

      Ejecuta la secuencia de comandos mediante el siguiente comando:

      npm run artifactregistry-login PROJECT-NPMRC
      

      En el ejemplo anterior, PROJECT-NPMRC es la ruta de acceso al archivo .npmrc en el directorio de tu proyecto.

  3. Agrega tu paquete al repositorio. Puedes usar un comando de npm o yarn.

    npm publish
    
    yarn publish
    

Visualiza el paquete en el repositorio

Para verificar que tu paquete se haya agregado al repositorio, haz lo siguiente:

Console

  1. Abre la página Repositorios en Cloud Console.

    Abrir la página Repositorios

  2. En la lista de repositorios, haz clic en el repositorio quickstart-nodejs-repo.

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

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

gcloud

Para enumerar las imágenes en el repositorio quickstart-nodejs-repo predeterminado, ejecuta el siguiente comando:

 gcloud artifacts packages list

Para ver las versiones de un paquete, ejecuta el siguiente comando:

gcloud artifacts versions list --package=PACKAGE

En el ejemplo anterior, PACKAGE es el ID del paquete.

Instala paquetes

Para instalar un paquete desde el repositorio de paquetes de Node.js, usa el comando npm install o yarn add. Reemplaza PACKAGE por el nombre del paquete.

npm install @quickstart/PACKAGE
yarn add @quickstart/PACKAGE

Limpia

Sigue estos pasos para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos que usaste en esta página.

Antes de quitar un repositorio, asegúrate de que los paquetes que quieres conservar estén disponibles en otra ubicación.

Para borrar el repositorio, haz lo siguiente:

Console

  1. Abre la página Repositorios en Cloud Console.

    Abrir la página repositorios

  2. En la lista de repositorios, selecciona el repositorio quickstart-nodejs-repo.

  3. Haz clic en Borrar.

gcloud

  1. Para borrar el repositorio quickstart-nodejs-repo, ejecuta el siguiente comando:

    gcloud artifacts repositories delete quickstart-nodejs-repo
    
  2. Si deseas quitar la configuración predeterminada de la ubicación y del repositorio que estableciste para la configuración activa de gcloud, ejecuta los siguientes comandos:

    gcloud config unset artifacts/repository
    gcloud config unset artifacts/location
    

¿Qué sigue?