Buat referensi spesifikasi untuk CodeBuild

Urutan opsional. Menentukan shell yang didukung untuk sistem operasi Linux atau Windows.

Untuk sistem operasi Linux, tag shell yang didukung adalah:

Untuk sistem operasi Windows, tag shell yang didukung adalah:

Diperlukan jika env ditentukan, dan Anda ingin menentukan variabel lingkungan khusus dalam teks biasa. Berisi pemetaan value sk key alar/, di mana setiap pemetaan mewakili satu variabel lingkungan khusus dalam teks biasa. keyadalah nama variabel lingkungan khusus, dan value merupakan nilai variabel itu.

Diperlukan jika env ditentukan, dan Anda ingin mengambil variabel lingkungan khusus yang disimpan di Amazon EC2 Systems Manager Parameter Store. Berisi pemetaan value sk key alar/, di mana setiap pemetaan mewakili satu variabel lingkungan khusus yang disimpan di Amazon EC2 Systems Manager Parameter Store. keyadalah nama yang Anda gunakan nanti dalam perintah build untuk merujuk ke variabel lingkungan khusus ini, dan value merupakan nama variabel lingkungan khusus yang disimpan di Amazon EC2 Systems Manager Parameter Store. Untuk menyimpan nilai sensitif, lihat Peny impanan Parameter dan Panduan Manajer Sistem: Membuat dan menguji parameter String (konsol) di Panduan Pengguna Amazon EC2 Systems Manager.

Diperlukan jika Anda ingin mengambil variabel lingkungan khusus yang disimpan di AWS Secrets Manager. Tentukan Manajer Rahasia reference-key menggunakan pola berikut:

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

Dalam contoh berikut, TestSecret adalah nama pasangan kunci-nilai yang disimpan di Secrets Manager. Kuncinya TestSecret adalahMY_SECRET_VAR. Anda mengakses variabel selama build menggunakan LOCAL_SECRET_VAR nama.

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

Untuk informasi selengkapnya, lihat Apa itu AWS Secrets Manager dalam Panduan Pengguna AWS Secrets Manager .

Pemetaan opsional. Digunakan untuk membuat daftar variabel lingkungan yang ingin Anda ekspor. Tentukan nama setiap variabel yang ingin Anda ekspor pada baris terpisah di bawahnyaexported-variables. Variabel yang ingin Anda ekspor harus tersedia di wadah Anda selama pembuatan. Variabel yang Anda ekspor dapat menjadi variabel lingkungan.

Variabel lingkungan yang diekspor digunakan bersama dengan AWS CodePipeline untuk mengekspor variabel lingkungan dari tahap pembuatan saat ini ke tahap berikutnya dalam pipeline. Untuk informasi selengkapnya, lihat Bek erja dengan variabel di Panduan AWS CodePipeline Pengguna.

Selama build, nilai variabel tersedia dimulai dengan install fase. Ini dapat diperbarui antara awal install fase dan akhir post_build fase. Setelah post_build fase berakhir, nilai variabel yang diekspor tidak dapat berubah.

Pemetaan opsional. Digunakan untuk menunjukkan apakah CodeBuild menggunakan pembantu kredensi Git untuk memberikan kredenSIAL Git. yesjika digunakan. Jika tidak, no atau tidak ditentukan. Untuk informasi selengkapnya, lihat git di situs web Git.

Pemetaan opsional. Setel ke yes jika Anda ingin build Anda di server proxy eksplisit untuk mengunggah artefak. Nilai default-nya no.

Pemetaan opsional. Setel ke yes untuk build Anda di server proxy eksplisit untuk membuat CloudWatch log. Nilai default-nya no.

Urutan opsional. Gunakan dalam fase build untuk menentukan pengguna Linux yang menjalankan perintahnya. Jika juga run-as ditentukan secara global untuk semua perintah di bagian atas file buildspec, maka pengguna tingkat fase diutamakan. Misalnya, jika secara global run-as menentukan User-1, dan untuk install fase hanya run-as pernyataan yang ditentukan User-2, maka semua perintah dalam file buildspec dijalankan sebagai perintah User-1 kecuali dalam install fase, yang dijalankan sebagai. User-2

Urutan opsional. Menentukan tindakan yang harus diambil jika kegagalan terjadi selama fase. Ini dapat berupa salah satu dari nilai berikut:

Jika properti ini tidak ditentukan, proses kegagalan mengikuti fase transisi seperti yang ditunjukkan padaBangun transisi fase.

