Référence de spécification de construction pour CodeBuild

Séquence facultative. Spécifie le shell pris en charge pour les systèmes d'exploitation Linux ou Windows.

Pour les systèmes d'exploitation Linux, les balises shell prises en charge sont les suivantes :

Pour les systèmes d'exploitation Windows, les balises shell prises en charge sont les suivantes :

Obligatoire si env est spécifié, et que vous voulez définir des variables d'environnement personnalisées en texte brut. Contient un mappage de key/value scalaires, où chaque mappage représente une variable d'environnement personnalisée unique en texte brut. key est le nom de la variable d'environnement personnalisée, et value est la valeur de cette variable.

Obligatoire si cela env est spécifié et si vous souhaitez récupérer des variables d'environnement personnalisées stockées dans Amazon EC2 Systems Manager Parameter Store. Contient un mappage de key/value scalaires, où chaque mappage représente une variable d'environnement personnalisée unique stockée dans Amazon EC2 Systems Manager Parameter Store. key est le nom que vous utiliserez ultérieurement dans vos commandes de compilation pour faire référence à cette variable d'environnement personnalisée, et value est le nom de la variable d'environnement personnalisée stockée dans Amazon EC2 Systems Manager Parameter Store. Pour stocker des valeurs sensibles, consultez la section Stockage des paramètres de Systems Manager et procédure pas à pas : créer et tester un paramètre de chaîne (console) dans le guide de l'utilisateur d'Amazon EC2 Systems Manager.

Obligatoire si vous souhaitez récupérer des variables d'environnement personnalisées stockées dans AWS Secrets Manager. Spécifiez un Gestionnaire de Secrets reference-key en utilisant le modèle suivant :

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

Dans l'exemple suivant, TestSecret c'est le nom de la paire clé-valeur stockée dans Secrets Manager. La clé pour TestSecret nousMY_SECRET_VAR. Vous pouvez accéder à la variable pendant la construction en utilisant le LOCAL_SECRET_VAR nom.

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

Pour plus d’informations, consultez Présentation de AWS Secrets Manager dans le Guide de l’utilisateur AWS Secrets Manager .

Mappage facultatif. Permet de répertorier les variables d'environnement que vous souhaitez exporter. Spécifiez le nom de chaque variable que vous souhaitez exporter sur une ligne distincte sous exported-variables. La variable que vous souhaitez exporter doit être disponible dans votre conteneur pendant la génération. La variable que vous exportez peut être une variable d'environnement.

Les variables d'environnement exportées sont utilisées conjointement AWS CodePipeline pour exporter les variables d'environnement de la phase de construction actuelle vers les étapes suivantes du pipeline. Pour plus d'informations, consultez la section Utilisation des variables dans le Guide de AWS CodePipeline l'utilisateur.

Lors d'une génération, la valeur d'une variable est disponible dès la phase install. Elle peut être mise à jour entre le début de la phase install et la fin de la phase post_build. Lorsque la phase post_build est terminée, la valeur des variables exportées ne peut pas changer.

Mappage facultatif. Utilisé pour indiquer s'il CodeBuild utilise son assistant d'identification Git pour fournir des informations d'identification Git. yess'il est utilisé. Sinon, no ou non spécifié. Pour plus d'informations, consultez gitcredentials sur le site web de Git.

Mappage facultatif. Définissez ce paramètre sur yes si vous souhaitez que votre build dans un serveur proxy explicite charge des artefacts. L’argument par défaut est no.

Mappage facultatif. Configurez sur yes pour votre intégration dans un serveur proxy explicite afin de créer CloudWatch des journaux. L’argument par défaut est no.

Séquence facultative. Utilisez-le dans une phase de build pour spécifier un utilisateur Linux qui exécute ses commandes. Si run-as est également spécifié globalement pour toutes les commandes en haut du fichier buildspec, alors l'utilisateur au niveau de phase est prioritaire. Par exemple, si run-as spécifie globalement l'utilisateur-1, et pour la phase install seule une instruction run-as spécifie l'utilisateur 2, alors toutes les commandes dans le fichier buildspec sont exécutées en tant qu'utilisateur-1, sauf les commandes dans la phase install, qui sont exécutées en tant qu'utilisateur-2.

Séquence facultative. Spécifie l'action à entreprendre en cas de panne pendant la phase. Il peut s’agir de l’une des valeurs suivantes :

