Konfigurasi dan gunakan code review wajib untuk node - DataWorks - Alibaba Cloud - DataWorks

Di DataWorks, Anda dapat mengaktifkan tinjauan kode wajib di tingkat ruang kerja. Setelah diaktifkan, reviewer harus menyetujui kode node yang diajukan oleh Developer sebelum penerapan. Anda juga dapat menentukan cakupan garis dasar untuk tinjauan kode guna memastikan kualitas kode tugas prioritas tinggi dan mencegah kegagalan penerapan yang dapat menghambat tugas lain. Topik ini menjelaskan cara menggunakan fitur tinjauan kode.

Prasyarat

DataWorks Edisi Profesional atau edisi yang lebih tinggi telah diaktifkan. Untuk perbandingan fitur antar berbagai edisi DataWorks, lihat Edisi DataWorks. Untuk mengaktifkan DataWorks, lihat Penagihan.
Anda memiliki peran Workspace Administrator. Untuk informasi selengkapnya, lihat Pengguna, peran, dan izin.
Anda telah membuat node untuk pengembangan data. Untuk informasi selengkapnya, lihat Pengembangan data di DataStudio (legacy).

Informasi latar belakang

Ketika beberapa task berjalan secara konkuren di DataWorks, task prioritas tinggi mendapatkan prioritas alokasi resource. Kami merekomendasikan agar Anda mewajibkan tinjauan kode untuk task prioritas tinggi guna mencegah kode yang tidak sesuai menyebabkan kegagalan, yang dapat membuang resource dan menghambat task lain. Dengan menambahkan task tersebut ke dalam cakupan tinjauan kode wajib, reviewer dapat memverifikasi kualitas kode dan mencegah error diterapkan ke lingkungan produksi.

Tabel berikut menjelaskan bagaimana pengaktifan tinjauan kode wajib memengaruhi proses commit dan penerapan node.

Status tinjauan kode wajib

Deskripsi

Dampak terhadap operasi

Disabled

Saat Anda melakukan commit node, Anda dapat secara opsional menentukan reviewer untuk memberi tahu mereka tentang perubahan tersebut.

Catatan

Anda dapat menggunakan metode ini untuk memberi tahu anggota ruang kerja mana pun tentang perubahan node, terlepas dari perannya.

Pengaturan ini tidak memengaruhi proses commit dan penerapan node. Anda dapat melakukan commit dan menerapkan node secara normal.

Enabled

Saat Anda melakukan commit node, Anda harus memilih reviewer yang memenuhi syarat untuk melakukan tinjauan kode dan memastikan kualitas kode.

Catatan

Commit penghapusan node tidak memicu tinjauan kode.

Tindakan ini memblokir proses commit dan penerapan node hingga tinjauan kode selesai.

Jika tinjauan lolos, proses commit dan penerapan node dilanjutkan.
Jika tinjauan gagal, Anda tidak dapat melakukan commit atau menerapkan node. Anda harus memperbaiki masalah kode dan mengajukan ulang untuk ditinjau hingga lolos.

Batasan

Fitur tinjauan kode hanya tersedia di DataWorks Edisi Profesional atau edisi yang lebih tinggi.
Hanya pengguna dengan peran Workspace Administrator yang dapat mengaktifkan atau menonaktifkan tinjauan kode untuk suatu ruang kerja.
Tinjauan kode tidak didukung untuk jenis node tertentu, seperti node komposit (misalnya, node for-each dan loop) serta file resource non-Python.

Alur kerja

Tabel berikut menjelaskan alur kerja penggunaan tinjauan kode wajib.

