CodeStarSourceConnection untuk tindakan Bitbucket, GitHub, dan GitHub Enterprise Server - AWS CodePipeline

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

CodeStarSourceConnection untuk tindakan Bitbucket, GitHub, dan GitHub Enterprise Server

Memicu pipeline ketika commit baru dibuat pada repositori kode sumber pihak ketiga. Tindakan sumber mengambil perubahan kode ketika pipeline dijalankan secara manual atau ketika acara webhook dikirim dari penyedia sumber.

catatan

Fitur ini tidak tersedia di Wilayah Asia Pacific (Hong Kong) dan Europe (Milan). Untuk referensi tindakan lain yang tersedia, lihatIntegrasi produk dan layanan dengan CodePipeline.

Koneksi dapat mengaitkanAWSsumber daya dengan repositori pihak ketiga berikut:

  • Bitbucket Cloud (melaluiBitbucketopsi penyedia di konsol CodePipeline)

    catatan

    Anda dapat membuat koneksi ke repositori Bitbucket Cloud. Jenis penyedia Bitbucket yang diinstal, seperti Bitbucket Server, tidak didukung.

  • GitHub dan GitHub Enterprise Cloud (melaluiGitHub (Versi 2)opsi penyedia di konsol CodePipeline)

  • GitHub Enterprise Server (melaluiGitHub Enterprise Serveropsi penyedia di konsol CodePipeline)

catatan

Setiap koneksi mendukung semua repositori yang Anda miliki dengan penyedia tersebut. Anda hanya perlu membuat koneksi baru untuk setiap jenis penyedia.

Koneksi memungkinkan pipeline mendeteksi perubahan sumber melalui aplikasi instalasi penyedia pihak ketiga. Misalnya, webhooks digunakan untuk berlangganan tipe event GitHub dan dapat diinstal pada organisasi, repositori, atau Aplikasi GitHub. Koneksi Anda menginstal webhook repositori di Aplikasi GitHub yang berlangganan event tipe push GitHub.

Setelah perubahan kode terdeteksi, Anda memiliki opsi berikut untuk meneruskan kode ke tindakan selanjutnya:

  • Default: Seperti tindakan sumber CodePipeline lainnya yang ada,CodeStarSourceConnectiondapat menampilkan file ZIP dengan salinan dangkal komit Anda.

  • Kloning penuh:CodeStarSourceConnectionjuga dapat dikonfigurasi untuk output referensi URL ke repo untuk tindakan selanjutnya.

    Saat ini, referensi URL Git hanya dapat digunakan oleh tindakan CodeBuild hilir untuk mengkloning repo dan metadata Git terkait. Mencoba untuk meneruskan referensi URL Git ke tindakan non-codeBuild menghasilkan kesalahan.

CodePipeline meminta Anda untuk menambahkanAWSAplikasi instalasi konektor ke akun pihak ketiga saat Anda membuat koneksi. Anda harus sudah membuat akun dan repositori penyedia pihak ketiga Anda sebelum dapat terhubung melaluiCodeStarSourceConnectiontindakan.

catatan

Untuk membuat atau melampirkan kebijakan ke pengguna atau peran IAM Anda dengan izin yang diperlukan untuk menggunakan koneksi AWS CodeStar, lihatReferensi izin koneksi. Tergantung pada kapan peran layanan CodePipeline Anda dibuat, Anda mungkin perlu memperbarui izinnya untuk mendukung koneksi AWS CodeStar. Untuk petunjuk, lihat Tambahkan izin keCodePipelineperan layanan.

Tipe tindakan

  • Kategori:Source

  • Pemilik:AWS

  • Penyedia:CodeStarSourceConnection

  • Versi:1

Parameter konfigurasi

ConnectionARN

Diperlukan: Ya

Koneksi ARN yang dikonfigurasi dan diautentikasi untuk penyedia sumber.

FullRepositoryId

Diperlukan: Ya

Pemilik dan nama repositori di mana perubahan sumber harus dideteksi.

Contoh: some-user/my-repo

BranchName

Diperlukan: Ya

Nama cabang di mana perubahan sumber harus dideteksi.

OutputArtifactFormat

Diperlukan: Tidak

Menentukan output format artefak. Bisa berupaCODEBUILD_CLONE_REFatauCODE_ZIP. Jika tidak ditentukan, default adalahCODE_ZIP.

penting

ParameterCODEBUILD_CLONE_REFpilihan hanya dapat digunakan oleh CodeBuild tindakan hilir.

Jika Anda memilih opsi ini, Anda perlu memperbarui izin untuk peran layanan proyek CodeBuild Anda seperti yang ditunjukkan diTambahkan izin CodeBuild GitClone untuk koneksi ke Bitbucket, GitHub, atau GitHub Enterprise Server. Untuk tutorial yang menunjukkan cara menggunakanKloningpilihan, lihatTutorial: Gunakan klon penuh dengan sumber pipa GitHub.

DetectChanges

Diperlukan: Tidak

Kontrol secara otomatis memulai pipeline Anda ketika komit baru dibuat pada repositori dan cabang yang dikonfigurasi. Jika tidak ditentukan, nilai default adalahtrue, dan lapangan tidak ditampilkan secara default. Nilai yang valid untuk parameter ini:

  • true: CodePipeline secara otomatis memulai pipeline Anda pada commit baru.

  • false: CodePipeline tidak memulai pipa Anda pada commit baru.

artefak

  • Jumlah artefak: 0

  • Deskripsi: Artefak masukan tidak berlaku untuk jenis tindakan ini.

