Riferimento alle specifiche di costruzione per CodeBuild

Sequenza opzionale. Speciifica la shell supportata per i sistemi operativi Linux o Windows.

Per i sistemi operativi Linux, i tag shell supportati sono:

Per i sistemi operativi Windows, i tag shell supportati sono:

Obbligatorio se è specificato env e si desidera definire variabili di ambiente personalizzate in testo normale. Contiene una mappatura dikey/valuescalari, in cui ogni mappatura rappresenta una singola variabile di ambiente personalizzata in testo semplice. keyè il nome della variabile di ambiente personalizzata ed value è il valore di quella variabile.

Obbligatorio se env è specificato e desideri recuperare variabili di ambiente personalizzate archiviate in Amazon EC2 Systems Manager Parameter Store. Contiene una mappatura dikey/valuescalars, in cui ogni mappatura rappresenta una singola variabile di ambiente personalizzata memorizzata in Amazon EC2 Systems Manager Parameter Store. keyè il nome che usi più avanti nei comandi di compilazione per fare riferimento a questa variabile di ambiente personalizzata ed value è il nome della variabile di ambiente personalizzata memorizzata in Amazon EC2 Systems Manager Parameter Store. Per memorizzare valori sensibili, consulta Systems Manager Parameter Store and Walkthrough: Create and test a String parameter (console) nella Amazon EC2 Systems Manager User Guide.

Obbligatorio se desideri recuperare variabili di ambiente personalizzate memorizzate in. AWS Secrets Manager Specificate un Secrets Manager reference-key utilizzando il seguente schema:

<key>: <secret-id>:<json-key>:<version-stage>:<version-id>

Nell'esempio seguente, TestSecret è il nome della coppia chiave-valore memorizzata in Secrets Manager. La chiave per TestSecret è. MY_SECRET_VAR Si accede alla variabile durante la compilazione utilizzando il LOCAL_SECRET_VAR nome.

env:
  secrets-manager:
    LOCAL_SECRET_VAR: "TestSecret:MY_SECRET_VAR"

Per ulteriori informazioni, consulta Che cos'è AWS Secrets Manager? nella Guida per l'utente di AWS Secrets Manager .

Mappatura opzionale. Utilizzato per elencare le variabili di ambiente che si desidera esportare. Specificare il nome di ogni variabile che si desidera esportare su una riga separata sotto exported-variables. La variabile che si desidera esportare deve essere disponibile nel contenitore durante la compilazione. La variabile esportata può essere una variabile di ambiente.

Le variabili di ambiente esportate vengono utilizzate insieme AWS CodePipeline a per esportare le variabili di ambiente dalla fase di compilazione corrente alle fasi successive della pipeline. Per ulteriori informazioni, consulta Lavorare con le variabili nella Guida per l'AWS CodePipeline utente.

Durante una compilazione, il valore di una variabile è disponibile a partire dalla fase install. Può essere aggiornato tra l'inizio della fase install e la fine della fase post_build. Al termine della fase post_build, il valore delle variabili esportate non può cambiare.

Mappatura opzionale. Usato per indicare se CodeBuild utilizza il suo helper di credenziali Git per fornire le credenziali Git. yesse è usato. In caso contrario, no o non specificato. Per ulteriori informazioni, consulta gitcredentials sul sito Web Git.

Mappatura opzionale. Imposta su yes se desideri che la compilazione in un server proxy esplicito carichi artefatti. Il valore predefinito è no.

Mappatura opzionale. Imposta su yes per la creazione di un server proxy esplicito per la creazione di CloudWatch registri. Il valore predefinito è no.

Sequenza opzionale. Viene utilizzato in una fase di compilazione per specificare un utente Linux che esegue i comandi. Se run-as è specificato anche a livello globale per tutti i comandi nella parte superiore del file buildspec, l'utente a livello di fase ha la priorità. Ad esempio, se globalmente run-as specifica User-1 e per la fase install solo una istruzione run-as specifica User-2, tutti i comandi nel file buildspec vengono eseguiti come User-1 eccetto i comandi nella fase install che vengono eseguiti come User-2.

Sequenza opzionale. Speciifica l'azione da intraprendere se si verifica un errore durante la fase. Può essere uno dei seguenti valori:

Se questa proprietà non è specificata, il processo di fallimento segue le fasi di transizione illustrate inTransizioni delle fasi della compilazione.

Blocco opzionale. I comandi specificati in un finally blocco vengono eseguiti dopo i comandi nel blocco. commands I comandi in un finally blocco vengono eseguiti anche se un comando nel commands blocco ha esito negativo. Ad esempio, se il commands blocco contiene tre comandi e il primo ha esito negativo, CodeBuild ignora i due comandi rimanenti ed esegue tutti i comandi del finally blocco. La fase va a buon fine quando l'esecuzione di tutti i comandi nei blocchi commands e finally vengono completata. Se uno qualunque dei comandi nella fase non va a buon fine, la fase non va a buon fine:

