Buat file JSON Isi file JSON Buat proyek

Buat proyek build (AWS CLI)

Untuk informasi lebih lanjut tentang menggunakan AWS CLI with CodeBuild, lihatReferensi baris perintah.

Untuk membuat proyek CodeBuild build menggunakan AWS CLI, Anda membuat struktur Proyek berformat JSON, mengisi struktur, dan memanggil create-projectperintah untuk membuat proyek.

Buat file JSON

Buat file JSON kerangka dengan create-projectperintah, menggunakan opsi: --generate-cli-skeleton


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

<json-file>Ini membuat file JSON dengan path dan nama file yang ditentukan oleh.

Isi file JSON

Ubah data JSON sebagai berikut dan simpan hasil Anda.


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

Ganti yang berikut ini:

name

Wajib. Nama untuk proyek pembangunan ini. Nama ini harus unik di semua proyek build di AWS akun Anda.

deskripsi

Tidak wajib. Deskripsi untuk proyek pembangunan ini.

sumber

Wajib. ProjectSourceObjek yang berisi informasi tentang pengaturan kode sumber proyek build ini. Setelah Anda menambahkan source objek, Anda dapat menambahkan hingga 12 sumber lagi menggunakan fileSecondarySources. Pengaturan ini meliputi yang berikut:

sumber/jenis

Wajib. Jenis repositori yang berisi kode sumber untuk membangun. Nilai yang valid meliputi:

CODECOMMIT
CODEPIPELINE
GITHUB
GITHUB_ENTERPRISE
GITLAB
GITLAB_SELF_MANAGED
BITBUCKET
S3
NO_SOURCE

Jika Anda menggunakanNO_SOURCE, buildspec tidak dapat berupa file karena proyek tidak memiliki sumber. Sebagai gantinya, Anda harus menggunakan buildspec atribut untuk menentukan string berformat YAML untuk buildspec Anda. Untuk informasi selengkapnya, lihat Proyek tanpa sampel sumber.

sumber/lokasi

Diperlukan kecuali Anda menyetel <source-type>keCODEPIPELINE. Lokasi kode sumber untuk jenis repositori yang ditentukan.

Untuk CodeCommit, URL kloning HTTPS ke repositori yang berisi kode sumber dan file buildspec (misalnya,). https://git-codecommit.<region-id>.amazonaws.com/v1/repos/<repo-name>
Untuk Amazon S3, nama bucket input build, diikuti dengan path dan nama file ZIP yang berisi kode sumber dan buildspec. Sebagai contoh:
- Untuk file ZIP yang terletak di root bucket input:<bucket-name>/<object-name>.zip.
- Untuk file ZIP yang terletak di subfolder di bucket input:<bucket-name>/<subfoler-path>/<object-name>.zip.
Untuk GitHub, URL kloning HTTPS ke repositori yang berisi kode sumber dan file buildspec. URL harus berisi github.com. Anda harus menghubungkan AWS akun Anda ke GitHub akun Anda. Untuk melakukan ini, gunakan CodeBuild konsol untuk membuat proyek build.
- Pilih Otorisasi aplikasi. (Setelah Anda terhubung ke GitHub akun Anda, Anda tidak perlu menyelesaikan pembuatan proyek build. Anda dapat menutup CodeBuild konsol.)
Untuk GitHub Enterprise Server, HTTP atau HTTPS mengkloning URL ke repositori yang berisi kode sumber dan file buildspec. Anda juga harus menghubungkan AWS akun Anda ke akun GitHub Enterprise Server Anda. Untuk melakukan ini, gunakan CodeBuild konsol untuk membuat proyek build.
1. Buat token akses pribadi di Server GitHub Perusahaan.
2. Salin token ini ke clipboard Anda sehingga Anda dapat menggunakannya saat membuat proyek Anda. CodeBuild Untuk informasi selengkapnya, lihat Membuat token akses pribadi untuk baris perintah di situs web GitHub Bantuan.
3. Saat Anda menggunakan konsol untuk membuat CodeBuild proyek Anda, di Sumber, untuk penyedia Sumber, pilih GitHubEnterprise.
4. Untuk Token Akses Pribadi, tempel token yang disalin ke clipboard Anda. Pilih Simpan Token. CodeBuild Akun Anda sekarang terhubung ke akun GitHub Enterprise Server Anda.
Untuk GitLab dan GitLab dikelola sendiri, HTTPS mengkloning URL ke repositori yang berisi kode sumber dan file buildspec. Perhatikan bahwa jika Anda menggunakan GitLab, URL harus berisi gitlab.com. Jika Anda menggunakan GitLab self-managed, URL tidak perlu berisi gitlab.com. Anda harus menghubungkan AWS akun Anda ke akun Anda GitLab atau yang GitLab dikelola sendiri. Untuk melakukan ini, gunakan CodeBuild konsol untuk membuat proyek build.
- Di panel navigasi Alat Pengembang, pilih Pengaturan, Koneksi, lalu Buat koneksi. Di halaman ini, buat koneksi yang GitLab dikelola sendiri GitLab atau yang dikelola sendiri, lalu pilih Connect to GitLab.
Untuk Bitbucket, URL kloning HTTPS ke repositori yang berisi kode sumber dan file buildspec. URL harus berisi bitbucket.org. Anda juga harus menghubungkan AWS akun Anda ke akun Bitbucket Anda. Untuk melakukan ini, gunakan CodeBuild konsol untuk membuat proyek build.
1. Ketika Anda menggunakan konsol untuk menghubungkan (atau menghubungkan kembali) dengan Bitbucket, pada halaman Mengonfirmasi akses ke akun Anda di Bitbucket, pilih Berikan akses. (Setelah Anda terhubung ke akun Bitbucket Anda, Anda tidak perlu menyelesaikan pembuatan proyek build. Anda dapat menutup CodeBuild konsol.)
Untuk AWS CodePipeline, jangan tentukan location nilai untuksource. CodePipeline mengabaikan nilai ini karena saat Anda membuat pipeline CodePipeline, Anda menentukan lokasi kode sumber di tahap Sumber pipeline.

