Pembuatan Versi Alat dan Skema

Setelah pihak lain terhubung, mereka bergantung pada nama tool dan bentuk argumen Anda. Mengubahnya sembarangan akan merusak semua klien sekaligus.

Menambahkan parameter opsional dengan nilai bawaan membuat pemanggil lama tetap berfungsi. Mereka cukup mengabaikan kolom baru yang tidak dikirimkan.

Mengganti nama tool, menghapus argumen, atau menjadikan salah satunya wajib merupakan perubahan yang merusak. Klien yang sudah ada tiba-tiba mengirim panggilan yang tidak lagi sesuai.

Untuk mengembangkan sebuah bidang, tambahkan bidang baru dan pertahankan yang lama. Tandai yang lama sebagai deprecated dalam deskripsinya agar pemanggil tahu bahwa mereka perlu bermigrasi.

Untuk perubahan yang benar-benar merusak, sediakan tool v2 di samping v1. Keduanya berjalan untuk sementara waktu sehingga klien dapat berpindah sesuai kecepatannya sendiri.

Server Anda mengumumkan nama dan versi selama jabat tangan. Naikkan versinya agar klien dapat melihat rilis mana yang mereka hubungkan.

Gunakan semver: naikkan patch untuk perbaikan, minor untuk fitur tambahan, dan major saat Anda membuat perubahan yang merusak. Angkanya menceritakan riwayat perubahan.

Menambahkan bidang ke hasil biasanya aman; menghapusnya merupakan perubahan yang merusak. Perlakukan skema output Anda sebagai janji yang akan diurai oleh klien.

Catat setiap perubahan pada tool dan skema dalam changelog. Pengguna yang melakukan peningkatan perlu melihat apa yang dipindahkan, apa yang baru, dan apa yang dihapus.

Umumkan kapan tool lama akan dihapus. Tanggal sunset yang jelas mendorong migrasi tanpa tiba-tiba mencabut dukungan dari siapa pun.

Sebelum rilis, jalankan tests Anda seperti klien lama memanggilnya. Cara ini menangkap perubahan yang tidak sengaja merusak dan tidak dapat dilihat oleh pemeriksa tipe.

Utamakan perubahan additive, tandai sebagai usang sebelum menghapus, sediakan v2 untuk perubahan yang benar-benar merusak, ikuti semver, dan pelihara changelog. Anda dapat merilis dengan percaya diri! 🚀