Araçları ve Şemaları Sürümleme

Başkaları bağlandıktan sonra araç adlarınıza ve bağımsız değişken biçimlerinize güvenir. Bunları dikkatsizce değiştirmek, tüm istemcileri aynı anda bozar.

Varsayılan değere sahip isteğe bağlı bir parametre eklemek, eski çağıranların çalışmaya devam etmesini sağlar. Göndermedikleri yeni alanı yok sayarlar.

Bir aracı yeniden adlandırmak, bir bağımsız değişkeni kaldırmak veya onu zorunlu hâle getirmek bozucu değişikliktir. Mevcut istemciler artık uymayan çağrılar göndermeye başlar.

Bir alanı geliştirmek için yenisini ekleyin ve eskisini koruyun. Çağıranların geçiş yapması gerektiğini bilmeleri için eskisini açıklamasında kullanımdan kaldırılmış olarak işaretleyin.

Gerçek bir bozucu değişiklik için v1'in yanında bir v2 aracı yayımlayın. Her ikisi bir süre çalışır; istemciler kendi hızlarında geçiş yapabilir.

Sunucunuz el sıkışması sırasında bir ad ve sürüm duyurur. İstemcilerin hangi sürüme bağlandığını görebilmesi için sürümü artırın.

semver kullanın: düzeltmeler için yama sürümünü, eklenen özellikler için ikincil sürümü, bozucu değişiklikler yaptığınızda ise ana sürümü artırın. Sayı, değişikliğin niteliğini anlatır.

Bir sonuca alan eklemek genellikle güvenlidir; alan kaldırmak ise geriye dönük uyumluluğu bozar. output şemanızı istemcilerin ayrıştırdığı bir söz olarak ele alın.

Her tool ve şema değişikliğini bir değişiklik günlüğüne kaydedin. Yükseltme yapan kullanıcılar neyin değiştiğini, neyin yeni olduğunu ve neyin kaldırıldığını görebilmelidir.

Eski bir tool'un ne zaman kaldırılacağını duyurun. Açık bir kullanımdan kaldırma tarihi, kimseyi hazırlıksız yakalamadan geçişi teşvik eder.

Yayınlamadan önce testlerinizi eski bir istemci sizi çağırıyormuş gibi çalıştırın. Bu, tür denetleyicisinin göremeyeceği kazara oluşan uyumsuzlukları yakalar.

Eklemeli değişiklikleri tercih edin, kaldırmadan önce kullanımdan kaldırın, gerçek uyumsuzluklar için v2 yayımlayın, semver kurallarına uyun ve bir değişiklik günlüğü tutun. Güvenle yayımlayabilirsiniz! 🚀