Code Review meningkatkan kualitas kode untuk tugas produksi melalui proses tinjauan manual, memastikan bahwa kode yang dipublikasikan ke Production Environment memenuhi standar kualitas. Anda dapat mengaktifkan Mandatory Code Review untuk mewajibkan tugas melewati tinjauan sebelum dipublikasikan.
Cara kerja
Di DataWorks, Anda dapat mengaktifkan Mandatory Code Review untuk mencegah kegagalan tugas akibat kode yang tidak sesuai dan menghindari pemborosan sumber daya komputasi. Saat fitur ini diaktifkan, peninjau harus meninjau dan menyetujui kode sebelum kode tersebut dapat dipublikasikan.
Jika Mandatory Code Review dinonaktifkan: Anda tetap dapat secara manual mengirimkan node untuk ditinjau. Node tersebut dapat dipublikasikan terlepas dari hasil tinjauan.
Jika Mandatory Code Review diaktifkan: Saat Anda mengirimkan node, Anda harus memilih peninjau yang memenuhi syarat untuk meninjau kode tersebut.
Jika tinjauan disetujui, Anda dapat mempublikasikan node tersebut.
Jika tinjauan ditolak, Anda harus memodifikasi kode berdasarkan masukan dan mengirimkannya kembali untuk ditinjau. Anda hanya dapat mempublikasikan node tersebut setelah disetujui.
Batasan
Untuk menggunakan Code Review, Anda harus telah mengaktifkan DataWorks Edisi Profesional atau edisi yang lebih tinggi. Untuk informasi selengkapnya tentang edisi, lihat edisi DataWorks.
Hanya Alibaba Cloud Account, Workspace Administrator, atau RAM User dengan izin AliyunDataWorksFullAccess yang dapat mengaktifkan atau menonaktifkan Code Review untuk suatu ruang kerja. Untuk informasi selengkapnya, lihat Ikhtisar pengguna, peran, dan izin.
Code Review tidak didukung untuk jenis node tertentu, seperti node komposit (misalnya Loop dan Traverse) atau file resource non-Python.
(Opsional) Aktifkan mandatory code review
Workspace Administrator dapat mengaktifkan Mandatory Code Review untuk suatu ruang kerja pada halaman pengaturan Data Studio.
Jika Mandatory Code Review dinonaktifkan, Anda tetap dapat mengirimkan tugas untuk ditinjau, tetapi hasilnya tidak menghalangi proses penerbitan.
Operasi delete node tidak memicu Code Review.
Buka Pengaturan Keamanan dan Lainnya
Buka halaman Workspaces di Konsol DataWorks. Di bilah navigasi atas, pilih Wilayah yang diinginkan. Temukan ruang kerja yang diinginkan dan pilih di kolom Actions.
Aktifkan tinjauan kode
Pada tab Security Settings and Others, aktifkan .
Jika Anda tidak menemukan sakelar Force to review code pada tab Security Settings and Others, periksa edisi DataWorks Anda. Code Review hanya tersedia di DataWorks Edisi Profesional dan yang lebih tinggi.
Parameter | Deskripsi |
Force to review code | Menentukan apakah tinjauan kode diperlukan sebelum tugas di ruang kerja dapat dipublikasikan ke Production Environment. |
Code reviewers | Menentukan pengguna yang dapat meninjau kode.
Catatan
|
Baseline scopes for code review | Mengonfigurasi node mana yang memerlukan tinjauan kode saat diajukan. Anda dapat menentukan node mana yang memerlukan Mandatory Code Review berdasarkan prioritas baseline tempat node tersebut berada. Logikanya sebagai berikut:
Catatan Memilih tugas non-baseline berarti semua node baru di ruang kerja memerlukan persetujuan. |
Code review notification methods | Setelah Anda mengaktifkan Mandatory Code Review, Anda dapat mengonfigurasi notifikasi untuk secara otomatis memberi tahu pihak terkait:
Metode notifikasi berikut didukung: SMS, DingTalk group robot webhook, email, WeCom group webhook, Lark webhook, dan generic webhook. Notifikasi SMS dan panggilan telepon yang dihasilkan oleh Code Review dihitung dalam penggunaan sumber daya alert Anda. Anda dapat melihat penggunaan sumber daya alert untuk modul Code Review pada halaman Alert Resources di konsol manajemen. Untuk informasi selengkapnya, lihat Lihat dan atur sumber daya alert. Catatan
|
Untuk inisiator: Ajukan untuk tinjauan kode
Mengirimkan node akan memicu Code Review. Setelah Anda memilih satu atau beberapa peninjau, permintaan tinjauan akan dibuat. Jika Mandatory Code Review diaktifkan, penerbitan akan diblokir hingga tinjauan disetujui.
Jika tinjauan kode sedang berlangsung untuk suatu node, mengajukan tinjauan baru secara otomatis membatalkan tinjauan sebelumnya.
Operasi delete node tidak memicu Code Review.
Publikasikan tugas.
Klik ikon
untuk menyimpan node Data Studio yang ingin Anda publikasikan, lalu klik ikon
untuk membuka halaman Publish.Klik Start Deployment to Production Environment untuk mempublikasikan. Karena Mandatory Code Review diaktifkan, penerbitan akan diblokir hingga tinjauan kode disetujui.
Ajukan untuk tinjauan kode.
Klik Submit for Code Review. Pada halaman konfigurasi Code Review, konfigurasikan Code Reviewer dan Change Description.
Parameter
Deskripsi
Code Reviewer
Pilih satu atau beberapa peninjau dari daftar pengguna yang dikonfigurasi sebagai Code reviewers.
Change Description
Jelaskan perubahan kode.
Setelah mengonfigurasi tinjauan, klik Confirm untuk mengajukannya.
Untuk peninjau: Proses permintaan tinjauan
Peninjau dapat melihat dan memproses permintaan tinjauan yang tertunda pada tab .
Buka halaman Tinjauan Kode.
Di panel navigasi kiri halaman Data Studio, klik ikon
untuk membuka halaman Code Review List. Permintaan tinjauan yang ditugaskan kepada Anda muncul di bawah Reviewed by Me.Proses permintaan tinjauan.
Pada halaman , Anda dapat melihat detail tinjauan kode dan melakukan aksi terhadap permintaan tinjauan tersebut.
Di halaman daftar Code Review: Anda dapat langsung mengambil tindakan terhadap permintaan tinjauan, seperti Approve, Reject, Discard, Reopen, dan Share.
Di halaman detail Code Review:
Di halaman Code Review List, klik permintaan tinjauan untuk membuka halaman Code Review details. Di halaman detail, Anda dapat membandingkan perubahan kode dan konfigurasi penjadwalan terhadap versi produksi. Gunakan perbandingan ini untuk memutuskan apakah akan menyetujui tinjauan tersebut.
Di bagian Review Operations, peninjau dapat melakukan Review Operations berikut terhadap Permintaan Tinjauan:
: Approve.
: Reject.
: Discard.
: Reopen.Comment.
CatatanDiscard: Membatalkan proses tinjauan saat ini. Setelah tinjauan dibuang, proses penerbitan tetap diblokir hingga inisiator mengajukan tinjauan baru atau membuka kembali tinjauan ini.
Reopen: Jika Anda perlu meninjau kembali proses tinjauan yang telah dibuang, klik Reopen.
Setelah tinjauan kode selesai, inisiator dapat melihat detail tinjauan dan mengelola permintaan tinjauan di halaman Code Review List.
Untuk inisiator: Lihat hasil tinjauan
Inisiator dapat melihat hasil tinjauan dan mengelola permintaan tinjauan pada tab .
Buka halaman Tinjauan Kode.
Di panel navigasi kiri halaman Data Studio, klik ikon
untuk membuka halaman Tinjauan Kode. Anda kemudian dapat melihat permintaan tinjauan di bawah Created by Me.Konfirmasi hasil tinjauan.
Di halaman , Anda dapat melihat detail tinjauan kode dan mengelola permintaan tersebut.
Di halaman daftar Code Review: Inisiator dapat langsung melihat hasil permintaan tinjauan dan melakukan aksi seperti Discard, Reopen, atau Share.
CatatanJika Anda membuang tinjauan tersebut, Anda harus mengajukan permintaan baru atau membuka kembali tinjauan yang dibuang untuk melanjutkan proses penerbitan.
Di halaman detail Code Review: Di halaman Code Review List, klik permintaan tinjauan untuk membuka halaman Code Review details. Anda kemudian dapat memutuskan apakah akan Reopen atau Discard tinjauan kode tersebut.
Jika tinjauan ditolak, Anda tidak dapat mempublikasikan node tersebut. Anda harus memodifikasi kode sesuai masukan tinjauan dan mengajukannya kembali untuk ditinjau. Anda hanya dapat mempublikasikan node tersebut setelah tinjauan disetujui.
Langkah selanjutnya
Setelah tinjauan kode disetujui, Anda dapat melanjutkan proses penerbitan. Jika ditolak, modifikasi kode berdasarkan komentar tinjauan dan ajukan kembali untuk tinjauan kode.