sumber/ gitCloneDepth

Tidak wajib. Kedalaman riwayat yang akan diunduh. Nilai minimum adalah 0. Jika nilai ini adalah 0, lebih besar dari 25, atau tidak disediakan, maka riwayat penuh diunduh dengan setiap proyek build. Jika jenis sumber Anda adalah Amazon S3, nilai ini tidak didukung.

sumber/buildspec

Tidak wajib. Definisi spesifikasi build atau file yang akan digunakan. Jika nilai ini tidak disediakan atau diatur ke string kosong, kode sumber harus berisi buildspec.yml file dalam direktori root nya. Jika nilai ini disetel, itu bisa berupa definisi buildspec sebaris, jalur ke file buildspec alternatif relatif terhadap direktori root sumber utama Anda, atau jalur ke bucket S3. Bucket harus berada di AWS Wilayah yang sama dengan proyek pembangunan. Tentukan file buildspec menggunakan ARN (misalnya,). arn:aws:s3:::<my-codebuild-sample2>/buildspec.yml Untuk informasi selengkapnya, lihat Nama file Buildspec dan lokasi penyimpanan.

sumber/autentikasi

Jangan gunakan . Objek ini hanya digunakan oleh CodeBuild konsol.

sumber/ reportBuildStatus

Menentukan apakah akan mengirim status awal dan penyelesaian build kepada penyedia sumber Anda. Jika Anda mengatur ini dengan penyedia sumber selain GitHub, GitHub Enterprise Server, atau Bitbucket, akan invalidInputException dilemparkan.

Untuk dapat melaporkan status build ke penyedia sumber, pengguna yang terkait dengan penyedia sumber harus memiliki akses tulis ke repo. Jika pengguna tidak memiliki akses tulis, status build tidak dapat diperbarui. Untuk informasi selengkapnya, lihat Akses penyedia sumber.

sumber/ buildStatusConfig

Berisi informasi yang menentukan cara proyek CodeBuild build melaporkan status build ke penyedia sumber. Opsi ini hanya digunakan ketika jenis sumbernyaGITHUB,GITHUB_ENTERPRISE, atauBITBUCKET.

sumber//konteks buildStatusConfig

Untuk sumber Bitbucket, parameter ini digunakan untuk name parameter dalam status komit Bitbucket. Untuk GitHub sumber, parameter ini digunakan untuk context parameter dalam status GitHub komit.

Misalnya, Anda dapat memiliki context berisi nomor build dan pemicu webhook menggunakan variabel CodeBuild lingkungan:


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

Ini menghasilkan konteks yang muncul seperti ini untuk build #24 yang dipicu oleh peristiwa permintaan tarik webhook:


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

sumber//TargeTurl buildStatusConfig

