Comprendre les spécifications de construction - AWS Amplify Hébergement

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Comprendre les spécifications de construction

La spécification de construction d'une application Amplify est un ensemble de YAML paramètres et de commandes de génération qu'Amplify utilise pour exécuter votre build. La liste suivante décrit ces paramètres et leur mode d'utilisation.

version

Le numéro de YAML version d'Amplify.

appRoot

Le chemin dans le référentiel dans lequel réside cette application. Ignoré sauf si plusieurs applications sont définies.

env

Ajoutez des variables d'environnement à cette section. Vous pouvez également ajouter des variables d'environnement à l'aide de la console.

dorsal

Exécutez CLI les commandes Amplify pour provisionner un backend, mettre à jour des fonctions Lambda ou des schémas GraphQL dans le cadre d'un déploiement continu.

frontend

Exécutez les commandes de construction du frontend.

test

Exécutez des commandes pendant une phase de test. Découvrez comment ajouter des tests à votre application.

phases de construction

Le frontend, le backend et le test comportent trois phases qui représentent les commandes exécutées au cours de chaque séquence de construction.

  • preBuild- Le preBuild script s'exécute avant le début de la compilation proprement dite, mais une fois qu'Amplify a installé les dépendances.

  • génération : vos commandes de génération.

  • postBuild- Le script post-build s'exécute une fois la compilation terminée et Amplify a copié tous les artefacts nécessaires dans le répertoire de sortie.

chemin de construction

Le chemin à utiliser pour exécuter le build. Amplify utilise ce chemin pour localiser les artefacts de votre build. Si vous ne spécifiez pas de chemin, Amplify utilise la racine de l'application monorepo, par exemple. apps/app

artéfacts > répertoire de base

Le répertoire dans lequel se trouvent vos artefacts de build.

artéfacts > fichiers

Spécifiez les fichiers à partir de vos artefacts que vous souhaitez déployer. Entrez **/* pour inclure tous les fichiers.

cache

Spécifie les dépendances au moment de la construction, telles que le dossier node_modules. Lors de la première génération, les chemins fournis ici sont mis en cache. Lors des versions suivantes, Amplify restaure le cache sur les mêmes chemins avant d'exécuter vos commandes.

Amplify considère que tous les chemins de cache fournis sont relatifs à la racine de votre projet. Cependant, Amplify n'autorise pas le passage en dehors de la racine du projet. Par exemple, si vous spécifiez un chemin absolu, la génération réussira sans erreur, mais le chemin ne sera pas mis en cache.

L'exemple suivant de spécification de construction illustre la YAML syntaxe de base.

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*