Meninjau dan mengirimkan permintaan pull
Permintaan pull (PR) adalah tiket Anda untuk mendapatkan pengetahuan Anda ke platform Learn. Anda telah membuat PR, tetapi belum dikirimkan ke antrean PR repositori tujuan. Seperti banyak proyek sumber terbuka, ada serangkaian pemeriksaan dan tinjauan yang terjadi untuk memvalidasi perubahan sebelum penerbitan.
Anatomi PR
PR menunjukkan pengguna GitHub yang membuat PR, repositori tujuan, dan cabang tempat PR dibuat. PR berisi beberapa tab di bagian atas, termasuk:
- Tab Percakapan : Dasbor tempat Anda dapat melihat dan membalas komentar dari kolaborator lain, melihat daftar pemberitahuan di seluruh proses build dan ulasan, dan menggunakan otomatisasi komentar untuk melakukan tindakan.
- Tab Penerapan : Catatan perubahan yang telah dibuat pada cabang tersebut.
- Tab file yang diubah : Perbandingan file yang diubah di PR dengan status sebelumnya.
Perhatikan dengan cermat tab Percakapan, di mana pembaruan atau pemberitahuan muncul dan diskusi apa pun antara Anda, peninjau, dan kolaborator lainnya terjadi. Anda juga dapat menambahkan komentar hashtag di sini untuk melakukan tindakan, seperti menandatangani PR untuk menunjukkan siap untuk divalidasi dan digabungkan, atau menunda jika Anda perlu menjeda proses.
PR sering memiliki label yang dilampirkan untuk menunjukkan statusnya, seperti draft
untuk menentukan DRAF PR yang belum siap untuk ditinjau, atau do-not-merge
untuk PR yang baru atau tidak ditinjau.
Validasi
Sebelum PR Anda dapat digabungkan ke cabang tujuannya, mungkin diperlukan untuk melewati satu atau beberapa proses validasi PR. Setelah Anda memilih Buat permintaan pull, GitHub menjalankan validasi yang dikonfigurasi untuk repositori Anda. Ketika proses validasi selesai, hasilnya muncul di PR.
Proses validasi bervariasi tergantung pada cakupan perubahan yang diusulkan dan aturan repositori tujuan. Setelah mengirimkan PR, Anda dapat mengharapkan satu atau beberapa hal berikut ini terjadi:
- Mergeability: Pengujian mergeabilitas GitHub garis besar terjadi terlebih dahulu untuk memverifikasi apakah perubahan yang diusulkan di cabang Anda bertentangan dengan cabang tujuan. Jika PR menunjukkan bahwa pengujian ini gagal, Anda harus mendamaikan konten yang menyebabkan konflik penggabungan sebelum pemrosesan dapat dilanjutkan.
- Perjanjian Lisensi Kontribusi (CLA): Jika Anda berkontribusi pada repositori publik dan bukan karyawan Microsoft, tergantung pada besarnya perubahan yang diusulkan, Anda mungkin diminta untuk menyelesaikan CLA singkat saat pertama kali mengirimkan PR ke repositori tersebut. Setelah langkah CLA dibersihkan, PR Anda akan diproses.
- Pelabelan: Label secara otomatis diterapkan ke PR Anda untuk menunjukkan status PR Anda saat melewati alur kerja validasi. Misalnya, PR baru mungkin secara otomatis menerima label "jangan-gabungkan", yang menunjukkan bahwa PR belum menyelesaikan langkah-langkah validasi, tinjau, dan sign-off.
- Validasi dan build: Pemeriksaan otomatis memverifikasi apakah perubahan Anda lulus pengujian validasi. Pengujian validasi mungkin menghasilkan peringatan atau kesalahan, mengharuskan Anda membuat perubahan pada satu atau beberapa file di PR Anda sebelum dapat digabungkan. Hasil pengujian validasi ditambahkan sebagai komentar di PR Anda untuk ditinjau, dan hasilnya mungkin juga dikirimkan kepada Anda melalui email.
- Penahapan: Halaman artikel yang terpengaruh oleh perubahan Anda secara otomatis disebarkan ke lingkungan penahapan untuk ditinjau setelah validasi dan build berhasil. URL pratinjau muncul dalam komentar PR.
- Penggabungan otomatis: PR mungkin digabungkan secara otomatis jika lulus pengujian validasi dan kriteria tertentu. Dalam hal ini, Anda tidak perlu melakukan hal lain.
Meninjau dan menandatangani
Anda hampir sampai! Setelah semua pemrosesan PR selesai, praktik terbaik adalah meninjau hasilnya (misalnya, komentar PR, URL pratinjau) untuk menentukan apakah diperlukan lebih banyak perubahan sebelum Anda keluar untuk penggabungan. Jika peninjau PR telah meninjau PR Anda, mereka juga dapat memberikan umpan balik melalui komentar jika ada masalah atau pertanyaan yang luar biasa yang mencegah penggabungan.
Gunakan otomatisasi komentar untuk melakukan tindakan penting di PR. Otomatisasi komentar memungkinkan pengguna menetapkan label yang sesuai ke PR mereka untuk memperbarui statusnya atau mengategorikannya. Jika Anda bekerja di repositori tempat otomatisasi komentar telah diterapkan, gunakan komentar hashtag untuk menetapkan atau mengubah label, menutup PR, atau menjeda penggabungan. Misalnya, ketika Anda selesai membuat perubahan, Anda mengetik komentar "#sign-off" untuk mengubah label PR Anda dari do-not-merge
ke ready-for-review.
Gunakan komentar dalam tabel berikut untuk melakukan tindakan utama di PR Anda:
Komentar hashtag | Apa fungsinya |
---|---|
#sign-off |
Secara otomatis menetapkan label siap-untuk-gabung untuk memberi tahu peninjau dalam repositori bahwa PR siap untuk ditinjau/digabungkan. Jika Anda bukan penulis yang terdaftar dan mencoba menandatangani PR repositori publik menggunakan #sign-off komentar, PR diperbarui untuk menunjukkan bahwa hanya penulis yang dapat menetapkan label. |
#hold-off |
Menghapus label siap-untuk-gabung jika Anda berubah pikiran atau membuat kesalahan. |
#please-close |
Menutup PR jika Anda memutuskan untuk tidak menggabungkan perubahan. |
#please-open |
Membuka kembali PR atau masalah tertutup. |
Anda harus memasukkan komentar #sign-off untuk menggabungkan perubahan Anda. Bahkan jika semua ulasan dan pemeriksaan validasi lolos, Anda bertanggung jawab untuk menggunakan komentar ini untuk memberi tahu peninjau PR dan administrator repositori bahwa perubahan Anda siap untuk digabungkan dari sisi hal Anda. Ketika peninjau menentukan bahwa PR Anda bebas masalah dan ditandatangani, perubahan Anda digabungkan kembali ke cabang induk, dan PR ditutup.
Memublikasikan
Ingat, PR Anda harus digabungkan oleh peninjau PR sebelum perubahan dapat disertakan dalam eksekusi penerbitan terjadwal berikutnya. Biasanya, PR ditinjau dan digabungkan dalam urutan pengiriman.
Setelah kontribusi Anda disetujui dan digabungkan, proses penerbitan akan mengambilnya. Bergantung pada tim yang mengelola repositori yang Anda kontribusikan, waktu penerbitan dapat bervariasi, tetapi biasanya terjadi setidaknya sekali setiap hari kerja. Dibutuhkan waktu hingga 45 menit agar artikel muncul secara online setelah penerbitan.
Setelah perubahan Anda diterbitkan, perubahan tersebut akan ditayangkan di Microsoft Learn bagi orang lain untuk mulai belajar dari!
Skenario: Menerbitkan perubahan pada Azure App Service
Dengan menggunakan pengalaman sebelumnya, Anda menemukan kesempatan untuk menambahkan beberapa informasi bermanfaat ke halaman dokumentasi App Service dan membuat PR untuk menambahkan perubahan Anda. Anda sekarang siap untuk meninjau dan menandatangani PR Anda untuk menerbitkan pengeditan Anda.