Blok opsional. Perintah yang ditentukan dalam finally blok dijalankan setelah perintah di commands blok. Perintah dalam finally blok dijalankan bahkan jika perintah di commands blok gagal. Misalnya, jika commands blok berisi tiga perintah dan yang pertama gagal, mele CodeBuild watkan dua perintah yang tersisa dan menjalankan perintah apa pun di finally blok. Fase ini berhasil ketika semua perintah di commands dan finally blok berjalan dengan sukses. Jika ada perintah dalam fase gagal, fase gagal.

Urutan opsional. Merupakan perintah, jika ada, yang CodeBuild berjalan selama instalasi. Kami menyarankan Anda menggunakan install fase hanya untuk menginstal paket di lingkungan build. Misalnya, Anda dapat menggunakan fase ini untuk menginstal kerangka pengujian kode seperti Mocha atau RSpec.

Urutan opsional. Merupakan perintah, jika ada, yang CodeBuild berjalan sebelum build. Misalnya, Anda dapat menggunakan fase ini untuk masuk ke Amazon ECR, atau Anda dapat menginstal dependensi npm.

Urutan opsional. Merupakan perintah, jika ada, yang CodeBuild berjalan selama pembuatan. Misalnya, Anda dapat menggunakan fase ini untuk menjalankan Mocha, RSpec, atau sbt.

Urutan opsional. Merupakan perintah, jika ada, yang CodeBuild berjalan setelah build. Misalnya, Anda dapat menggunakan Maven untuk mengemas artefak build ke dalam file JAR atau WAR, atau Anda dapat mendorong gambar Docker ke Amazon ECR. Kemudian Anda dapat mengirim pemberitahuan build melalui Amazon SNS.

Urutan opsional. Menentukan grup laporan tempat laporan dikirim. Sebuah proyek dapat memiliki maksimal lima kelompok laporan. Tentukan ARN dari grup laporan yang ada, atau nama grup laporan baru. Jika Anda menentukan nama, CodeBuild buat grup laporan menggunakan nama proyek Anda dan nama yang Anda tentukan dalam format<project-name>-<report-group-name>. Nama grup laporan juga dapat diatur menggunakan variabel lingkungan di buildspec seperti. $REPORT_GROUP_NAME Untuk informasi selengkapnya, lihat Penamaan grup laporan.

Urutan yang diperlukan. Merupakan lokasi yang berisi data mentah hasil pengujian yang dihasilkan oleh laporan. Berisi urutan skalar, dengan setiap skalar mewakili lokasi terpisah di mana CodeBuild dapat menemukan file uji, relatif terhadap lokasi build asli atau, jika disetel,. base-directory Lokasi dapat mencakup yang berikut:

Pemetaan opsional. Merupakan format file laporan. Jika tidak ditentukan, JUNITXML digunakan. Nilai ini tidak peka huruf besar/kecil. Kemungkinan nilainya adalah:

Pemetaan opsional. Merupakan satu atau lebih direktori tingkat atas, relatif terhadap lokasi build asli, yang CodeBuild digunakan untuk menentukan di mana menemukan file pengujian mentah.

Tidak wajib. Menentukan apakah direktori file laporan diratakan dalam output. Jika ini tidak ditentukan, atau berisino, file laporan dikeluarkan dengan struktur direktori mereka utuh. Jika ini berisiyes, semua file uji ditempatkan di direktori output yang sama. Misalnya, jika jalur ke hasil tes adalahcom/myapp/mytests/TestResult.xml, menentukan yes akan menempatkan file ini di/TestResult.xml.

Urutan yang diperlukan. Merupakan lokasi yang berisi artefak keluaran build di lingkungan build. Berisi urutan skalar, dengan setiap skalar mewakili lokasi terpisah di mana CodeBuild dapat menemukan artefak keluaran build, relatif terhadap lokasi build asli atau, jika disetel, direktori dasar. Lokasi dapat mencakup yang berikut:

Saat Anda menentukan lokasi artefak keluaran build, CodeBuild dapat menemukan lokasi build asli di lingkungan build. Anda tidak perlu menyiapkan lokasi keluaran artefak build Anda dengan jalur ke lokasi build asli atau menentukan ./ atau serupa. Jika Anda ingin mengetahui jalur ke lokasi ini, Anda dapat menjalankan perintah seperti echo $CODEBUILD_SRC_DIR selama build. Lokasi untuk setiap lingkungan build mungkin sedikit berbeda.

Nama opsional. Menentukan nama untuk artefak build Anda. Nama ini digunakan jika salah satu dari berikut ini benar.