Langkah	Peran	Deskripsi
Aktifkan tinjauan kode wajib dan konfigurasikan pengaturan tinjauan	Workspace Administrator	Workspace Administrator mengaktifkan tinjauan kode wajib dan mengonfigurasi reviewer serta cakupan tinjauan berdasarkan kebutuhan bisnis. Fitur ini hanya berlaku setelah diaktifkan. Catatan Mengaktifkan tinjauan kode wajib akan memblokir proses commit dan penerapan untuk node yang terpengaruh.
Memulai tinjauan kode	Developer	Developer memicu tinjauan kode saat melakukan commit node. Setelah reviewer dipilih, sistem menghasilkan tiket tinjauan kode. Catatan Di ruang kerja dalam mode standar, Developer dapat memulai tinjauan kode secara batch pada halaman Deploy. Untuk informasi selengkapnya, lihat Menerapkan node.
Melihat dan menyetujui tiket tinjauan kode	Pengirim node Reviewer kode	Pengirim node dan reviewer kode dapat melihat serta mengelola tinjauan yang telah dimulai dan yang sedang tertunda dari halaman Tinjauan Kode.

Aktifkan dan konfigurasikan tinjauan kode wajib

Masuk ke Konsol DataWorks. Di wilayah target, klik Data Development and O&M > Data Development di panel navigasi kiri. Pilih ruang kerja dari daftar drop-down dan klik Go to Data Development.
Buka halaman Pengaturan Keamanan dan Lainnya.
1. Di halaman DataStudio, klik ikon di pojok kiri bawah untuk membuka halaman Configure.
2. Klik tab Security Settings and Others pada halaman Configure untuk membuka halaman Security Settings and Others.

Aktifkan dan konfigurasikan tinjauan kode wajib.

Di bagian Code Review, aktifkan Force to review code, lalu konfigurasikan reviewer dan cakupan garis dasar.

Parameter	Deskripsi
Force to review code	Memberlakukan tinjauan kode untuk node dalam cakupan yang ditentukan di ruang kerja saat ini. Open: Kode untuk node di ruang kerja ini memerlukan tinjauan kode wajib sebelum penerapan. Anda harus menentukan reviewer, dan Anda hanya dapat menerapkan kode setelah tinjauan lolos. Tindakan ini memblokir proses commit dan penerapan node. Catatan Anda hanya dapat mengonfigurasi Code reviewers dan Baseline scopes for code review setelah Anda mengaktifkan Force to review code. Close: Anda dapat menerapkan kode untuk node di ruang kerja ini tanpa tinjauan kode. Anda tetap dapat memilih reviewer secara opsional saat melakukan commit node, tetapi ini hanya berfungsi sebagai notifikasi dan tidak memblokir proses penerapan.
Code reviewers	Menetapkan kebijakan pemilihan reviewer saat node diajukan. Any Developer Role: Setelah tinjauan kode dimulai, pengguna mana pun dengan peran Developer di ruang kerja dapat menyetujui perubahan tersebut. Pengguna yang melakukan commit node memilih reviewer spesifik. Specify development role users: Setelah tinjauan kode dimulai, hanya pengguna yang ditentukan dengan peran Developer yang dapat menyetujui perubahan tersebut. DataWorks secara default memilih reviewer yang dikonfigurasi di sini saat Anda melakukan commit node. Catatan Anda hanya dapat memilih pengguna dengan peran Developer di ruang kerja saat ini sebagai reviewer. Jika Anda mengonfigurasi beberapa reviewer, logika persetujuan bergantung pada kebijakan yang Anda pilih.
Baseline scopes for code review	Menentukan node mana yang memerlukan tinjauan kode saat diajukan. Anda dapat memilih node yang memerlukan tinjauan kode wajib berdasarkan prioritas garis dasarnya. Logikanya sebagai berikut: Jika Anda menetapkan cakupan tinjauan ke task non-garis dasar, task baru yang dibuat di ruang kerja memerlukan persetujuan. Jika Anda menetapkan cakupan tinjauan ke task pada tingkat garis dasar tertentu, node pada garis dasar tersebut memerlukan persetujuan saat diajukan. Nomor garis dasar yang lebih tinggi menunjukkan prioritas yang lebih tinggi. Task garis dasar memiliki prioritas lebih tinggi daripada task non-garis dasar. Untuk informasi selengkapnya tentang cara garis dasar mengontrol prioritas task, lihat Ikhtisar Smart Baseline.

Memulai tinjauan kode

