Karşılaştırmalı changelog araçları

Üç kategori

Barındırılan widget ve sayfa

Kayıtları onların editöründe yazarsın, sayfayı onlar barındırır ve sana uygulama içi bir widget verirler. Başlaması en hızlı olanı, ve kayıtlar seninkinde değil onların altyapısında yaşar. Beamer ve AnnounceKit en net örnekler.

Changelog eklenmiş geri bildirim paketi

Changelog, özellik oylaması, herkese açık bir roadmap ve bir geri bildirim kutusunun yanında tek bir modüldür. Tüm döngüyü tek bir tedarikçiden istiyorsan buna değer, sadece release notu yayımlamak istiyorsan gereğinden büyük. Canny, Frill ve Featurebase burada.

Deponundan oluşturulan

Changelog elle yazılmak yerine commit'lerden, pull request'lerden veya issue'lardan üretilir. CI'da oluşturulan bir dosyadan, taslak hazırlanmış, incelenmiş, yayımlanmış bir kayda kadar uzanır. git-cliff ve github-changelog-generator dosya ucundadır; LaunchNotes, Released ve kendi ürünümüz yayımlanmış uçtadır.

Kısaca

Nasıl seçilir

1. Changelog'un nerede görünmesi gerektiğiyle başla. Ürününün bir parçası gibi görünmesi gerekiyorsa, bağlantı verdiğin barındırılan bir sayfa editörü ne kadar iyi olursa olsun seni hayal kırıklığına uğratır ve ya yeniden stilendirebileceğin bir widget ya da renderladığın bir akış istersin. Bağlantılı bir sayfa yeterliyse, barındırılan araçlar çok daha az iş gerektirir.
2. Sonra kayıtları kimin yazdığını sor. Cevap "onu birleştiren mühendis"se, deponu okuyan bir şey seç, çünkü başka her şey herkesin en meşgul olduğu tam anda elle bir adım ekler. Cevap bir release planından çalışan bir ürün pazarlamacısıysa, bir editör daha uygun olur ve depo otomasyonu sadece işe engel olur.
3. Sonra döngünün geri kalanına ihtiyacın olup olmadığını sor. Özellik oylaması ve herkese açık bir roadmap gerçekten kullanışlıdır ve gerçekten daha büyük bir taahhüttür. Changelog modülü için bir paket satın almak, ekiplerin tek bir şey kullanmak için dört şeye ödeme yapmasıyla sonuçlanır.
4. Son olarak, ayrılırsan kayıtlarına ne olacağını kontrol et. Onları yapılandırılmış veri olarak dışa aktaracak bir araç, kazımak zorunda kalacağın barındırılan bir sayfada yaşadıkları bir araçtan önemli ölçüde farklıdır.

Kendi aracımız nereye uyar, nereye uymaz

Changeloop, birleştirilen her pull request'i okur, kullanıcıya görünür bir kayıt hazırlar, bağımlılık güncellemelerini ve refactor'ları filtreler ve taslağı inceleme için tutar. Yayımlanan şey, yanında bir roadmap akışı olan herkese açık bir JSON akışına gider, artı yedek olarak iki satırlık bir widget ve barındırılan bir sayfa. Akış, asıl noktadır: amaçlanan kurulum, changelog'unu kendi ürününün içinde kendi bileşenlerinle renderlamandır.

Şu durumlarda seçme:

• Sürümlerin depolarından gelmiyorsa. Birleştirmelerden veya push modunda push'lardan taslak hazırlar, bu yüzden Git iş akışı dışında gönderim yapan bir ekibin incelenecek hiçbir şeyi olmaz.
• Özellik oylaması ve kullanıcılarının oy verdiği bir roadmap istiyorsan. Bir roadmap akışı var, ama kullanıcı oylamasıyla değil etiketlenmiş issue'larla yürütülür. Bunun için doğru kategori bir geri bildirim paketidir.
• Cilalı bir editör ve ana ürün olarak barındırılan bir sayfa istiyorsan. Barındırılan sayfa bir yedek olarak var ve kendilerininki etrafında inşa edilmiş araçlar bunu daha iyi yapar.
• Depoda sadece bir CHANGELOG.md isteyen tek başına bir açık kaynak projesiysen. Tam olarak bunun için yapılmış ve ücretsiz olan git-cliff'i kullan.

Sık sorulan sorular

Hiç bir araca ihtiyacımız var mı?

Bir süre için, hayır. Bir markdown dosyası veya kendi sitende bir sayfa, gayet iyi bir changelog'dur ve hiçbir şeye mal olmaz. Bir aracın karşılığını vermeye başladığı nokta, kayıtları yazmanın atlanan adım hâline geldiği veya üç kopyayı bakımlamadan aynı kayıtları üç yerde istediğin andır.

Daha sonra bunlardan birinden ayrılabilir miyiz?

Tamamen kayıtların yapılandırılmış veri olarak geri gelip gelmediğine bağlıdır. Başlamadan önce sor, sonra değil: bu, listedeki yanlış yapmanın pahalıya mal olduğu tek sorudur, çünkü changelog büyüyen bir arşivdir ve iki yıllık kısmı yeniden yazmak kimsenin onaylayacağı bir proje değildir.

Peki bunları bir AI asistanıyla yazmaya ne dersin?

Bunların çoğu artık bir yerde bir modelle taslak hazırlıyor. Modele ne verildiğinden çok daha az önemli. Yalnızca bir commit konusunu gören bir araç sadece o konuyu yeniden yazabilir; pull request başlığını ve açıklamasını gören bir araç, değişikliği bir kullanıcı için ne yaptığı açısından tanımlamaya yetecek kadarına sahiptir. AI olup olmadığını değil girdinin ne olduğunu sor.

Daha fazla okuma: changelog otomasyonu ve sınırları, dört adımdan hangisinin otomatik olması gerektiği üzerine.