Esecuzione di un passaggio di build personalizzato

Per impostazione predefinita, il runtime Node.js eseguirà npm run build se viene rilevato uno script build nel file package.json. Se hai bisogno di un maggiore controllo sui passaggi di build prima di avviare l'applicazione, puoi fornire un passaggio di build personalizzato. Puoi eseguire passi di build personalizzati aggiungendo gcp-build nel file package.json.

Per impedire alla build di eseguire lo script npm run build, devi:

  • Aggiungi uno script gcp-build con un valore vuoto nel file package.json: "gcp-build":"". Per maggiori dettagli sulla configurazione di package.json, consulta Configurazioni buildpack Node.js.
  • Aggiungi la variabile di ambiente di build GOOGLE_NODE_RUN_SCRIPTS con un valore vuoto nel file app.yaml.

    build_env_variables:
      GOOGLE_NODE_RUN_SCRIPTS: ''
    
Per dettagli su come specificare le variabili di ambiente di build, consulta la sezione build_env_variables nel file app.yaml.

Quando viene eseguito questo script, sono disponibili le dipendenze nei campi dependencies e devDependencies del file package.json. Dopo aver eseguito il passaggio di build personalizzato, App Engine rimuove e rigenera la cartella node_modules installando solo le dipendenze di produzione dichiarate nel campo dependencies del file package.json.

Per ulteriori informazioni su come configurare il runtime per i passi di build personalizzati, consulta Esecuzione di passi di build personalizzati durante il deployment per i buildpack Node.js.

Esempio

Uno script di build personalizzato può essere utilizzato per le attività di pre-elaborazione, ad esempio la pre-elaborazione di CSS, la minimizzazione del codice JavaScript lato client o l'esecuzione di strumenti come webpack o gulp.

Ad esempio, per compilare TypeScript in JavaScript, il file package.json potrebbe avere il seguente aspetto. Prendi nota dello script gcp-build:

{
  "name": "appengine-typescript",
  "description": "An example TypeScript app running on Google App Engine.",
  "version": "0.0.1",
  "private": true,
  "license": "Apache Version 2.0",
  "author": "Google Inc.",
  "engines": {
    "node": "16.x.x"
  },
  "scripts": {
    "prepare": "npm run gcp-build",
    "pretest": "npm run gcp-build",
    "test": "c8 mocha -p -j 2 test/*.test.js --exit",
    "lint": "gts lint",
    "start": "node ./index.js",
    "deploy": "gcloud app deploy",
    "clean": "gts clean",
    "compile": "tsc -p .",
    "fix": "gts fix",
    "build": "tsc -p .",
    "gcp-build": "tsc -p ."
  },
  "dependencies": {
    "@typescript-eslint/parser": "^6.0.0",
    "express": "^4.16.3"
  },
  "devDependencies": {
    "@types/express": "^4.17.17",
    "@types/node": "^18.13.0",
    "c8": "^8.0.0",
    "chai": "^4.3.7",
    "gts": "^5.0.0",
    "mocha": "^10.2.0",
    "typescript": "^5.0.0",
    "wait-port": "^1.0.0"
  }
}

Gestione dei file statici

Quando generi o copi file durante il passaggio di build personalizzata, App Engine non pubblica questi file statici direttamente dalla tua app utilizzando gli elementi static_dir o static_files definiti nel file app.yaml. App Engine, invece, carica i file statici nell'infrastruttura di pubblicazione nell'ambiente standard prima di eseguire il passaggio di build personalizzato. Qualsiasi richiesta ai file generati o copiati durante il passaggio della build personalizzata genera un errore HTTP 404 NOT FOUND.