Saat melakukan commit node, Developer dapat menentukan satu atau beberapa reviewer. Proses tinjauan kode bervariasi tergantung pada mode ruang kerja, seperti yang ditunjukkan pada tabel berikut.

Catatan

Jika tinjauan baru dimulai untuk node yang sudah memiliki tinjauan sedang berlangsung, DataWorks secara otomatis membatalkan tinjauan sebelumnya.
Commit penghapusan node tidak memicu tinjauan kode.

Workspace mode	Review process	Code review entry points
Standard mode	Jika code review wajib diaktifkan, proses commit dan deployment akan diblokir hingga tinjauan disetujui. Setelah disetujui, node tersebut dikomit, dan Anda dapat melanjutkan ke halaman Deploy untuk menerapkannya.	Initiate a code review for a single node Anda dapat memulai code review melalui kotak dialog commit. Setelah mengkomit node tersebut, Anda dapat mengklik ikon Code Review di toolbar pada halaman edit node. Initiate a code review for multiple nodes in a batch Anda dapat memulai code review melalui kotak dialog commit saat mengkomit sebuah workflow. Buka Deploy > Create Deploy Task untuk memulai code review beberapa node secara batch. Catatan Untuk informasi lebih lanjut tentang cara membuka halaman Create Deploy Task, lihat Deploy nodes.
Simple mode	Jika code review wajib diaktifkan, pilih Only Initiate Code Review saat Anda mengkomit sebuah node. Setelah tinjauan disetujui, Anda harus mengkomit ulang node tersebut untuk menerapkan kodenya ke lingkungan produksi.	Initiate a code review for a single node Anda dapat memulai code review melalui kotak dialog commit. Initiate a code review for multiple nodes in a batch Anda dapat memulai code review melalui kotak dialog commit saat mengkomit sebuah workflow.

Menampilkan dan menyetujui tiket tinjauan kode

Buka halaman Code Review.
Anda dapat membuka halaman Code Review dengan salah satu cara berikut:
- Di pojok kiri atas halaman DataStudio, klik ikon dan pilih All Products > Data Development and O&M > Code Review.
- Di halaman edit node target, klik ikon Code Review di bilah alat.

Tampilkan dan proses tiket tinjauan kode.

Di halaman Code Review, Anda dapat melihat daftar tinjauan yang telah Anda mulai atau yang ditugaskan kepada Anda, lalu memprosesnya sesuai kebutuhan.

Area	Deskripsi
1 (Tab)	Di area ini, Anda dapat melakukan tindakan berikut: Reviewer dapat melihat dan memproses tugas tinjauan yang ditugaskan kepada mereka di tab Review by Me. Pengirim dapat melihat tugas tinjauan yang telah mereka ajukan di tab Submitted by Me.
2	Di area ini, Anda dapat menyaring tiket tinjauan kode berdasarkan kriteria seperti status tinjauan, nama tiket, jenis, pengirim, dan waktu pengajuan.
3	Di area ini, Anda dapat melihat informasi dasar tentang tiket tinjauan kode, seperti versi dan status tinjauannya, atau membuka detailnya untuk memproses tinjauan. Tindakan utama meliputi: Perbandingan versi: Membandingkan perbedaan kode antar versi node untuk memahami perubahan dengan cepat. Tindakan reviewer terhadap tiket: Write a comment: Menambahkan komentar pada versi node. Passed: Tindakan ini memicu pemeriksa tinjauan kode. Setelah pemeriksaan lolos, pengirim dapat menerapkan task dari halaman Deploy. Catatan Untuk informasi selengkapnya tentang cara menerapkan task, lihat Menerapkan node. Not through: Hasilnya bergantung pada apakah tinjauan kode wajib diaktifkan. Jika diaktifkan, hal ini memblokir commit dan penerapan. Jika dinonaktifkan, Anda tetap dapat melakukan commit dan menerapkan node. Abandoned: Membatalkan proses tinjauan saat ini. Setelah proses dibatalkan, Anda dapat melakukan commit dan menerapkan versi node tersebut. Reopen: Jika Anda perlu meninjau ulang proses tinjauan yang dibuang, Anda dapat menggunakan Reopen.