Configurazione delle impostazioni di build monorepo

Quando si archiviano più progetti o microservizi in un unico repository, si parla di monorepo. Puoi utilizzare Amplify Hosting per distribuire applicazioni in un monorepo senza creare più configurazioni di build o configurazioni di filiale.

Amplify supporta app in monorepo generici e app in monorepo create utilizzando npm workspace, pnpm workspace, Yarn workspace, Nx e Turborepo. Quando distribuisci la tua app, Amplify rileva automaticamente lo strumento di creazione monorepo che stai utilizzando. Amplify applica automaticamente le impostazioni di build per le app in un'area di lavoro npm, un'area di lavoro Yarn o Nx. Le app Turborepo e pnpm richiedono una configurazione aggiuntiva. Per ulteriori informazioni, consulta Configurazione delle app Turborepo e pnpm monorepo.

Puoi salvare le impostazioni di build per un monorepo nella console Amplify oppure puoi scaricare il amplify.yml file e aggiungerlo alla radice del tuo repository. Amplify applica le impostazioni salvate nella console a tutte le tue filiali a meno che non trovi amplify.yml un file nel tuo repository. Quando un amplify.yml file è presente, le sue impostazioni sostituiscono tutte le impostazioni di build salvate nella console Amplify.

Riferimento alla sintassi delle specifiche di build di Monorepo YAML

La YAML sintassi per una specifica di build monorepo è diversa dalla YAML sintassi per un repository che contiene una singola applicazione. Per un monorepo, si dichiara ogni progetto in un elenco di applicazioni. È necessario fornire la seguente appRoot chiave aggiuntiva per ogni applicazione dichiarata nelle specifiche di build del monorepo:

Il seguente esempio di specifica di build monorepo dimostra come dichiarare più applicazioni Amplify nello stesso repository. Le due app, e sono dichiarate nell'react-appelenco. angular-app applications La appRoot chiave di ogni app indica che l'app si trova nella cartella apps principale del repository.

L'buildpathattributo è impostato per / eseguire e creare l'app dalla radice del progetto monorepo. L'baseDirectoryattributo è il percorso relativo di. buildpath

version: 1
applications:
  - appRoot: apps/react-app
    env:
      variables:
        key: value
    backend:
      phases:
        preBuild:
          commands:
            - *enter command*
        build:
          commands:
            - *enter command*
        postBuild:
            commands:
            - *enter command*
    frontend:
      buildPath: / # Run install and build from the monorepo project root
      phases:
        preBuild:
          commands:
            - *enter command*
            - *enter command*
        build:
          commands:
            - *enter command*
      artifacts:
        files:
            - location
            - location
        discard-paths: yes
        baseDirectory: location
      cache:
        paths:
            - path
            - path
    test:
      phases:
        preTest:
          commands:
            - *enter command*
        test:
          commands:
            - *enter command*
        postTest:
          commands:
            - *enter command*
      artifacts:
        files:
            - location
            - location
        configFilePath: *location*
        baseDirectory: *location*
  - appRoot: apps/angular-app
    env:
      variables:
        key: value
    backend:
      phases:
        preBuild:
          commands:
            - *enter command*
        build:
          commands:
            - *enter command*
        postBuild:
            commands:
            - *enter command*
    frontend:
      phases:
        preBuild:
          commands:
            - *enter command*
            - *enter command*
        build:
          commands:
            - *enter command*
      artifacts:
        files:
            - location
            - location
        discard-paths: yes
        baseDirectory: location
      cache:
        paths:
            - path
            - path
    test:
      phases:
        preTest:
          commands:
            - *enter command*
        test:
          commands:
            - *enter command*
        postTest:
          commands:
            - *enter command*
      artifacts:
        files:
            - location
            - location
        configFilePath: *location*
        baseDirectory: *location*
    

Un'app che utilizza la specifica di build di esempio seguente verrà creata nella radice del progetto e gli elementi di compilazione si troveranno in. /packages/nextjs-app/.next

applications:
  - frontend:
      buildPath: '/'  # run install and build from monorepo project root
      phases:
        preBuild:
          commands:
            - npm install
        build:
          commands:
            - npm run build --workspace=nextjs-app
      artifacts:
        baseDirectory: packages/nextjs-app/.next
        files:
          - '**/*'
      cache:
        paths:
          - node_modules/**/*
    appRoot: packages/nextjs-app

Impostazione della variabile di ambiente AMPLIFY MONOREPO _ _ APP _ ROOT

Quando distribuisci un'app archiviata in un monorepo, la variabile di AMPLIFY_MONOREPO_APP_ROOT ambiente dell'app deve avere lo stesso valore del percorso della radice dell'app, rispetto alla radice del tuo repository. Ad esempio, un monorepo denominato ExampleMonorepo con una cartella principale denominataapps, che contiene, app1app2, e app3 ha la seguente struttura di directory:

ExampleMonorepo
  apps
    app1
    app2
    app3

In questo esempio, il valore della variabile di AMPLIFY_MONOREPO_APP_ROOT ambiente for app1 è. apps/app1

Quando distribuisci un'app monorepo utilizzando la console Amplify, la console imposta automaticamente la variabile di AMPLIFY_MONOREPO_APP_ROOT ambiente utilizzando il valore specificato per il percorso alla radice dell'app. Tuttavia, se l'app monorepo esiste già in Amplify o viene distribuita utilizzando AWS CloudFormation, è necessario impostare manualmente la variabile di ambiente nella sezione Variabili di AMPLIFY_MONOREPO_APP_ROOT ambiente della console Amplify.

Impostazione automatica della variabile di ambiente AMPLIFY _ _ _ durante la distribuzione MONOREPO APP ROOT

Le seguenti istruzioni mostrano come implementare un'app monorepo con la console Amplify. Amplify imposta automaticamente AMPLIFY_MONOREPO_APP_ROOT la variabile di ambiente utilizzando la cartella principale dell'app specificata nella console.

Impostazione della variabile di ROOT ambiente AMPLIFY MONOREPO APP _ _ _ per un'app esistente

Utilizza le seguenti istruzioni per impostare manualmente la variabile di AMPLIFY_MONOREPO_APP_ROOT ambiente per un'app che è già distribuita su Amplify o che è stata creata utilizzando. CloudFormation

Configurazione delle app Turborepo e pnpm monorepo

Gli strumenti di compilazione Turborepo e pnpm workspace monorepo ottengono informazioni di configurazione dai file. .npmrc Quando distribuisci un'app monorepo creata con uno di questi strumenti, devi avere un file nella directory principale del progetto. .npmrc

Nel .npmrc file, imposta il linker per l'installazione dei pacchetti Node su. hoisted Puoi copiare la riga seguente nel tuo file.

node-linker=hoisted

Per ulteriori informazioni su .npmrc file e impostazioni, consulta pnpm .npmrc nella documentazione di pnpm.

Pnpm non è incluso nel contenitore di build predefinito di Amplify. Per le app pnpm workspace e Turborepo, devi aggiungere un comando per installare pnpm nella fase delle impostazioni di compilazione dell'app. preBuild

L'esempio seguente, estratto da una specifica di build, mostra una fase con un comando per installare pnpm. preBuild

version: 1
applications:
  - frontend:
      phases:
        preBuild:
          commands:
            - npm install -g pnpm