artefak

  • Jumlah artefak: 1

  • Deskripsi: Artefak yang dihasilkan dari repositori adalah artefak output untukCodeStarSourceConnectiontindakan. ID komit kode sumber ditampilkan dalam CodePipeline sebagai revisi sumber untuk eksekusi pipa dipicu. Anda dapat mengkonfigurasi artefak output dari tindakan ini di:

    • File ZIP yang berisi isi repositori dan cabang yang dikonfigurasi pada komit yang ditentukan sebagai revisi sumber untuk eksekusi pipa.

    • File JSON yang berisi referensi URL ke repositori sehingga tindakan hilir dapat melakukan perintah Git secara langsung.

      penting

      Opsi ini hanya dapat digunakan oleh tindakan hilir CodeBuild.

      Jika Anda memilih opsi ini, Anda perlu memperbarui izin untuk peran layanan proyek CodeBuild Anda seperti yang ditunjukkan diPemecahan masalah CodePipeline. Untuk tutorial yang menunjukkan cara menggunakanKloningpilihan, lihatTutorial: Gunakan klon penuh dengan sumber pipa GitHub.

Variabel output

Ketika dikonfigurasi, tindakan ini menghasilkan variabel yang dapat direferensikan oleh konfigurasi aksi aksi hilir dalam pipa. Tindakan ini menghasilkan variabel yang dapat dilihat sebagai variabel output, bahkan jika tindakan tidak memiliki namespace. Anda mengkonfigurasi tindakan dengan namespace untuk membuat variabel tersebut tersedia untuk konfigurasi tindakan hilir.

Untuk informasi selengkapnya, lihat Variabel.

AuthorDate

Tanggal ketika komit ditulis, dalam format timestamp.

BranchName

Nama cabang untuk repositori tempat perubahan sumber dibuat.

CommitId

ID komit yang memicu eksekusi pipa.

CommitMessage

Pesan deskripsi, jika ada, terkait dengan komit yang memicu eksekusi pipa.

ConnectionARN

Koneksi ARN yang dikonfigurasi dan diautentikasi untuk penyedia sumber.

Nama FullRepositoryName

Nama repositori tempat komit yang memicu pipa dibuat.

Deklarasi tindakan

Pada contoh berikut, artefak output diatur ke format ZIP defaultCODE_ZIPuntuk koneksi dengan ARNarn:aws:codestar-connections:region:account-id:connection/connection-id.

YAML
Name: Source Actions: - InputArtifacts: [] ActionTypeId: Version: '1' Owner: AWS Category: Source Provider: CodeStarSourceConnection OutputArtifacts: - Name: SourceArtifact RunOrder: 1 Configuration: ConnectionArn: "arn:aws:codestar-connections:region:account-id:connection/connection-id" FullRepositoryId: "some-user/my-repo" BranchName: "main" OutputArtifactFormat: "CODE_ZIP" Name: ApplicationSource
JSON
{ "Name": "Source", "Actions": [ { "InputArtifacts": [], "ActionTypeId": { "Version": "1", "Owner": "AWS", "Category": "Source", "Provider": "CodeStarSourceConnection" }, "OutputArtifacts": [ { "Name": "SourceArtifact" } ], "RunOrder": 1, "Configuration": { "ConnectionArn": "arn:aws:codestar-connections:region:account-id:connection/connection-id", "FullRepositoryId": "some-user/my-repo", "BranchName": "main", "OutputArtifactFormat": "CODE_ZIP" }, "Name": "ApplicationSource" } ] },

Menginstal aplikasi instalasi dan membuat koneksi

Saat pertama kali Anda menggunakan konsol untuk menambahkan koneksi baru ke repositori pihak ketiga, Anda harus mengotorisasi akses CodePipeline ke repositori Anda. Anda memilih atau membuat aplikasi instalasi yang membantu Anda terhubung ke akun tempat Anda membuat repositori kode pihak ketiga Anda.

Saat Anda menggunakanAWS CLIatauAWS CloudFormationTemplate, Anda harus menyediakan koneksi ARN dari koneksi yang telah melalui jabat tangan instalasi. Jika tidak, pipa tidak dipicu.

catatan

UntukCodeStarSourceConnectiontindakan sumber, Anda tidak perlu mengatur webhook atau default untuk polling. Tindakan koneksi mengelola deteksi perubahan sumber Anda untuk Anda.

Sumber daya terkait berikut dapat membantu Anda saat bekerja dengan tindakan ini.

  • AWS::CodeStarConnections::Connection— TheAWS CloudFormationreferensi template untukAWSSumber daya CodeStar Connections menyediakan parameter dan contoh untuk koneksi diAWS CloudFormationtemplate.

  • AWSReferensi API CodeStar— TheAWSReferensi API CodeStarmemberikan informasi referensi untuk tindakan koneksi yang tersedia.

  • Untuk melihat langkah-langkah pembuatan pipeline dengan tindakan sumber yang didukung oleh koneksi, lihat yang berikut ini:

    • Untuk Bitbucket, gunakanBitbucketpilihan di konsol atauCodestarSourceConnectiontindakan di CLI. Lihat Koneksi Bitbucket.

    • Untuk GitHub Enterprise Cloud, gunakanGitHubpilihan penyedia di konsol atauCodestarSourceConnectiontindakan di CLI. Lihat Koneksi GitHub.

    • Untuk GitHub Enterprise Server, gunakanGitHub Enterprise Serverpilihan penyedia di konsol atauCodestarSourceConnectiontindakan di CLI. Lihat Koneksi GitHub Enterprise Server.

  • Untuk melihat tutorial Memulai yang membuat pipeline dengan sumber Bitbucket dan tindakan CodeBuild, lihatMemulai dengan koneksi.

  • Untuk tutorial yang menunjukkan cara menghubungkan ke repositori GitHub dan menggunakanKloningpilihan dengan tindakan CodeBuild hilir, lihatTutorial: Gunakan klon penuh dengan sumber pipa GitHub.