Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Menghubungkan GitHub
GitHub integrasi memungkinkan AWS DevOps Agen untuk mengakses repositori kode dan menerima peristiwa penyebaran selama investigasi insiden. Integrasi ini mengikuti proses dua langkah: pendaftaran tingkat akun GitHub, diikuti dengan menghubungkan repositori tertentu ke Ruang Agen individu.
AWS DevOps Agen mendukung GitHub.com (SaaS), GitHub Enterprise Cloud dengan instans residensi data (*.ghe.com), dan Server GitHub Perusahaan (di-host sendiri).
Prasyarat
Sebelum menghubungkan GitHub, pastikan Anda memiliki:
Akses ke konsol admin AWS DevOps Agen
Akun GitHub pengguna atau organisasi dengan izin admin
Otorisasi untuk menginstal GitHub Aplikasi di akun atau organisasi Anda
Untuk GitHub Enterprise Server, Anda juga membutuhkan:
Instans GitHub Enterprise Server (versi 3.x atau yang lebih baru) dapat diakses melalui HTTPS
URL HTTPS dari instance Server GitHub Perusahaan Anda (misalnya,
https://github.example.com)(Opsional) Koneksi pribadi, jika instans Server GitHub Perusahaan Anda tidak dapat diakses publik
Untuk GitHub Enterprise Cloud dengan residensi data, Anda juga memerlukan:
Organisasi GitHub Enterprise Cloud dengan residensi data diaktifkan, dihosting di subdomain khusus
*.ghe.comAndaIzin admin organisasi, termasuk izin untuk membuat dan menginstal Aplikasi GitHub
URL HTTPS dari contoh residensi data Anda (misalnya,
https://octocorp.ghe.com)
Mendaftar GitHub (tingkat akun)
GitHub terdaftar di tingkat AWS akun dan dibagikan di antara semua Ruang Agen di akun itu. Setiap pendaftaran sesuai dengan satu GitHub pengguna, satu organisasi, atau satu contoh Server GitHub Perusahaan.
Langkah 1: Arahkan ke penyedia pipa
Masuk ke Konsol AWS Manajemen
Arahkan ke konsol AWS DevOps Agen
Buka tab Kemampuan
Di bagian Pipeline, pilih Tambah
Pilih GitHubdari daftar penyedia yang tersedia
Jika GitHub belum terdaftar, Anda akan diminta untuk mendaftarkannya terlebih dahulu.
Langkah 2: Pilih jenis koneksi
Pada layar “Daftarkan GitHub Akun/Organisasi”, pilih apakah Anda terhubung sebagai pengguna atau organisasi:
Pengguna — GitHub Akun pribadi Anda dengan nama pengguna dan profil
Organisasi — GitHub Akun bersama tempat beberapa orang dapat berkolaborasi di banyak proyek sekaligus. Jika Anda memilih Organisasi, masukkan nama GitHub organisasi. Nama harus sama persis dengan nama GitHub organisasi Anda, karena Anda harus mengotorisasi dan menginstal aplikasi di organisasi tersebut dalam langkah-langkah berikut.
Pilih Izin GitHub Aplikasi untuk GitHub Aplikasi Anda. Tingkat izin menentukan tindakan yang dapat dilakukan GitHub Aplikasi di repositori Anda:
Baca & Tulis (default): GitHub Aplikasi meminta izin baca dan tulis. Ini memungkinkan semua fitur. DevOps Agen dapat memposting komentar permintaan tarik sebaris, mengusulkan perbaikan, dan memicu alur kerja.
Hanya Baca: GitHub Aplikasi hanya meminta izin baca. DevOps Agen dapat melihat kode dan permintaan tarik tetapi tidak dapat memposting komentar, mengusulkan perbaikan, atau memicu alur kerja.
Jika Anda terhubung ke instance GitHub Enterprise Server, pilih Use GitHub Enterprise dan masukkan URL HTTPS instance Anda (misalnya,https://github.example.com).
Jika instans Server GitHub Perusahaan Anda tidak dapat diakses publik, Anda dapat mengonfigurasi sambungan pribadi secara opsional agar AWS DevOps Agen dapat menjangkau instans Anda dengan aman. Untuk informasi selengkapnya, lihat Menghubungkan ke alat yang dihosting secara pribadi.
catatan
Jangan sertakan /api/v3 atau trailing path apa pun di URL — masukkan hanya URL dasar.
Untuk GitHub Enterprise Cloud dengan residensi data, pilih Use GitHub Enterprise dan masukkan URL HTTPS dari instance residensi data Anda (misalnya,https://octocorp.ghe.com).
Langkah 3: Siapkan GitHub Aplikasi
Pilih Kirim untuk memulai proses penyiapan aplikasi. Langkah selanjutnya berbeda tergantung pada apakah Anda terhubung ke GitHub.com, GitHub Enterprise Server, atau GitHub Enterprise Cloud dengan residensi data.
Untuk GitHub.com
GitHub mengarahkan Anda untuk masuk dan memberi wewenang AWS DevOps kepada Agen.
Tinjau permintaan otorisasi dan otorisasi Agen AWS DevOps .
Setelah Anda mengotorisasi, AWS DevOps Agen menyelesaikan pendaftaran. Jika GitHub Aplikasi belum diinstal pada akun atau organisasi yang Anda tentukan, Anda melanjutkan ke halaman instalasi (lihat Langkah 4). Jika aplikasi sudah diinstal, pendaftaran selesai tanpa menginstal ulang.
Setelah instalasi, AWS DevOps Agen menerima peristiwa dari repositori Anda yang terhubung, termasuk peristiwa penerapan.
catatan
Anda harus mengotorisasi dan menginstal aplikasi pada Pengguna atau Organisasi yang sama yang Anda tentukan saat pendaftaran. Jika Anda mengotorisasi atau menginstal pada akun atau organisasi lain, pendaftaran gagal dan Anda harus memulai ulang proses, memilih akun atau organisasi yang benar.
catatan
AWS DevOps Agen menggunakan GitHub Aplikasi terpisah untuk setiap tingkat izin (Baca & Tulis dan Hanya Baca), dan setiap aplikasi diotorisasi secara independen. GitHub mengingat otorisasi sampai Anda mencabutnya di Settings > Applications > Authorized Apps. GitHub Jika sebelumnya Anda mengotorisasi aplikasi pada tingkat izin ini, GitHub mungkin melewati layar otorisasi. Jika Anda mengubah tingkat izin, GitHub meminta Anda untuk mengotorisasi aplikasi yang sesuai untuk pertama kalinya.
Untuk GitHub Enterprise Server dan GitHub Enterprise Cloud dengan residensi data
GitHub Enterprise Server dan GitHub Enterprise Cloud dengan residensi data keduanya menggunakan alur Manifes GitHub Aplikasi, yang secara otomatis menyiapkan GitHub Aplikasi baru di instans Anda. Selama penyiapan, browser Anda dialihkan dua kali: sekali ke instans Anda dan sekali kembali ke AWS DevOps Agen.
AWS DevOps Agen mengalihkan browser Anda ke halaman Buat GitHub Aplikasi instans GitHub Enterprise Anda.
Nama aplikasi sudah diisi sebelumnya. Ubah nama jika diperlukan, lalu pilih Buat GitHub Aplikasi.
Setelah AWS DevOps Agen mengarahkan kembali browser Anda, agen akan menukar kode manifes dengan kredensi aplikasi.
Langkah 4: Pilih repositori dan selesaikan instalasi
Lewati langkah ini jika GitHub Aplikasi sudah diinstal di akun atau organisasi Anda.
Halaman Instal & Otorisasi untuk GitHub Aplikasi muncul.
Pilih repositori mana yang memungkinkan aplikasi mengakses:
Semua repositori - Berikan akses ke semua repositori saat ini dan masa depan
Hanya pilih repositori - Pilih repositori tertentu dari akun atau organisasi Anda
Pilih Instal & Otorisasi.
Anda akan diarahkan kembali ke konsol AWS DevOps Agen, di mana GitHub akan muncul sebagai terdaftar di tingkat akun.
Menghubungkan repositori ke Ruang Agen
Setelah mendaftar GitHub di tingkat akun, Anda dapat menghubungkan repositori tertentu ke Ruang Agen individual:
Di konsol AWS DevOps Agen, pilih Ruang Agen
Buka tab Kemampuan
Di bagian Pipeline, pilih Tambah
Pilih GitHubdari daftar penyedia yang tersedia
Pilih GitHub registrasi yang berisi repositori yang ingin Anda gunakan
Pilih subset repositori yang relevan dengan Ruang Agen ini
Pilih Tambah untuk menyelesaikan koneksi
Anda dapat menghubungkan kumpulan repositori yang berbeda ke Ruang Agen yang berbeda berdasarkan kebutuhan organisasi Anda. Satu Ruang Agen dapat menggunakan repositori dari beberapa pendaftaran. Untuk menambahkan repositori dari pendaftaran lain, ulangi langkah-langkah ini.
Mengkonfigurasi Tinjauan Kode dan Pengujian Otomatis
Ketika Anda memilih repositori di langkah GitHub koneksi, mereka secara otomatis ditambahkan ke bagian Tinjauan Kode dan Pengujian Otomatis. Bagian ini mengonfigurasi repositori mana yang secara otomatis memicu kemampuan pengujian Rilis ulasan kode kesiapan dan otomatis.
Konfigurasi Tinjauan Kode dan Pengujian Otomatis meliputi:
Kemampuan — Pilih peninjauan kode dan kemampuan pengujian otomatis untuk setiap repositori. Bagian ini menyediakan dua pengaturan per-repositori:
Tinjauan perubahan pemicu otomatis - Ketika diaktifkan untuk repositori, DevOps Agen secara otomatis menjalankan Rilis ulasan kode kesiapan setiap kali permintaan tarik dibuka atau diperbarui. Temuan tinjauan muncul sebagai komentar sebaris pada permintaan tarik. Ini diaktifkan secara default untuk semua repositori yang terhubung.
Pengujian verifikasi otomatis — Saat diaktifkan untuk repositori, DevOps Agen membangun, menjalankan, dan menguji perubahan kode Anda di lingkungan verifikasi terkelola selama peninjauan kode. Ini memberikan validasi fungsional di luar analisis statis. Untuk informasi selengkapnya, lihat Pengujian verifikasi otomatis. Ini diaktifkan secara default untuk semua repositori yang terhubung.
Daftar repositori - Menampilkan semua repositori yang Anda pilih selama langkah koneksi. Gunakan bidang pencarian untuk memfilter repositori berdasarkan nama. Setiap repositori memiliki kotak centang independen untuk kedua kemampuan.
Peran runtime (opsional) - Pilih peran IAM yang diasumsikan DevOps Agen untuk menjalankan kemampuan otomatis pada repositori yang Anda pilih. Peran ini digunakan saat mengakses layanan internal yang diperlukan selama pembuatan, seperti registrasi paket pribadi dan sistem penyimpanan artefak. Sebaiknya gunakan peran yang berbeda dari peran agen utama Anda.
Untuk mengonfigurasi ulasan otomatis:
Setelah menghubungkan repositori Anda, navigasikan ke bagian Tinjauan Kode dan Pengujian Otomatis di pengaturan GitHub integrasi Anda.
Untuk setiap repositori, aktifkan atau nonaktifkan kemampuan tinjauan perubahan pemicu otomatis tergantung pada apakah Anda ingin tinjauan permintaan tarik otomatis.
Untuk setiap repositori, aktifkan atau nonaktifkan kemampuan pengujian verifikasi otomatis tergantung pada apakah Anda ingin pengujian verifikasi otomatis di lingkungan verifikasi terkelola.
Secara opsional, pilih peran IAM dari dropdown peran Runtime yang akan diambil DevOps Agen saat menjalankan kemampuan otomatis pada repositori yang Anda pilih.
Pilih Simpan untuk menerapkan konfigurasi Anda.
Setelah dikonfigurasi, permintaan tarik baru apa pun di repositori dengan tinjauan perubahan pemicu otomatis diaktifkan akan secara otomatis memicu tinjauan kode kesiapan rilis. Jika pengujian verifikasi otomatis juga diaktifkan, tinjauan mencakup validasi fungsional dalam lingkungan verifikasi. Untuk informasi selengkapnya tentang ulasan kode, lihatRilis ulasan kode kesiapan.
Memahami GitHub Aplikasi
GitHub Aplikasi AWS DevOps Agen:
Meminta akses ke repositori Anda — Anda dapat meninjau izin tertentu selama instalasi Aplikasi GitHub
Menerima peristiwa penyebaran dan acara repositori lainnya
Memungkinkan AWS DevOps Agen untuk mengkorelasikan perubahan kode dengan insiden operasional
Dapat di-uninstall kapan saja melalui pengaturan Anda GitHub
Untuk GitHub Enterprise Server dan GitHub Enterprise Cloud dengan residensi data, AWS DevOps Agen secara otomatis membuat GitHub Aplikasi pada instans Anda saat pendaftaran. Anda dapat mengelola akses repositori aplikasi atau menghapus instalannya melalui Pengaturan> Aplikasi > Aplikasi Terinstal. GitHub Untuk menghapus definisi aplikasi sepenuhnya, buka Pengaturan > Pengaturan pengembang > GitHub Aplikasi.
GitHub Pembaruan izin aplikasi
AWS DevOps Agen dapat meminta pembaruan izin setelah Anda menginstal GitHub Aplikasi untuk mendukung fitur baru. Ketika ini terjadi:
Anda akan menerima pemberitahuan dari GitHub mengenai permintaan pembaruan izin.
Tinjau detail pembaruan untuk memahami izin baru apa yang diminta.
Pilih Terima izin baru untuk memberikan izin yang diperbarui.
Tidak ada perubahan yang diperlukan dalam layanan atau aplikasi Anda. Setelah Anda menerima izin yang diperbarui, token akses instalasi berikutnya yang diminta AWS DevOps Agen GitHub akan secara otomatis menyertakan izin baru.
catatan
Sampai Anda menerima pembaruan izin, AWS DevOps Agen terus beroperasi dengan izin yang diberikan sebelumnya. Kemampuan baru yang bergantung pada izin yang diperbarui tidak akan tersedia sampai Anda menyetujui permintaan tersebut. Aplikasi akan mempertahankan izinnya saat ini jika Anda memilih untuk tidak menerima izin baru.
Izin yang diminta
Tabel berikut menjelaskan setiap izin yang diminta oleh GitHub Aplikasi AWS DevOps Agen dan mengapa diperlukan.
Jika Anda memilih Hanya Baca saat pendaftaran, GitHub Aplikasi hanya meminta akses tingkat baca untuk setiap izin di tabel berikut. Dengan izin Baca Saja, GitHub Aplikasi tidak dapat melakukan tindakan tingkat tulis yang tercantum di kolom Tujuan.
| Izin | Tingkat akses | Tujuan |
|---|---|---|
| Cek | Membaca dan menulis | Hasil tinjauan kode kesiapan posting rilis saat pemeriksaan berjalan pada permintaan tarik, memungkinkan status peninjauan muncul langsung di GitHub UI. |
| Alur kerja | Membaca dan menulis | Baca definisi alur kerja dan picu alur kerja GitHub Tindakan untuk pengujian rilis di pipeline Anda CI/CD . |
| Tindakan | Membaca dan menulis | Alur kerja Monitor GitHub Actions berjalan dan mengakses log run selama investigasi insiden dan pengujian rilis. |
| Daftar Isi | Membaca dan menulis | Baca kode sumber repositori untuk analisis tinjauan kode dan pemetaan ketergantungan. Akses tulis memungkinkan agen untuk mengusulkan perbaikan untuk masalah yang diidentifikasi. |
| Permintaan pull | Membaca dan menulis | Baca detail permintaan tarik untuk memicu tinjauan kode otomatis. Akses tulis memungkinkan memposting komentar ulasan sebaris dengan temuan dan perbaikan yang direkomendasikan. |
| Administrasi organisasi | Baca | Baca daftar aplikasi yang diinstal di organisasi target untuk memverifikasi bahwa GitHub Aplikasi AWS DevOps Agen diinstal. |
Mengelola GitHub koneksi
Memperbarui akses repositori — Untuk mengubah repositori mana yang dapat diakses GitHub Aplikasi, buka pengaturan GitHub akun atau organisasi Anda. Untuk GitHub Enterprise Server atau GitHub Enterprise Cloud dengan residensi data, buka pengaturan instans Anda. Kemudian navigasikan ke GitHub Aplikasi yang diinstal dan ubah konfigurasi aplikasi AWS DevOps Agen.
Melihat repositori yang terhubung - Di konsol AWS DevOps Agen, pilih Ruang Agen Anda dan buka tab Kemampuan untuk melihat repositori yang terhubung di bagian Pipeline.
Menghapus GitHub koneksi - Untuk memutuskan sambungan GitHub dari Ruang Agen, pilih koneksi di bagian Pipeline, lalu pilih Hapus. Untuk menghapus GitHub pendaftaran dari akun Anda, buka halaman Penyedia Kemampuan, cari pendaftaran Anda di GitHubbagian tersebut, dan pilih Deregister.
Untuk menghapus GitHub integrasi sepenuhnya, lakukan hal berikut:
Untuk mencopot pemasangan GitHub Aplikasi, buka pengaturan GitHub akun atau organisasi Anda.
Untuk menyambung kembali, daftar ulang GitHub di konsol AWS DevOps Agen.
Untuk GitHub Enterprise Server dan GitHub Enterprise Cloud dengan residensi data, AWS DevOps Agen membuat GitHub Aplikasi pada instans Anda saat pendaftaran. Untuk membersihkan aplikasi sepenuhnya, lakukan kedua hal berikut:
Copot pemasangan aplikasi — Buka Pengaturan> Aplikasi > GitHub Aplikasi Terinstal, pilih Konfigurasi di aplikasi, lalu hapus instalannya.
Hapus aplikasi — Buka Pengaturan > Pengaturan pengembang > GitHub Aplikasi, pilih aplikasi, buka tab Lanjutan, dan pilih Hapus GitHub Aplikasi. Peringatan: Menghapus GitHub Aplikasi bersifat permanen dan tidak dapat dibatalkan. Untuk membuat aplikasi baru, daftar ulang GitHub di konsol AWS DevOps Agen.
