Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Tutorial: Konfigurasikan CodeBuild pelari GitHub Tindakan yang di-host
Tutorial ini menunjukkan cara mengkonfigurasi CodeBuild proyek Anda untuk menjalankan pekerjaan GitHub Actions. Untuk informasi selengkapnya tentang menggunakan GitHub Tindakan dengan CodeBuild lihat[Tutorial: Konfigurasikan CodeBuild pelari GitHub Tindakan yang di-host](#action-runner).
Untuk menyelesaikan tutorial ini, Anda harus terlebih dahulu:
+ Terhubung dengan token akses pribadi, rahasia Secrets Manager, OAuth aplikasi, atau GitHub Aplikasi. Jika Anda ingin terhubung dengan OAuth aplikasi, Anda harus menggunakan CodeBuild konsol untuk melakukannya. Jika Anda ingin membuat token akses pribadi, Anda dapat menggunakan CodeBuild konsol atau menggunakan [ImportSourceCredentials API](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ImportSourceCredentials.html). Untuk instruksi lebih lanjut, lihat[GitHub dan akses Server GitHub Perusahaan di CodeBuild](access-tokens-github-overview.md).
+ Connect CodeBuild ke GitHub akun Anda. Untuk melakukannya, Anda dapat melakukan salah satu dari yang berikut:
+ Anda dapat menambahkan GitHub sebagai penyedia sumber di konsol. Anda dapat terhubung dengan token akses pribadi, rahasia Secrets Manager, OAuth aplikasi, atau GitHub App. Untuk petunjuk, lihat [GitHub dan akses Server GitHub Perusahaan di CodeBuild](access-tokens-github-overview.md).
+ [Anda dapat mengimpor GitHub kredensil Anda melalui API. ImportSourceCredentials ](https://docs.aws.amazon.com/cli/latest/reference/codebuild/import-source-credentials.html) Ini hanya dapat dilakukan dengan token akses pribadi. Jika Anda terhubung menggunakan OAuth aplikasi, Anda harus terhubung menggunakan konsol sebagai gantinya. Untuk petunjuk, lihat [Connect GitHub dengan token akses (CLI)](access-tokens-github.md#access-tokens-github-cli).
**catatan**
Ini hanya perlu dilakukan jika Anda belum terhubung ke GitHub akun Anda.
## Langkah 1: Buat CodeBuild proyek dengan webhook
Pada langkah ini, Anda akan membuat CodeBuild proyek dengan webhook dan meninjaunya di GitHub konsol. Anda juga dapat memilih GitHub Enterprise sebagai penyedia sumber Anda. Untuk mempelajari selengkapnya tentang membuat webhook dalam GitHub Enterprise, lihat[GitHub webhook manual](github-manual-webhook.md).
**Untuk membuat CodeBuild proyek dengan webhook**
1. Buka AWS CodeBuild konsol di [https://console.aws.amazon.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home).
1. Buat proyek build. Untuk informasi selengkapnya, lihat [Buat proyek build (konsol)](create-project.md#create-project-console) dan [Jalankan build (konsol)](run-build-console.md).
1. Pada **tipe Project**, pilih **Runner project**.
Di **Runner**:
1. Untuk **penyedia Runner**, pilih **GitHub**.
1. Untuk **lokasi Runner**, pilih **Repository**.
1. **Untuk URL Repositori di bawah Repositori, pilih **nama repositori**. https://github.com/user-name/**
**catatan**
Secara default, proyek Anda hanya akan menerima `WORKFLOW_JOB_QUEUED` peristiwa untuk satu repositori. Jika Anda ingin menerima acara untuk semua repositori dalam organisasi atau perusahaan, lihat. [GitHub webhook global dan organisasi](github-global-organization-webhook.md)
1.
+ Di **Lingkungan**:
+ Pilih **gambar Lingkungan** yang didukung dan **Compute**. Perhatikan bahwa Anda memiliki opsi untuk mengganti setelan gambar dan instans dengan menggunakan label di alur kerja GitHub Actions YAMP. Untuk informasi selengkapnya, lihat [Langkah 2: Perbarui alur kerja GitHub Tindakan Anda YAMB](#sample-github-action-runners-update-yaml)
+ Di **Buildspec**:
+ Perhatikan bahwa buildspec Anda akan diabaikan kecuali `buildspec-override:true` ditambahkan sebagai label. Sebagai gantinya, CodeBuild akan menimpanya untuk menggunakan perintah yang akan mengatur pelari yang dihosting sendiri.
1. Lanjutkan dengan nilai default dan kemudian pilih **Create build project**.
1. Buka GitHub konsol di `https://github.com/user-name/repository-name/settings/hooks` untuk memverifikasi bahwa webhook telah dibuat dan diaktifkan untuk mengirimkan peristiwa **pekerjaan Alur Kerja**.
## Langkah 2: Perbarui alur kerja GitHub Tindakan Anda YAMB
Pada langkah ini, Anda akan memperbarui file YAMAL alur kerja GitHub Actions [https://github.com/](https://github.com/)untuk mengonfigurasi lingkungan build dan menggunakan runner yang dihosting sendiri GitHub Actions di. CodeBuild Untuk informasi selengkapnya, lihat [Menggunakan label dengan pelari yang dihosting sendiri](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners) dan. [Penggantian label didukung dengan runner Tindakan yang CodeBuild di-host GitHub](sample-github-action-runners-update-labels.md)
### Memperbarui alur kerja GitHub Tindakan YAMM
Arahkan ke [https://github.com/](https://github.com/)dan perbarui [https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners)setelan di alur kerja GitHub Tindakan YAMM untuk mengonfigurasi lingkungan build Anda. Untuk melakukannya, Anda dapat melakukan salah satu dari yang berikut:
+ Anda dapat menentukan nama proyek dan menjalankan ID, dalam hal ini build akan menggunakan konfigurasi proyek yang ada untuk komputasi, gambar, versi gambar, dan ukuran instance. Nama proyek diperlukan untuk menautkan pengaturan AWS terkait pekerjaan GitHub Tindakan Anda ke CodeBuild proyek tertentu. Dengan memasukkan nama proyek di YAMAL, CodeBuild diizinkan untuk memanggil pekerjaan dengan pengaturan proyek yang benar. Dengan memberikan ID run, CodeBuild akan memetakan build Anda ke alur kerja tertentu yang berjalan dan menghentikan build saat alur kerja dijalankan dibatalkan. Untuk informasi lebih lanjut, lihat [`github`konteks](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context).
```
runs-on: codebuild--${{ github.run_id }}-${{ github.run_attempt }}
```
**catatan**
Pastikan bahwa Anda ** cocok dengan nama proyek yang Anda buat pada langkah sebelumnya. Jika tidak cocok, tidak CodeBuild akan memproses webhook dan alur kerja GitHub Actions mungkin hang.
Berikut ini adalah contoh alur kerja GitHub Actions YAMAL:
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
steps:
- run: echo "Hello World!"
```
+ Anda juga dapat mengganti gambar dan jenis komputasi di label. Lihat [Hitung gambar yang didukung dengan runner CodeBuild Actions -hosted GitHub](sample-github-action-runners-update-yaml.images.md) untuk daftar gambar yang dikuratori. Untuk menggunakan gambar kustom, lihat[Penggantian label didukung dengan runner Tindakan yang CodeBuild di-host GitHub](sample-github-action-runners-update-labels.md). Jenis komputasi dan gambar dalam label akan mengganti pengaturan lingkungan pada proyek Anda. Untuk mengganti setelan lingkungan Anda untuk build komputasi CodeBuild EC2 atau Lambda, gunakan sintaks berikut:
```
runs-on:
- codebuild--${{ github.run_id }}-${{ github.run_attempt }}
image:-
instance-size:
```
Berikut ini adalah contoh alur kerja GitHub Actions YAMAL:
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
image:arm-3.0
instance-size:small
steps:
- run: echo "Hello World!"
```
+ Anda dapat mengganti armada yang digunakan untuk build Anda di label. Ini akan menggantikan pengaturan armada yang dikonfigurasi pada proyek Anda untuk menggunakan armada yang ditentukan. Untuk informasi selengkapnya, lihat [Jalankan build di atas armada kapasitas cadangan](fleets.md). Untuk mengganti setelan armada untuk build komputasi Amazon EC2, gunakan sintaks berikut:
```
runs-on:
- codebuild--${{ github.run_id }}-${{ github.run_attempt }}
fleet:
```
Untuk mengganti armada dan gambar yang digunakan untuk build, gunakan sintaks berikut:
```
runs-on:
- codebuild--${{ github.run_id }}-${{ github.run_attempt }}
fleet:
image:-
```
Berikut ini adalah contoh alur kerja GitHub Actions YAMAL:
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
fleet:myFleet
image:arm-3.0
steps:
- run: echo "Hello World!"
```
+ Untuk menjalankan pekerjaan GitHub Actions pada gambar kustom, Anda dapat mengonfigurasi gambar kustom dalam CodeBuild proyek Anda dan menghindari memberikan label penggantian gambar. CodeBuild akan menggunakan gambar yang dikonfigurasi dalam proyek jika tidak ada label penggantian gambar yang disediakan.
+ Secara opsional, Anda dapat memberikan label di luar label yang CodeBuild mendukung. Label ini akan diabaikan untuk tujuan mengesampingkan atribut build, tetapi tidak akan gagal dalam permintaan webhook. Misalnya, menambahkan `testLabel` sebagai label tidak akan mencegah build berjalan.
**catatan**
Jika dependensi yang disediakan oleh pelari GitHub -host tidak tersedia di CodeBuild lingkungan, Anda dapat menginstal dependensi menggunakan GitHub Tindakan dalam alur kerja Anda. Misalnya, Anda dapat menggunakan [https://github.com/actions/setup-python](https://github.com/actions/setup-python)tindakan untuk menginstal Python untuk lingkungan build Anda.
### Jalankan perintah buildspec fase INSTALL, PRE\$1BUILD, dan POST\$1BUILD
Secara default, CodeBuild abaikan perintah buildspec apa pun saat menjalankan build Actions yang dihosting sendiri. GitHub Untuk menjalankan perintah buildspec selama build, `buildspec-override:true` dapat ditambahkan sebagai akhiran label:
```
runs-on:
- codebuild--${{ github.run_id }}-${{ github.run_attempt }}
buildspec-override:true
```
Dengan menggunakan perintah ini, CodeBuild akan membuat folder yang disebut `actions-runner` dalam folder sumber utama wadah. Ketika GitHub Actions runner dimulai selama `BUILD` fase, runner akan berjalan di direktori. `actions-runner`
Ada beberapa batasan saat menggunakan penggantian buildspec dalam build Tindakan yang dihosting sendiri: GitHub
+ CodeBuild tidak akan menjalankan perintah buildspec selama `BUILD` fase, karena pelari yang di-host sendiri berjalan dalam fase tersebut. `BUILD`
+ CodeBuild tidak akan mengunduh sumber primer atau sekunder apa pun selama `DOWNLOAD_SOURCE` fase berlangsung. Jika Anda memiliki file buildspec yang dikonfigurasi, hanya file itu yang akan diunduh dari sumber utama proyek.
+ Jika perintah build gagal di `INSTALL` fase `PRE_BUILD` atau, tidak CodeBuild akan memulai runner yang dihosting sendiri dan pekerjaan alur kerja GitHub Actions harus dibatalkan secara manual.
+ CodeBuild mengambil token runner selama `DOWNLOAD_SOURCE` fase, yang memiliki waktu kedaluwarsa satu jam. Jika `INSTALL` fase `PRE_BUILD` atau fase Anda melebihi satu jam, token runner mungkin kedaluwarsa sebelum runner yang GitHub di-host sendiri dimulai.
## Langkah 3: Tinjau hasil Anda
Setiap kali alur kerja GitHub Tindakan dijalankan, CodeBuild akan menerima peristiwa pekerjaan alur kerja melalui webhook. Untuk setiap pekerjaan dalam alur kerja, CodeBuild mulai build untuk menjalankan runner Actions sesaat. GitHub Pelari bertanggung jawab untuk mengeksekusi satu pekerjaan alur kerja. Setelah pekerjaan selesai, runner dan proses build terkait akan segera dihentikan.
Untuk melihat log pekerjaan alur kerja, navigasikan ke repositori GitHub, pilih **Tindakan**, pilih alur kerja yang diinginkan, lalu pilih **Job** spesifik yang ingin Anda tinjau log.
Anda dapat meninjau label yang diminta di log saat pekerjaan menunggu untuk diambil oleh pelari yang di-host sendiri. CodeBuild
![\[Memuat log pekerjaan.\]](http://docs.aws.amazon.com/id_id/codebuild/latest/userguide/images/hello-world-loading.png)
Setelah pekerjaan selesai, Anda akan dapat melihat log pekerjaan.
![\[Log pekerjaan.\]](http://docs.aws.amazon.com/id_id/codebuild/latest/userguide/images/hello-world-log.png)
## GitHub Opsi konfigurasi pelari tindakan
Anda dapat menentukan variabel lingkungan berikut dalam konfigurasi proyek Anda untuk mengubah konfigurasi penyiapan pelari yang dihosting sendiri.
`CODEBUILD_CONFIG_GITHUB_ACTIONS_ORG_REGISTRATION_NAME`
CodeBuild akan mendaftarkan pelari yang dihosting sendiri ke nama organisasi yang ditentukan sebagai nilai variabel lingkungan ini. Untuk informasi selengkapnya tentang mendaftarkan pelari di tingkat organisasi dan izin yang diperlukan, lihat [Membuat konfigurasi untuk just-in-time pelari untuk](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#create-configuration-for-a-just-in-time-runner-for-an-organization) organisasi.
`CODEBUILD_CONFIG_GITHUB_ACTIONS_ENTERPRISE_REGISTRATION_NAME`
CodeBuild akan mendaftarkan pelari yang dihosting sendiri ke nama perusahaan yang ditentukan sebagai nilai variabel lingkungan ini. Untuk informasi selengkapnya tentang mendaftarkan pelari di tingkat perusahaan dan izin yang diperlukan, lihat [Membuat konfigurasi untuk just-in-time pelari untuk](https://docs.github.com/en/enterprise-server/rest/actions/self-hosted-runners?apiVersion=2022-11-28#create-configuration-for-a-just-in-time-runner-for-an-enterprise) Perusahaan.
Pelari perusahaan tidak tersedia untuk repositori organisasi secara default. Agar pelari yang dihosting sendiri dapat mengambil pekerjaan alur kerja, Anda mungkin perlu mengonfigurasi setelan akses grup pelari Anda. Untuk informasi selengkapnya, lihat [Membuat pelari perusahaan tersedia untuk repositori](https://docs.github.com/en/enterprise-server/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners#making-enterprise-runners-available-to-repositories).
`CODEBUILD_CONFIG_GITHUB_ACTIONS_RUNNER_GROUP_ID`
CodeBuild akan mendaftarkan pelari yang dihosting sendiri ke ID grup pelari integer yang disimpan sebagai nilai variabel lingkungan ini. Secara default, nilai ini adalah 1. Untuk informasi selengkapnya tentang grup pelari yang dihosting sendiri, lihat [Mengelola akses ke pelari yang dihosting sendiri menggunakan](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#create-configuration-for-a-just-in-time-runner-for-an-organization) grup.
`CODEBUILD_CONFIG_GITHUB_ACTIONS_ORG_REGISTRATION_NAME`
Untuk mengonfigurasi pendaftaran runner tingkat organisasi menggunakan file GitHub YAMAL alur kerja Actions, Anda dapat menggunakan sintaks berikut:
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
organization-registration-name:myOrganization
steps:
- run: echo "Hello World!"
```
`CODEBUILD_CONFIG_GITHUB_ACTIONS_ENTERPRISE_REGISTRATION_NAME`
Untuk mengonfigurasi pendaftaran pelari tingkat perusahaan menggunakan file GitHub YAMAL alur kerja Actions, Anda dapat menggunakan sintaks berikut:
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
enterprise-registration-name:myEnterprise
steps:
- run: echo "Hello World!"
```
`CODEBUILD_CONFIG_GITHUB_ACTIONS_RUNNER_GROUP_ID`
Untuk mengonfigurasi registrasi runner ke ID grup runner tertentu menggunakan file YAMM alur kerja GitHub Actions, Anda dapat menggunakan sintaks berikut:
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
registration-group-id:3
steps:
- run: echo "Hello World!"
```
## Filter GitHub Tindakan acara webhook ()CloudFormation
Bagian CloudFormation template yang diformat YAML berikut akan membuat grup filter yang memicu build saat dievaluasi ke true. Grup filter berikut menentukan permintaan pekerjaan alur kerja GitHub Tindakan dengan nama alur kerja yang cocok dengan ekspresi reguler. `\[CI-CodeBuild\]`
```
CodeBuildProject:
Type: AWS::CodeBuild::Project
Properties:
Name: MyProject
ServiceRole: service-role
Artifacts:
Type: NO_ARTIFACTS
Environment:
Type: LINUX_CONTAINER
ComputeType: BUILD_GENERAL1_SMALL
Image: aws/codebuild/standard:5.0
Source:
Type: GITHUB
Location: CODEBUILD_DEFAULT_WEBHOOK_SOURCE_LOCATION
Triggers:
Webhook: true
ScopeConfiguration:
Name: organization-name
Scope: GITHUB_ORGANIZATION
FilterGroups:
- - Type: EVENT
Pattern: WORKFLOW_JOB_QUEUED
- Type: WORKFLOW_NAME
Pattern: \[CI-CodeBuild\]
```
## Filter GitHub Tindakan acara webhook ()AWS CDK
AWS CDK Template berikut membuat grup filter yang memicu build saat dievaluasi ke true. Grup filter berikut menentukan permintaan pekerjaan alur kerja GitHub Tindakan.
```
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
import {EventAction, FilterGroup} from "aws-cdk-lib/aws-codebuild";
const source = codebuild.Source.gitHub({
owner: 'owner',
repo: 'repo',
webhook: true,
webhookFilters: [FilterGroup.inEventOf(EventAction.WORKFLOW_JOB_QUEUED)],
})
```
## Filter GitHub Tindakan acara webhook (Terraform)
Template Terraform berikut membuat grup filter yang memicu build saat dievaluasi ke true. Grup filter berikut menentukan permintaan pekerjaan alur kerja GitHub Tindakan.
```
resource "aws_codebuild_webhook" "example" {
project_name = aws_codebuild_project.example.name
build_type = "BUILD"
filter_group {
filter {
type = "EVENT"
pattern = "WORKFLOW_JOB_QUEUED"
}
}
}
```
## Filter GitHub Tindakan acara webhook ()AWS CLI
AWS CLI Perintah berikut membuat project runner GitHub Actions yang dihosting sendiri dengan grup filter permintaan pekerjaan alur kerja GitHub Actions yang memicu build saat dievaluasi ke true.
```
aws codebuild create-project \
--name \
--source "{\"type\":\"GITHUB\",\"location\":\"\",\"buildspec\":\"\"}" \
--artifacts {"\"type\":\"NO_ARTIFACTS\""} \
--environment "{\"type\": \"LINUX_CONTAINER\",\"image\": \"aws/codebuild/amazonlinux-x86_64-standard:5.0\",\"computeType\": \"BUILD_GENERAL1_MEDIUM\"}" \
--service-role ""
```
```
aws codebuild create-webhook \
--project-name \
--filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"WORKFLOW_JOB_QUEUED\"}]]"
```