Si cette propriété n'est pas spécifiée, le processus d'échec suit les phases de transition, comme indiqué dansTransitions des phases de génération.

Bloc facultatif. Les commandes spécifiées dans un finally bloc sont exécutées après les commandes du commands bloc. Les commandes d'un finally bloc sont exécutées même si une commande du commands bloc échoue. Par exemple, si le commands bloc contient trois commandes et que la première échoue, CodeBuild ignore les deux commandes restantes et exécute toutes les commandes du finally bloc. La phase est réussie lorsque toutes les commandes des blocs commands et finally s'exécutent avec succès. Si une commande d'une phase échoue, la phase échoue.

Séquence facultative. Représente les commandes, le cas échéant, CodeBuild exécutées pendant l'installation. Nous vous recommandons d'utiliser la phase install uniquement pour l'installation de packages dans l'environnement de génération. Par exemple, vous pouvez utiliser cette phase pour installer un framework de test de code tel que Mocha ouRSpec.

Séquence facultative. Représente les commandes, le cas échéant, CodeBuild exécutées avant la génération. Par exemple, vous pouvez utiliser cette phase pour vous connecter à AmazonECR, ou vous pouvez installer des dépendances npm.

Séquence facultative. Représente les commandes, le cas échéant, CodeBuild exécutées pendant la génération. Par exemple, vous pouvez utiliser cette phase pour exécuter Mocha ou sbt. RSpec

Séquence facultative. Représente les commandes, le cas échéant, CodeBuild exécutées après la génération. Par exemple, vous pouvez utiliser Maven pour empaqueter les artefacts de construction dans un WAR fichier JAR OR, ou vous pouvez envoyer une image Docker dans Amazon. ECR Vous pouvez ensuite envoyer une notification de build via AmazonSNS.

Séquence facultative. Spécifie le groupe de rapports auquel les rapports sont envoyés. Un projet peut comporter un maximum de cinq groupes de rapports. Spécifiez le nom ARN d'un groupe de rapports existant ou le nom d'un nouveau groupe de rapports. Si vous spécifiez un nom, CodeBuild crée un groupe de rapports en utilisant le nom de votre projet et le nom que vous spécifiez dans le format<project-name>-<report-group-name>. Le nom du groupe de rapports peut également être défini à l'aide d'une variable d'environnement dans la spécification de construction, telle que. $REPORT_GROUP_NAME Pour de plus amples informations, veuillez consulter Attribution des noms des groupes de rapports.

Séquence obligatoire. Représente les emplacements qui contiennent les données brutes des résultats de test générés par le rapport. Contient une séquence de scalaires, chaque scalaire représentant un emplacement distinct où se CodeBuild trouvent les fichiers de test, par rapport à l'emplacement de construction d'origine ou, s'il est défini, au. base-directory Il peut s'agir notamment des emplacements suivants :

Mappage facultatif. Représente le format du fichier de rapport. Si non spécifié, JUNITXML est utilisé. Cette valeur ne distingue pas les majuscules et minuscules. Les valeurs possibles sont :

Mappage facultatif. Représente un ou plusieurs répertoires de niveau supérieur, relatifs à l'emplacement de construction d'origine, qui CodeBuild permettent de déterminer où trouver les fichiers de test bruts.

Facultatif. Spécifie si les répertoires de fichiers de rapport sont aplatis dans la sortie. Si cela n'est pas spécifié ou si no est défini, les fichiers de rapport sont générés avec leur structure de répertoire intacte. Si yes est défini, tous les fichiers de test sont placés dans le même répertoire de sortie. Par exemple, si un chemin d'accès à un résultat de test est com/myapp/mytests/TestResult.xml, la définition de yes place ce fichier dans /TestResult.xml.

Séquence obligatoire. Représente les emplacements qui contiennent les artefacts de sortie de génération dans l'environnement de génération. Contient une séquence de scalaires, chaque scalaire représentant un emplacement distinct où CodeBuild peuvent trouver les artefacts de sortie de construction, par rapport à l'emplacement de construction d'origine ou, s'il est défini, au répertoire de base. Il peut s'agir notamment des emplacements suivants :

Lorsque vous spécifiez les emplacements des artefacts de sortie de construction, vous CodeBuild pouvez localiser l'emplacement de construction d'origine dans l'environnement de construction. Vous n'avez pas besoin de préfixer les emplacements d'artefact de sortie de génération avec le chemin de l'emplacement de génération d'origine, ni de spécifier ./ ou un élément similaire. Si vous souhaitez connaître le chemin d'accès à cet emplacement, vous pouvez exécuter une commande comme echo $CODEBUILD_SRC_DIR pendant une génération. L'emplacement de chaque environnement de génération peut être légèrement différent.