Untuk sumber Bitbucket, parameter ini digunakan untuk url parameter dalam status komit Bitbucket. Untuk GitHub sumber, parameter ini digunakan untuk target_url parameter dalam status GitHub komit.

Misalnya, Anda dapat mengatur targetUrl ke https://aws.amazon.com/codebuild/<path to build> dan status komit akan ditautkan ke URL ini.

Anda juga dapat menyertakan variabel CodeBuild lingkungan targetUrl untuk menambahkan informasi tambahan ke URL. Misalnya, untuk menambahkan wilayah build ke URL, setel targetUrl ke:


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

Jika wilayah build adalahus-east-2, ini akan berkembang menjadi:


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

sumber/ gitSubmodulesConfig

Tidak wajib. Informasi tentang konfigurasi submodul Git. Digunakan dengan CodeCommit, GitHub, Server GitHub Perusahaan, dan Bitbucket saja.

sumber//fetchSubmodules gitSubmodulesConfig: Setel fetchSubmodules ke true jika Anda ingin menyertakan submodul Git dalam repositori Anda. Submodul Git yang disertakan harus dikonfigurasi sebagai HTTPS.

sumber/ InsecureSsl

Tidak wajib. Digunakan dengan GitHub Enterprise Server saja. Tetapkan nilai ini true untuk mengabaikan peringatan TLS saat menghubungkan ke repositori proyek GitHub Enterprise Server Anda. Nilai default adalah false. InsecureSsl harus digunakan hanya untuk tujuan pengujian. Ini tidak boleh digunakan di lingkungan produksi.

sumber/SourceIdentifier

Pengidentifikasi yang ditentukan pengguna untuk sumber proyek. Opsional untuk sumber utama. Diperlukan untuk sumber sekunder.

SecondarySources

Tidak wajib. Array ProjectSourceobjek yang berisi informasi tentang sumber sekunder untuk proyek build. Anda dapat menambahkan hingga 12 sumber sekunder. secondarySourcesObjek menggunakan properti yang sama yang digunakan oleh sumber objek. Dalam objek sumber sekunder, sourceIdentifier diperlukan.

secondarySourceVersions

Tidak wajib. Susunan objek ProjectSourceVersion. Jika secondarySourceVersions ditentukan pada level build, maka mereka lebih diutamakan daripada ini.

SourceVersion

Tidak wajib. Versi input build yang akan dibangun untuk proyek ini. Jika tidak ditentukan, versi terbaru digunakan. Jika ditentukan, itu harus berupa salah satu dari:

Untuk CodeCommit, ID komit, cabang, atau tag Git yang akan digunakan.
Untuk GitHub, ID komit, ID permintaan tarik, nama cabang, atau nama tag yang sesuai dengan versi kode sumber yang ingin Anda buat. Jika ID permintaan tarik ditentukan, itu harus menggunakan format pr/pull-request-ID (misalnya pr/25). Jika nama cabang ditentukan, ID melakukan HEAD cabang digunakan. Jika tidak ditentukan, ID melakukan HEAD cabang default digunakan.
Untuk GitLab, ID komit, ID permintaan tarik, nama cabang, nama tag, atau referensi, dan ID komit. Untuk informasi selengkapnya, lihat Contoh versi sumber dengan AWS CodeBuild.
Untuk Bitbucket, ID komit, nama cabang, atau nama tag yang sesuai dengan versi kode sumber yang ingin Anda buat. Jika nama cabang ditentukan, ID melakukan HEAD cabang digunakan. Jika tidak ditentukan, ID melakukan HEAD cabang default digunakan.
Untuk Amazon S3, ID versi objek yang mewakili file ZIP input build yang akan digunakan.

Jika sourceVersion ditentukan pada tingkat pembuatan, maka versi tersebut akan mengambil alih sourceVersion ini (di tingkat proyek). Untuk informasi selengkapnya, lihat Contoh versi sumber dengan AWS CodeBuild.

artefak

Wajib. ProjectArtifactsObjek yang berisi informasi tentang pengaturan artefak keluaran proyek build ini. Setelah Anda menambahkan artifacts objek, Anda dapat menambahkan hingga 12 artefak lagi menggunakan. secondaryArtifacts Pengaturan ini meliputi yang berikut:

artefak/jenis

Wajib. Jenis artefak output build. Nilai yang valid adalah:

CODEPIPELINE
NO_ARTIFACTS
S3

artefak/lokasi