Descripción de la especificación de compilación - AWS Amplify Hospedaje

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Descripción de la especificación de compilación

La especificación de compilación de una aplicación de Amplify es un conjunto de YAML ajustes y comandos de compilación que Amplify utiliza para ejecutar la compilación. En la siguiente lista se describen estas configuraciones y cómo se utilizan.

versión

El número de YAML versión de Amplify.

appRoot

La ruta dentro del repositorio en el que reside esta aplicación. Se omite a menos que se definan varias aplicaciones.

env

Añada variables de entorno a esta sección. También puede añadir variables de entorno a través de la consola.

backend

Ejecute CLI los comandos Amplify para aprovisionar un backend, actualizar las funciones de Lambda o los esquemas de GraphQL como parte de una implementación continua.

frontend

Ejecute los comandos de compilación de frontend.

prueba

Ejecute comandos durante una fase de prueba. Aprenda a añadir pruebas a su aplicación.

fases de compilación

Tanto el frontend como el backend tienen tres fases que representan la ejecución de comandos durante cada secuencia de la compilación.

  • preBuild- El preBuild script se ejecuta antes de que comience la compilación real, pero después de que Amplify instale las dependencias.

  • build: los comandos de compilación.

  • postBuild- El script posterior a la compilación se ejecuta una vez finalizada la compilación y Amplify ha copiado todos los artefactos necesarios en el directorio de salida.

buildpath

La ruta que se utilizará para ejecutar la compilación. Amplify utiliza esta ruta para localizar sus artefactos de compilación. Si no especifica una ruta, Amplify utiliza la raíz de la aplicación monorepo, por ejemplo. apps/app

artifacts>base-directory

El directorio en el que están los artefactos de compilación.

artifacts>files

Especifique los archivos de los artefactos que desee implementar. Introduzca **/* para incluir todos los archivos.

memoria caché

Especifica las dependencias en tiempo de compilación, como la carpeta node_modules. Durante la primera compilación, las rutas que se proporcionan aquí se almacenan en caché. En compilaciones posteriores, Amplify restaura la caché en las mismas rutas antes de ejecutar tus comandos.

Amplify considera que todas las rutas de caché proporcionadas son relativas a la raíz del proyecto. Sin embargo, Amplify no permite salir de la raíz del proyecto. Por ejemplo, si especificas una ruta absoluta, la compilación se realizará correctamente sin errores, pero la ruta no se almacenará en caché.

En el siguiente ejemplo de una especificación de compilación, se muestra la YAML sintaxis básica.

version: 1
env:
  variables:
    key: value
backend:
  phases:
    preBuild:
      commands:
        - *enter command*
    build:
      commands:
        - *enter command*
    postBuild:
        commands:
        - *enter command*
frontend:
  buildpath:
  phases:
    preBuild:
      commands:
        - cd react-app
        - npm ci
    build:
      commands:
        - npm run build
  artifacts:
    files:
        - location
        - location
    discard-paths: yes
    baseDirectory: location
  cache:
    paths:
        - path # A cache path relative to the project root
        - path # Traversing outside of the project root is not allowed
test:
  phases:
    preTest:
      commands:
        - *enter command*
    test:
      commands:
        - *enter command*
    postTest:
      commands:
        - *enter command*
  artifacts:
    files:
        - location
        - location
    configFilePath: *location*
    baseDirectory: *location*