Nom facultatif. Spécifie un nom pour votre artefact de génération. Ce nom est utilisé lorsque l'une des conditions suivantes est vraie.

Vous pouvez spécifier un nom dans le fichier de spécification de build qui est calculé au moment de la génération. Le nom spécifié dans un fichier de spécification de build utilise le langage de commandes Shell. Par exemple, vous pouvez ajouter une date et une heure au nom de votre artefact afin qu'il soit toujours unique. Les noms d'artefact uniques empêchent les artefacts d'être écrasés. Pour de plus amples informations, veuillez consulter Langage de commandes Shell.

Vous pouvez ajouter des informations de chemin au nom afin que les artefacts nommés soient placés dans des répertoires en fonction du chemin indiqué dans le nom. Dans cet exemple, les artefacts de construction sont placés dans la sortie sousbuilds/<build number>/my-artifacts.

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

Facultatif. Spécifie si les répertoires d'artefacts de génération sont aplatis dans la sortie. Si cela n'est pas spécifié, si no est défini, les artefacts de génération sont générés avec leur structure de répertoire intacte. Si yes est défini, tous les artefacts de génération sont placés dans le même répertoire de sortie. Par exemple, si un chemin d'accès à un fichier dans l'artefact de sortie de génération est com/mycompany/app/HelloWorld.java, la définition de yes permet de placer ce fichier dans /HelloWorld.java.

Mappage facultatif. Représente un ou plusieurs répertoires de niveau supérieur, relatifs à l'emplacement de génération d'origine, qui permettent CodeBuild de déterminer les fichiers et sous-répertoires à inclure dans l'artefact de sortie de génération. Les valeurs valides sont les suivantes :

Les répertoires de niveau supérieur correspondants ne sont pas inclus dans l'artefact de sortie de génération, seulement leurs fichiers et sous-répertoires.

Vous pouvez utiliser files et discard-paths pour limiter encore plus les fichiers et sous-répertoires inclus. Par exemple, pour la structure de répertoire suivante :

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

Et pour la séquence artifacts suivante :

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

Le sous-répertoire et le fichier suivants seront inclus dans l'artefact de sortie de génération :

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

Alors que pour la séquence artifacts suivante :

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

Les fichiers suivants seront inclus dans l'artefact de sortie de génération :

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

Mappage facultatif. Représente un ou plusieurs chemins, relatifs àbase-directory, qui CodeBuild seront exclus de la construction des artefacts. L'astérisque (*) correspond à zéro ou plusieurs caractères d'un composant de nom sans dépasser les limites d'un dossier. Un double astérisque (**) correspond à zéro ou plusieurs caractères d'un composant de nom dans tous les répertoires.

Voici des exemples de chemins d'exclusion :

Facultatif. Si le type de sortie estZIP, indique si les liens symboliques internes sont préservés dans le ZIP fichier. Si tel est le casyes, tous les liens symboliques internes de la source seront conservés dans le ZIP fichier d'artefacts.

Facultatif. Spécifie un préfixe utilisé lorsque les artefacts sont envoyés vers un compartiment Amazon S3 et que le type d'espace de noms est. BUILD_ID Lorsqu'il est utilisé, le chemin de sortie dans le compartiment est<s3-prefix>/<build-id>/<name>.zip.

Séquence facultative. Représente une ou plusieurs définitions d'artefacts comme correspondance entre l'identificateur d'un artefact et la définition d'un artefact. Chaque identifiant d'artefact de ce bloc doit correspondre à un artefact défini dans l'attribut secondaryArtifacts de votre projet. Chaque définition distincte a la même syntaxe que le bloc artifacts ci-dessus.

Par exemple, si la structure de votre projet est la suivante :

{
  "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"
    }
  ]
}

Votre fichier buildspec ressemble alors à ceci :

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

Séquence obligatoire. Représente les emplacements du cache. Contient une séquence de scalaires, chaque scalaire représentant un emplacement distinct où CodeBuild peuvent trouver les artefacts de sortie de construction, par rapport à l'emplacement de construction d'origine ou, s'il est défini, au répertoire de base. Il peut s'agir notamment des emplacements suivants :