Sequenza opzionale. Rappresenta gli eventuali comandi che vengono CodeBuild eseguiti durante l'installazione. Ti consigliamo di utilizzare la fase install solo per installare pacchetti nell'ambiente di build. Ad esempio, è possibile utilizzare questa fase per installare un framework di test del codice come Mocha o RSpec.

Sequenza opzionale. Rappresenta gli eventuali comandi CodeBuild eseguiti prima della compilazione. Ad esempio, potresti utilizzare questa fase per accedere ad Amazon ECR o installare npm dependencies.

Sequenza opzionale. Rappresenta gli eventuali comandi CodeBuild eseguiti durante la compilazione. Ad esempio, è possibile utilizzare questa fase per eseguire Mocha o RSpec sbt.

Sequenza opzionale. Rappresenta gli eventuali comandi che vengono CodeBuild eseguiti dopo la compilazione. Ad esempio, puoi usare Maven per impacchettare gli artefatti di compilazione in un file JAR o WAR oppure puoi inserire un'immagine Docker in Amazon ECR. Quindi puoi inviare una notifica di build tramite Amazon SNS.

Sequenza opzionale. Specifica il gruppo di report a cui vengono inviati i report. Un progetto può annoverare al massimo cinque gruppi di report. Specificare l'ARN di un gruppo di report esistente o il nome di un nuovo gruppo di report. Se specificate un nome, CodeBuild crea un gruppo di report utilizzando il nome del progetto e il nome specificato nel formato. <project-name>-<report-group-name> Il nome del gruppo di report può anche essere impostato utilizzando una variabile di ambiente nel buildspec, ad esempio. $REPORT_GROUP_NAME Per ulteriori informazioni, consulta Denominazione dei gruppi di report.

Sequenza obbligatoria. Rappresenta le collocazioni dei dati grezzi afferenti ai risultati di test generati dal report. Contiene una sequenza di scalari, con ogni scalare che rappresenta una posizione separata in cui è CodeBuild possibile trovare i file di test, rispetto alla posizione di build originale o, se impostata, a. base-directory Le posizioni possono includere quanto segue:

Mappatura opzionale. Rappresenta il formato del file di report. In assenza di specifica, viene utilizzato JUNITXML. Questo valore non fa distinzione tra maiuscole e minuscole. I valori possibili sono:

Mappatura opzionale. Rappresenta una o più directory di primo livello, relative alla posizione di build originale, che vengono CodeBuild utilizzate per determinare dove trovare i file di test non elaborati.

Facoltativo. Specifica se le directory dei file di report vengono appiattite nell'output. Se non è specificato o contiene no, i file di report vengono generati con la loro struttura di directory intatta. Se contiene yes, tutti i file di test vengono inseriti nella stessa directory di output. Ad esempio, se un percorso di un risultato del test è com/myapp/mytests/TestResult.xml, specificando yes questo file verrà posizionato in /TestResult.xml.

Sequenza obbligatoria. Rappresenta le posizioni contenenti gli artefatti di output della build nell'ambiente della build. Contiene una sequenza di scalari, ognuno dei quali rappresenta una posizione diversa dove CodeBuild può trovare gli artefatti dell'output della build rispetto alla posizione della build originale o, se impostata, alla directory di base. Le posizioni possono includere quanto segue:

Quando specificate le posizioni degli artefatti di output della build, CodeBuild potete individuare la posizione di compilazione originale nell'ambiente di compilazione. Non occorre anteporre le posizioni dell'output dell'artefatto della build al percorso verso la posizione della build originale, né specificare ./ o valori simili. Se vuoi conoscere il percorso verso la posizione, puoi eseguire un comando come echo $CODEBUILD_SRC_DIR durante una build. La posizione di ciascun ambiente di build può essere leggermente diversa.

Nome opzionale. Specifica un nome per l'artefatto della build. Questo nome si usa quando una delle seguenti affermazioni è vera.

Puoi specificare un nome nel file buildspec calcolato in fase di creazione. Il nome specificato nel file buildspec utilizza il linguaggio di comando Shell. Ad esempio, è possibile aggiungere una data e un'ora al nome dell'artefatto in modo che sia sempre univoco. I nomi di artefatto univoci impediscono che gli artefatti vengano sovrascritti. Per ulteriori informazioni, consulta Linguaggio di comando Shell.

È possibile aggiungere informazioni sul percorso al nome in modo che gli artefatti denominati vengano inseriti nelle directory in base al percorso contenuto nel nome. In questo esempio, gli artefatti della build vengono inseriti nell'output sotto. builds/<build number>/my-artifacts

version: 0.2
phases:
  build:
    commands:
      - rspec HelloWorld_spec.rb
artifacts:
  files:
    - '**/*'
  name: builds/$CODEBUILD_BUILD_NUMBER/my-artifacts

Facoltativo. Specifica se le directory degli artefatti di build vengono appiattite nell'output. Se non è specificato, o contiene no, gli artefatti di build vengono generati con la loro struttura di directory intatta. Se contiene yes, tutti gli artefatti di build vengono inseriti nella stessa directory di output. Ad esempio, se un percorso di un file nell'artefatto di output della build è com/mycompany/app/HelloWorld.java, specificando yes il file verrà posizionato in /HelloWorld.java.