Anda dapat menentukan nama dalam file buildspec yang dihitung pada waktu pembuatan. Nama yang ditentukan dalam file buildspec menggunakan bahasa perintah Shell. Misalnya, Anda dapat menambahkan tanggal dan waktu untuk nama artefak Anda sehingga selalu unik. Nama artefak yang unik mencegah artefak dituliskan. Untuk informasi selengkapnya, lihat bahasa perintah Shell.

Anda dapat menambahkan informasi jalur ke nama sehingga artefak bernama ditempatkan di direktori berdasarkan jalur dalam nama. Dalam contoh ini, artefak build ditempatkan di output di bawahbuilds/<build number>/my-artifacts.

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

Tidak wajib. Menentukan apakah direktori artefak build diratakan dalam output. Jika ini tidak ditentukan, atau berisino, artefak build dikeluarkan dengan struktur direktorinya utuh. Jika ini berisiyes, semua artefak build ditempatkan di direktori output yang sama. Misalnya, jika jalur ke file dalam artefak keluaran build adalahcom/mycompany/app/HelloWorld.java, menentukan yes akan menempatkan file ini di/HelloWorld.java.

Pemetaan opsional. Merupakan satu atau lebih direktori tingkat atas, relatif terhadap lokasi build asli, yang CodeBuild digunakan untuk menentukan file dan subdirektori mana yang akan disertakan dalam artefak keluaran build. Nilai yang valid meliputi:

Direktori tingkat atas yang cocok tidak disertakan dalam artefak keluaran build, hanya file dan subdirektori mereka.

Anda dapat menggunakan files dan discard-paths untuk lebih membatasi file dan subdirektori mana yang disertakan. Misalnya, untuk struktur direktori berikut:

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

Dan untuk artifacts urutan berikut:

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

Subdirektori dan file berikut akan disertakan dalam artefak keluaran build:

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

Sedangkan untuk artifacts urutan berikut:

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

File-file berikut akan disertakan dalam artefak keluaran build:

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

Pemetaan opsional. Merupakan satu atau lebih jalur, relatif terhadapbase-directory, yang CodeBuild akan dikecualikan dari artefak build. Karakter tanda bintang (*) cocok dengan karakter nol atau karakter lain dari komponen nama tanpa melintasi batas folder. Tanda bintang ganda (**) cocok dengan nol atau lebih karakter komponen nama di semua direktori.

Contoh jalur pengecualian meliputi:

Tidak wajib. Jika tipe output adalahZIP, menentukan apakah tautan simbolik internal dipertahankan dalam file ZIP. Jika ini berisiyes, semua tautan simbolik internal di sumber akan dipertahankan dalam file ZIP artefak.

Tidak wajib. Menentukan awalan yang digunakan saat artefak dikeluarkan ke bucket Amazon S3 dan jenis namespace adalahBUILD_ID. Saat digunakan, jalur keluaran di bucket adalah<s3-prefix>/<build-id>/<name>.zip.

Urutan opsional. Merupakan satu atau lebih definisi artefak sebagai pemetaan antara pengidentifikasi artefak dan definisi artefak. Setiap pengidentifikasi artefak di blok ini harus cocok dengan artefak yang ditentukan dalam secondaryArtifacts atribut proyek Anda. Setiap definisi terpisah memiliki sintaks yang sama dengan artifacts blok di atas.

Misalnya, jika proyek Anda memiliki struktur berikut:

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

Kemudian buildspec Anda terlihat seperti berikut:

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

Urutan opsional. Merupakan kunci utama yang digunakan saat mencari atau mengembalikan cache. CodeBuild melakukan kecocokan yang tepat untuk kunci utama.

Berikut adalah contoh untuk kuncinya:

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

Urutan opsional. Merupakan daftar kunci fallback yang digunakan secara berurutan ketika cache tidak dapat ditemukan menggunakan kunci primer. Hingga lima kunci fallback didukung, dan masing-masing dicocokkan menggunakan pencarian awalan. Urutan ini akan diabaikan jika kunci tidak disediakan.

Berikut adalah contoh untuk kunci fallback:

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

Urutan opsional. Menentukan tindakan yang akan dilakukan pada cache. Nilai yang valid meliputi:

Jika tidak ada nilai yang diberikan, CodeBuild default untuk melakukan pemulihan dan penyimpanan.

Urutan yang diperlukan. Merupakan lokasi cache. Berisi urutan skalar, dengan setiap skalar mewakili lokasi terpisah di mana CodeBuild dapat menemukan artefak keluaran build, relatif terhadap lokasi build asli atau, jika disetel, direktori dasar. Lokasi dapat mencakup yang berikut: