Créez le JSON fichier Remplissez le JSON fichier Création du projet

Création d'un projet de génération (AWS CLI)

Pour plus d'informations sur l'utilisation du AWS CLI with CodeBuild, consultez leRéférence des commandes en ligne.

Pour créer un projet de CodeBuild construction à l'aide de AWS CLI, vous devez créer une structure de projet au JSON format -formatée, renseigner la structure et appeler la create-projectcommande pour créer le projet.

Créez le JSON fichier

Créez un JSON fichier squelette à l'aide de la create-projectcommande, en utilisant l'--generate-cli-skeletonoption suivante :


aws codebuild create-project --generate-cli-skeleton > <json-file>

Cela crée un JSON fichier avec le chemin et le nom de fichier spécifiés par <json-file>.

Remplissez le JSON fichier

Modifiez les JSON données comme suit et enregistrez vos résultats.


{
  "name": "<project-name>",
  "description": "<description>",
  "source": {
    "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE",
    "location": "<source-location>",
    "gitCloneDepth": "<git-clone-depth>",
    "buildspec": "<buildspec>",
    "InsecureSsl": "<insecure-ssl>",
    "reportBuildStatus": "<report-build-status>",
    "buildStatusConfig": {
      "context": "<context>",
      "targetUrl": "<target-url>"
    },
    "gitSubmodulesConfig": {
      "fetchSubmodules": "<fetch-submodules>"
    },
    "auth": {
      "type": "<auth-type>",
      "resource": "<auth-resource>"
    },
    "sourceIdentifier": "<source-identifier>"
  },
  "secondarySources": [
    {
        "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE",
        "location": "<source-location>",
        "gitCloneDepth": "<git-clone-depth>",
        "buildspec": "<buildspec>",
        "InsecureSsl": "<insecure-ssl>",
        "reportBuildStatus": "<report-build-status>",
        "auth": {
          "type": "<auth-type>",
          "resource": "<auth-resource>"
        },
        "sourceIdentifier": "<source-identifier>"
    }
  ],
  "secondarySourceVersions": [
    {
      "sourceIdentifier": "<secondary-source-identifier>",
      "sourceVersion": "<secondary-source-version>"
    }
  ],
  "sourceVersion": "<source-version>",
  "artifacts": {
    "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS",
    "location": "<artifacts-location>",
    "path": "<artifacts-path>",
    "namespaceType": "<artifacts-namespacetype>",
    "name": "<artifacts-name>",
    "overrideArtifactName": "<override-artifact-name>",
    "packaging": "<artifacts-packaging>"
  },
  "secondaryArtifacts": [
    {
      "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS",
      "location": "<secondary-artifact-location>",
      "path": "<secondary-artifact-path>",
      "namespaceType": "<secondary-artifact-namespaceType>",
      "name": "<secondary-artifact-name>",
      "packaging": "<secondary-artifact-packaging>",
      "artifactIdentifier": "<secondary-artifact-identifier>"
    }
  ],
  "cache": {
    "type": "<cache-type>",
    "location": "<cache-location>",
    "mode": [
      "<cache-mode>"
    ]
  },
  "environment": {
    "type": "LINUX_CONTAINER" | "LINUX_GPU_CONTAINER" | "ARM_CONTAINER" | "WINDOWS_SERVER_2019_CONTAINER" | "WINDOWS_SERVER_2022_CONTAINER",
    "image": "<image>",
    "computeType": "BUILD_GENERAL1_SMALL" | "BUILD_GENERAL1_MEDIUM" | "BUILD_GENERAL1_LARGE" | "BUILD_GENERAL1_2XLARGE",
    "certificate": "<certificate>",
    "environmentVariables": [
      {
        "name": "<environmentVariable-name>",
        "value": "<environmentVariable-value>",
        "type": "<environmentVariable-type>"
      }
    ],
    "registryCredential": [
      {
        "credential": "<credential-arn-or-name>",
        "credentialProvider": "<credential-provider>"
      }
    ],
    "imagePullCredentialsType": "CODEBUILD" | "SERVICE_ROLE",
    "privilegedMode": "<privileged-mode>"
  },
  "serviceRole": "<service-role>",
  "timeoutInMinutes": <timeout>,
  "queuedTimeoutInMinutes": <queued-timeout>,
  "encryptionKey": "<encryption-key>",
  "tags": [
    {
      "key": "<tag-key>",
      "value": "<tag-value>"
    }
  ],
  "vpcConfig": {
    "securityGroupIds": [
         "<security-group-id>"
    ],
    "subnets": [
         "<subnet-id>"
    ],
    "vpcId": "<vpc-id>"
  },
  "badgeEnabled": "<badge-enabled>",
  "logsConfig": {
    "cloudWatchLogs": {
      "status": "<cloudwatch-logs-status>",
      "groupName": "<group-name>",
      "streamName": "<stream-name>"
    },
    "s3Logs": {
      "status": "<s3-logs-status>",
      "location": "<s3-logs-location>",
      "encryptionDisabled": "<s3-logs-encryption-disabled>"
    }
  },
  "fileSystemLocations": [
    {
      "type": "EFS",
      "location": "<EFS-DNS-name-1>:/<directory-path>",
      "mountPoint": "<mount-point>",
      "identifier": "<efs-identifier>",
      "mountOptions": "<efs-mount-options>"
    }
  ],
  "buildBatchConfig": {
    "serviceRole": "<batch-service-role>",
    "combineArtifacts": <combine-artifacts>,
    "restrictions": {
      "maximumBuildsAllowed": <max-builds>,
      "computeTypesAllowed": [
        "<compute-type>"
      ]
    },
    "timeoutInMins": <batch-timeout>,
    "batchReportMode": "REPORT_AGGREGATED_BATCH" | "REPORT_INDIVIDUAL_BUILDS"
  },
  "concurrentBuildLimit": <concurrent-build-limit>
}

Remplacez les éléments suivants :

nom

Obligatoire. Nom de ce projet de génération. Ce nom doit être unique pour tous les projets de construction de votre AWS compte.

description

Facultatif. Description de ce projet de génération.

source

Obligatoire. Un ProjectSourceobjet qui contient des informations sur les paramètres du code source de ce projet de build. Après avoir ajouté un objet source, vous pouvez ajouter jusqu'à 12 autres sources à l'aide de secondarySources. Il s'agit notamment des paramètres suivants :

source/type

Obligatoire. Type de référentiel qui contient le code source à générer. Les valeurs valides sont les suivantes :

CODECOMMIT
CODEPIPELINE
GITHUB
GITHUB_ENTERPRISE
GITLAB
GITLAB_SELF_MANAGED
BITBUCKET
S3
NO_SOURCE

Si vous utilisez NO_SOURCE, buildspec ne peut pas être un fichier, car le projet n'a pas de source. Vous devez plutôt utiliser l'buildspecattribut pour spécifier une chaîne au YAML format -pour votre buildspec. Pour plus d’informations, consultez Exemple de projet sans source.

source/ lieu

Obligatoire sauf si vous définissez <source-type> àCODEPIPELINE. Emplacement du code source pour le type de référentiel spécifié.

Pour CodeCommit, le HTTPS clone URL du référentiel qui contient le code source et le fichier buildspec (par exemple,). https://git-codecommit.<region-id>.amazonaws.com/v1/repos/<repo-name>
Pour Amazon S3, le nom du compartiment d'entrée de construction, suivi du chemin et du nom du ZIP fichier contenant le code source et les spécifications de construction. Par exemple :
- Pour un ZIP fichier situé à la racine du compartiment d'entrée :<bucket-name>/<object-name>.zip.
- Pour un ZIP fichier situé dans un sous-dossier du compartiment d'entrée :<bucket-name>/<subfoler-path>/<object-name>.zip.
Pour GitHub, le HTTPS clone URL du référentiel qui contient le code source et le fichier buildspec. Le URL doit contenir github.com. Vous devez connecter votre AWS compte à votre GitHub compte. Pour ce faire, utilisez la CodeBuild console pour créer un projet de génération.
- Choisissez Authorize application. (Une fois connecté à votre GitHub compte, vous n'avez pas besoin de terminer la création du projet de construction. Vous pouvez fermer la CodeBuild console.)
Pour GitHub Enterprise Server, le HTTP ou HTTPS clonez-le URL dans le référentiel qui contient le code source et le fichier buildspec. Vous devez également connecter votre AWS compte à votre compte GitHub Enterprise Server. Pour ce faire, utilisez la CodeBuild console pour créer un projet de génération.
1. Créez un jeton d'accès personnel dans GitHub Enterprise Server.
2. Copiez ce jeton dans votre presse-papiers afin de pouvoir l'utiliser lors de la création de votre CodeBuild projet. Pour plus d'informations, consultez la section Création d'un jeton d'accès personnel pour la ligne de commande sur le site Web d' GitHub aide.
3. Lorsque vous utilisez la console pour créer votre CodeBuild projet, dans Source, pour Source provider, choisissez GitHubEnterprise.
4. Pour Personal Access Token, collez le jeton copié dans le Presse-papiers. Choisissez Save Token. Votre CodeBuild compte est désormais connecté à votre compte GitHub Enterprise Server.
Pour GitLab et GitLab autogéré, le HTTPS clone URL du référentiel contenant le code source et le fichier buildspec. Notez que si vous l'utilisez GitLab, le URL doit contenir gitlab.com. Si vous utilisez l' GitLab autogéré, il n'est URL pas nécessaire de contenir gitlab.com. Vous devez connecter votre AWS compte à votre compte GitLab ou à votre compte GitLab autogéré. Pour ce faire, utilisez la CodeBuild console pour créer un projet de génération.
- Dans le volet de navigation des outils de développement, choisissez Paramètres, Connexions, puis Créer une connexion. Sur cette page, créez une connexion GitLab ou une connexion GitLab autogérée, puis choisissez Connect to GitLab.
Pour Bitbucket, HTTPS clone URL du référentiel contenant le code source et le fichier buildspec. Le URL doit contenir bitbucket.org. Vous devez également connecter votre AWS compte à votre compte Bitbucket. Pour ce faire, utilisez la CodeBuild console pour créer un projet de génération.
1. Lorsque vous utilisez la console pour vous connecter (ou vous reconnecter) à Bitbucket, dans la page Bitbucket Confirm access to your account, choisissez Grant access. (Une fois connecté à votre compte Bitbucket, vous n'avez pas besoin de terminer la création du projet de build. Vous pouvez fermer la CodeBuild console.)
Pour AWS CodePipeline, ne spécifiez pas de location valeur poursource. CodePipeline ignore cette valeur car lorsque vous créez un pipeline dans CodePipeline, vous spécifiez l'emplacement du code source dans le stage Source du pipeline.

source/ gitCloneDepth

Facultatif. Profondeur de l'historique à télécharger. La valeur minimum est de 0. Si cette valeur est égale à 0, supérieure à 25 ou non spécifiée, l'historique complet est téléchargé avec chaque projet de génération. Si votre type de source est Amazon S3, cette valeur n'est pas prise en charge.

source/ buildspec

Facultatif. Définition de spécification de génération ou fichier à utiliser. Si cette valeur n'est pas fournie ou qu'elle est définie sur une chaîne vide, le code source doit contenir un fichier buildspec.yml dans son répertoire racine. Si cette valeur est définie, il peut s'agir d'une définition de buildspec intégrée, du chemin d'accès à un autre fichier buildspec relatif au répertoire racine de votre source principale ou du chemin d'accès à un compartiment S3. Le bucket doit se trouver dans la même AWS région que le projet de construction. Spécifiez le fichier buildspec en utilisant son ARN (par exemple,). arn:aws:s3:::<my-codebuild-sample2>/buildspec.yml Pour plus d’informations, consultez Nom de fichier buildspec et emplacement de stockage.

source/ authentification

Ne pas utiliser. Cet objet est utilisé uniquement par la CodeBuild console.

source/ reportBuildStatus

Indique si vous souhaitez envoyer le statut de début et de fin d'une génération à votre fournisseur de source. Si vous le définissez avec un fournisseur de source autre qu' GitHub GitHub Enterprise Server ou Bitbucket, un invalidInputException est émis.

Pour pouvoir signaler l'état de construction au fournisseur de source, l'utilisateur associé au fournisseur de source doit avoir un accès en écriture au dépôt. Si l'utilisateur ne dispose pas d'un accès en écriture, l'état de construction ne peut pas être mis à jour. Pour plus d’informations, consultez Accès au fournisseur de source.

source/ buildStatusConfig

Contient des informations qui définissent la manière dont le CodeBuild projet de construction communique l'état de la construction au fournisseur source. Cette option n'est utilisée que lorsque le type de source est GITHUBGITHUB_ENTERPRISE, ouBITBUCKET.

source/buildStatusConfig/contexte

Pour les sources Bitbucket, ce paramètre est utilisé pour le name paramètre figurant dans le statut de validation de Bitbucket. Pour les GitHub sources, ce paramètre est utilisé pour le context paramètre figurant dans l'état de GitHub validation.

Par exemple, vous pouvez faire en sorte qu'ils context contiennent le numéro de version et le déclencheur webhook à l'aide des variables d' CodeBuildenvironnement :


AWS CodeBuild sample-project Build #$CODEBUILD_BUILD_NUMBER - $CODEBUILD_WEBHOOK_TRIGGER

Il en résulte que le contexte apparaît comme suit pour la version #24 déclenchée par un événement de pull request du webhook :


AWS CodeBuild sample-project Build #24 - pr/8

source//buildStatusConfigtargetUrl

Pour les sources Bitbucket, ce paramètre est utilisé pour le url paramètre figurant dans le statut de validation de Bitbucket. Pour les GitHub sources, ce paramètre est utilisé pour le target_url paramètre figurant dans l'état de GitHub validation.

Par exemple, vous pouvez définir le targetUrl à https://aws.amazon.com/codebuild/<path to build> et le statut de validation sera lié à celui-ciURL.

Vous pouvez également inclure des variables d' CodeBuild environnement dans le targetUrl pour ajouter des informations supplémentaires auURL. Par exemple, pour ajouter la région de construction à laURL, définissez la valeur targetUrl sur :


"targetUrl": "https://aws.amazon.com/codebuild/<path to build>?region=$AWS_REGION"

Si la région de construction l'estus-east-2, elle s'étendra à :


https://aws.amazon.com/codebuild/<path to build>?region=us-east-2

source/ gitSubmodulesConfig

Facultatif. Informations sur la configuration des sous-modules Git. Utilisé uniquement avec CodeCommit GitHub, GitHub Enterprise Server et Bitbucket.

source//gitSubmodulesConfigfetchSubmodules: Définissez fetchSubmodules sur true si vous souhaitez inclure les sous-modules Git dans votre référentiel. Les sous-modules Git inclus doivent être configurés commeHTTPS.

source/ InsecureSsl

Facultatif. Utilisé uniquement avec GitHub Enterprise Server. Définissez cette valeur sur true pour ignorer les TLS avertissements lors de la connexion au référentiel de votre projet GitHub Enterprise Server. La valeur par défaut est false. InsecureSsl doit être utilisé à des fins de test uniquement. Cette option ne doit pas être utilisée dans un environnement de production.

source/ sourceIdentifier

Identifiant défini par l'utilisateur pour la source du projet. Facultatif pour la source principale. Nécessaire pour les sources secondaires.

secondarySources

Facultatif. Tableau d'ProjectSourceobjets contenant des informations sur les sources secondaires d'un projet de construction. Vous pouvez ajouter jusqu'à 12 sources secondaires. Les secondarySources objets utilisent les mêmes propriétés que celles utilisées par l'sourceobjet. Dans un objet source secondaire, le sourceIdentifier est obligatoire.

secondarySourceVersions

Facultatif. Tableau d’objets ProjectSourceVersion. Si secondarySourceVersions est spécifié au niveau de la build, ils ont priorité sur cela.

sourceVersion

Facultatif. Version de l'entrée de compilation à créer pour ce projet. Si elle n'est pas spécifiée, la dernière version est utilisée. Si cette valeur est spécifiée, elle doit être l'une des suivantes :

Pour CodeCommit, l'ID de validation, la branche ou le tag Git à utiliser.
Pour GitHub, l'ID de validation, l'ID de pull request, le nom de branche ou le nom de balise correspondant à la version du code source que vous souhaitez créer. Si un ID de demande d'extraction est spécifié, il doit utiliser le format pr/pull-request-ID (par exemple, pr/25). Si un nom de branche est spécifié, l'ID de HEAD validation de la branche est utilisé. S'il n'est pas spécifié, l'ID de HEAD validation de la branche par défaut est utilisé.
Pour GitLab, l'ID de validation, l'ID de pull request, le nom de la branche, le nom du tag ou la référence et un ID de validation. Pour plus d’informations, consultez Exemple de version source avec AWS CodeBuild.
Pour Bitbucket, l'ID de validation, le nom de branche ou le nom de balise qui correspond à la version du code source à générer. Si un nom de branche est spécifié, l'ID de HEAD validation de la branche est utilisé. S'il n'est pas spécifié, l'ID de HEAD validation de la branche par défaut est utilisé.
Pour Amazon S3, l'ID de version de l'objet qui représente le ZIP fichier d'entrée de compilation à utiliser.

Si sourceVersion est spécifié à la build, cette version est prioritaire sur cette sourceVersion (au niveau du projet). Pour plus d’informations, consultez Exemple de version source avec AWS CodeBuild.

artefacts

Obligatoire. Un ProjectArtifactsobjet qui contient des informations sur les paramètres d'artefact de sortie de ce projet de construction. Après avoir ajouté un objet artifacts, vous pouvez ajouter jusqu'à 12 autres artefacts à l'aide de secondaryArtifacts. Il s'agit notamment des paramètres suivants :

artéfacts/type

Obligatoire. Le type d'objet de sortie de la build. Les valeurs valides sont :

CODEPIPELINE
NO_ARTIFACTS
S3

artéfacts/ emplacement