Mappatura opzionale. Rappresenta una o più directory di primo livello, relative alla posizione di compilazione originale, che CodeBuild vengono utilizzate per determinare quali file e sottodirectory includere nell'elemento di output della build. I valori validi includono:

Le directory di primo livello corrispondenti non sono incluse nell'artefatto dell'output della build, ma solo i file e le sottodirectory.

Puoi utilizzare files e discard-paths per limitare ulteriormente i file e le sottodirectory inclusi. Ad esempio, per la seguente struttura di directory:

.
├── my-build-1
│   └── my-file-1.txt
└── my-build-2
    ├── my-file-2.txt
    └── my-subdirectory
        └── my-file-3.txt

E per la seguente sequenza artifacts:

artifacts:
  files:
    - '*/my-file-3.txt'
  base-directory: my-build-2

Nell'artefatto di output della build sarebbero compresi la seguente sottodirectory e il seguente file:

.
└── my-subdirectory
    └── my-file-3.txt

Mentre per la seguente sequenza artifacts:

artifacts:
  files:
    - '**/*'
  base-directory: 'my-build*'
  discard-paths: yes

Nell'artefatto di output della build sarebbero compresi i seguenti file:

.
├── my-file-1.txt
├── my-file-2.txt
└── my-file-3.txt

Mappatura opzionale. Rappresenta uno o più percorsi, relativi a, che CodeBuild escluderanno gli base-directory artefatti della build. L'asterisco (*) individua zero o più caratteri di un componente del nome entro i limiti della cartella. Un doppio asterisco (**) corrisponde a zero o più caratteri di un componente del nome in tutte le directory.

Di seguito sono riportati alcuni esempi di percorsi di esclusione:

Facoltativo. Se il tipo di output èZIP, specifica se i collegamenti simbolici interni vengono conservati nel file ZIP. Se contieneyes, tutti i collegamenti simbolici interni nel codice sorgente verranno conservati nel file ZIP degli artefatti.

Facoltativo. Speciifica un prefisso utilizzato quando gli artefatti vengono emessi in un bucket Amazon S3 e il tipo di namespace è. BUILD_ID Quando viene utilizzato, il percorso di output nel bucket è. <s3-prefix>/<build-id>/<name>.zip

Sequenza opzionale. Rappresenta una o più definizioni di artefatto come mappatura tra un identificatore dell'artefatto e una sua definizione. Ciascun identificatore di artefatto in questo blocco deve corrispondere a un artefatto definito nell'attributo secondaryArtifacts del progetto. Ogni diversa definizione presenta la stessa sintassi del blocco artifacts illustrato in precedenza.

Ad esempio, se un progetto presenta la seguente struttura:

{
  "name": "sample-project",
  "secondaryArtifacts": [
    {
      "type": "S3",
      "location": "<output-bucket1>",
      "artifactIdentifier": "artifact1",
      "name": "secondary-artifact-name-1"
    },
    {
      "type": "S3",
      "location": "<output-bucket2>",
      "artifactIdentifier": "artifact2",
      "name": "secondary-artifact-name-2"
    }
  ]
}

Il buildspec avrà il seguente aspetto:

version: 0.2

phases:
build:
  commands:
    - echo Building...
artifacts:
  files:
    - '**/*'
  secondary-artifacts:
    artifact1:
      files:
        - directory/file1
      name: secondary-artifact-name-1
    artifact2:
      files:
        - directory/file2
      name: secondary-artifact-name-2

Sequenza opzionale. Rappresenta la chiave primaria utilizzata per la ricerca o il ripristino di una cache. CodeBuild corrisponde esattamente alla chiave primaria.

Ecco un esempio della chiave:

key: npm-key-$(codebuild-hash-files package-lock.json) }

Sequenza opzionale. Rappresenta un elenco di chiavi di fallback utilizzate in sequenza quando non è possibile trovare una cache utilizzando la chiave primaria. Sono supportate fino a cinque chiavi di fallback, ognuna delle quali viene abbinata mediante una ricerca per prefisso. Questa sequenza verrà ignorata se la chiave non viene fornita.

Ecco un esempio per le chiavi di riserva:

fallback-keys:
    - npm-key-$(codebuild-hash-files package-lock.json) }
    - npm-key-
    - npm-

Sequenza opzionale. Specifica l'azione da eseguire sulla cache. I valori validi includono:

Se non viene fornito alcun valore, l' CodeBuild impostazione predefinita esegue sia il ripristino che il salvataggio.

Sequenza obbligatoria. Rappresenta le posizioni della cache. Contiene una sequenza di scalari, ciascuno dei quali rappresenta una posizione separata in cui è CodeBuild possibile trovare gli artefatti di output della build, rispetto alla posizione di build originale o, se impostata, alla directory di base. Le posizioni possono includere quanto segue: