En esta página, se describe cómo configurar Cloud Build para compilar y probar tus aplicaciones de Node.js
.
Cloud Build permite usar cualquier imagen de contenedor disponible a nivel público para ejecutar tareas. La imagen node
de Docker Hub pública viene preinstalada con las herramientas de npm
y yarn
. Se puede configurar Cloud Build para compilar el proyecto de Node.js
con estas herramientas.
Antes de comenzar
En las instrucciones de esta página, se da por hecho que estás familiarizado con Node.js
. Además, ten en cuenta la siguiente información:
- Ten el proyecto
Node.js
a mano, incluidos los archivospackage.json
ytest.js
. - Asegúrate de que el archivo
package.json
incluya una secuencia de comandosstart
y unatest
. - Para ejecutar los comandos de
gcloud
en esta página, instala la CLI de Google Cloud.
Compila con npm
o yarn
Para ejecutar tareas en la imagen node
de Docker Hub, especifica la URL de la imagen en el campo name
del archivo de configuración de Cloud Build.
Cloud Build inicia el contenedor especificado en el campo name
mediante el punto de entrada predeterminado de la imagen. Para anular el punto de entrada predeterminado y definir cómo se debe ejecutar el paso de compilación cuando se invoca, agrega un campo entrypoint
en el paso de compilación. La imagen node
en Docker Hub viene preinstalada con las herramientas de npm
y yarn
. Especifica las herramientas en el campo entrypoint
para invocarlas como el punto de entrada del paso de compilación.
En el siguiente ejemplo de archivo de configuración de compilación, se dan las siguientes situaciones:
- En el campo
name
, se especifica que Cloud Build usa la imagennode
de Docker Hub para ejecutar la tarea. Cuando especificas la imagennode
, puedes omitir la versión del nodo por defecto a:latest
o especificar una versión de nodo para usar una versión específica. Por ejemplo,name: node
usará la versión más reciente del nodo, yname: node:12
usaránode:12
. En el campo
entrypoint
, se especifica que la herramientanpm
oyarn
se usa cuando se invoca la imagennode
.
npm
steps:
- name: node
entrypoint: npm
yarn
steps:
- name: node
entrypoint: yarn
Configura compilaciones de Node.js
En el directorio raíz del proyecto, crea un archivo de configuración llamado
cloudbuild.yaml
.Instala dependencias: Antes de compilar la aplicación, debes asegurarte de que todas las dependencias del proyecto estén instaladas desde
npm
oyarn
. Puedes instalar dependencias mediante el comandoinstall
dentro del paso de compilaciónnpm
oyarn
. En el campoargs
de un paso de compilación, se toma una lista de argumentos y se los pasa a la imagen a la que hace referencia el campo de nombre. En el archivo de configuración de compilación, agregainstall
al campoargs
para invocar el comandoinstall
:npm
steps: - name: node entrypoint: npm args: ['install']
yarn
steps: - name: node entrypoint: yarn args: ['install']
Agrega pruebas: Si definiste una secuencia de comandos
test
enpackage.json
, puedes configurar Cloud Build para que ejecute la secuencia mediante la agregación detest
al campoargs
:npm
steps: - name: node entrypoint: npm args: ['install'] - name: node entrypoint: npm args: ['test']
yarn
steps: - name: node entrypoint: yarn args: ['install'] - name: node entrypoint: yarn args: ['test']
Ejecuta comandos personalizados: Si
package.json
contiene comandos personalizados, puedes configurar Cloud Build para ejecutar ese comando. En el campoargs
, agregarun
como primer argumento seguido del nombre del comando personalizado. El siguiente archivo de configuración de compilación tiene argumentos para ejecutar un comando personalizado llamadobuild
:npm
steps: - name: node entrypoint: npm args: ['install'] - name: node entrypoint: npm args: ['test'] - name: node entrypoint: npm args: ['run', 'build']
yarn
steps: - name: node entrypoint: yarn args: ['install'] - name: node entrypoint: yarn args: ['test'] - name: node entrypoint: yarn args: ['run', 'build']
Usa este comando para comenzar a compilar mediante el archivo de configuración de compilación:
gcloud builds submit --region=REGION --config [CONFIG_FILE_PATH] [SOURCE_DIRECTORY]
Donde:
[CONFIG_FILE_PATH]
es la ruta de acceso al archivo de configuración de compilación.[SOURCE_DIRECTORY]
es la ruta de acceso o la URL al código fuente.[REGION]
es una de las regiones de compilación compatibles.
Si no se especifica
[CONFIG_FILE_PATH]
ni[SOURCE_DIRECTORY]
en el comandogcloud builds submit
, Cloud Build da por hecho que el archivo de configuración y el código fuente están en el directorio de trabajo actual.
Ejecuta pruebas en varias versiones de node
En ocasiones, es necesario asegurarse de que el proyecto funcione en varias versiones de node
. Puedes crear y configurar activadores de Cloud Build de modo que se den las siguientes situaciones:
- En el archivo de configuración de compilación, especifica la versión de
node
como una variable de sustitución. - Crea un activador para cada versión de
node
con la que desees compilar la aplicación. - En cada una de las opciones de configuración del activador, usa el campo de valor de la variable de sustitución a fin de indicar la versión de
node
de ese activador.
En los siguientes pasos, se explica cómo especificar la versión de node
mediante variables de sustitución específicas del activador:
En la raíz del repositorio, agrega un archivo de configuración de compilación, en el que se especifique la versión de
node
como una variable de sustitución. En el siguiente ejemplo de archivo de configuración de compilación,$_NODE_VERSION
es una variable de sustitución definida por el usuario:npm
steps: - name: node:$_NODE_VERSION entrypoint: npm args: ['install'] - name: node:$_NODE_VERSION entrypoint: npm args: ['test']
yarn
steps: - name: node:$_NODE_VERSION entrypoint: yarn args: ['install'] - name: node:$_NODE_VERSION entrypoint: yarn args: ['test']
Para cada versión de
node
que desees compilar, crea un activador de compilación mediante los siguientes pasos:Abre la página Activadores en Google Cloud Console:
Selecciona el proyecto en el menú desplegable del selector de proyectos, que se ubica en la parte superior de la página.
Haz clic en Abrir.
Haz clic en Crear activador.
En la página Crear activador, ingresa la siguiente configuración:
Ingresa un nombre para el activador.
Selecciona el evento del repositorio para iniciar el activador.
Selecciona el repositorio que contenga el código fuente y el archivo de configuración de compilación.
Especifica la regex de la rama o el nombre de la etiqueta que iniciará el activador.
Configuración: Elige el archivo de configuración de compilación que creaste con anterioridad.
En Substitution variables, haz clic en Agregar variable.
- En Variable, especifica la variable de versión de
node
que usaste en el archivo de configuración de compilación, y, en Valor, especifica la versión delnode
. Por ejemplo,_NODE_VERSION
y12
.
- En Variable, especifica la variable de versión de
Haz clic en Crear para guardar el activador de compilación.
Puedes usar estos activadores para compilar el código en la versión del node
que especificaste en el activador.
Ejemplos de código
Estos son algunos repositorios de muestra. Cada uno contiene una aplicación de Node.js
de muestra y un archivo de configuración de compilación para compilar y probar esa aplicación:
- node-example-npm: Una app de
Node.js
y un archivo de configuración de compilación de ejemplo para compilar la app connpm
. - node-example-yarn: Una app de
Node.js
y un archivo de configuración de compilación de ejemplo para compilar la app conyarn
. - multiple-node-versions-example: Un ejemplo con un archivo de configuración de compilación para compilar la app con varias versiones del
node
.
¿Qué sigue?
- Obtén más información sobre cómo compilar imágenes de contenedores.
- Obtén más información sobre cómo compilar aplicaciones de Go.
- Obtén más información para solucionar errores de compilación.