Changelog oluşturucu

Henüz bir şey yok. Yukarıya birkaç satır yapıştır ve Oluştur'a bas.

Her satırla ne yapar

Kurallar kasıtlı olarak basit ve görünürdür, böylece çıktıyı tahmin etmek yerine öngörebilirsin:

1. Conventional commit'ler türe göre gruplanır. `feat`, Yeni olur, `fix`, Düzeltildi olur, `perf`, İyileştirildi olur. İki noktadan önceki bir `!` veya bir BREAKING CHANGE işareti, türünden bağımsız olarak satırı Kırıcı değişikliklere taşır.
2. Conventional commit olmayan her şey ilk kelimesine göre sıralanır. Add, Added, Introduce ve Support Yeni olur; Fix, Fixed ve Resolve Düzeltildi olur; Improve, Update, Speed ve Optimise İyileştirildi olur; Remove, Removed, Drop ve Deprecate Kaldırıldı olur. Geri kalan her şey elle sıralaman için Diğer'e düşer.
3. Gürültü ayıklanır: sondaki bir pull request numarası, bir `Merge pull request ...` satırı, parantez içindeki bir kapsam ve conventional tür önekinin kendisi. Kalan cümle büyük harfle başlatılır.
4. Filtre açıkken `chore`, `ci`, `test`, `build`, `style` ve `refactor` satırları, bir bağımlılık güncellemesine benzeyen her şeyle birlikte atılır. Bu, insanların okuduğu bir changelog ile okumayı bıraktığı bir changelog arasındaki tek en büyük farktır.

Yapamadığı şey

Commit mesajlarının içeriğini değil şeklini yeniden yazar. Bir commit `fix: race in MembershipCache.resolve()` diyorsa çıkan şey de budur ve hâlâ kullanıcının deneyimi hakkında değil kodun hakkında bir cümledir. "MembershipCache'de yarış durumu"nu "davet edilen üyeler artık boş bir kontrol paneli görmüyor"a çevirmek, değişikliğin ne yaptığını bilmeyi gerektirir, ki bu bir oluşturucunun bir commit konu satırından çıkaramayacağı kısımdır.

Bu yüzden çıktıyı bir ilk geçiş olarak ele al: doğru yapı, doğru gruplama, dahili gürültü zaten gitmiş, ifade tarzı hâlâ senin düzeltmen gereken.

Sık sorulan sorular

Yapıştırdığım herhangi bir şey yükleniyor mu?

Hayır. Oluşturucu bu sayfadaki bir betiktir; metin tarayıcından asla çıkmaz ve Oluştur'a bastığında bize bir istek gitmez. Bunu ağ sekmesi açıkken doğrulayabilirsin.

Conventional commit kullanmam gerekiyor mu?

Hayır. Kuralı takip eden satırlar daha doğru gruplanır ve geri kalan her şey baştaki fiile geri döner. Sıradan cümle commit mesajları olan bir depo yine de kullanılabilir bir taslak üretir.

Bunu deposundan otomatik olarak nasıl alırım?

Tek seferlik bir şey için `git log --pretty=format:%s v1.2.0..HEAD`, tam olarak bunun beklediği girdiyi verir. Devam eden bir şey için git-cliff ve github-changelog-generator, CI'da commit geçmişinden bir changelog dosyası oluşturur, ve Changeloop, birleştirilen her pull request için kullanıcıya görünür bir kayıt hazırlar ve inceleme için tutar.

Çıktım neden Diğer ile dolu?

Baştaki fiiller bilinen hiçbir şeyle eşleşmedi, bu da genellikle bir isimle veya bilet kimliğiyle başlayan commit konularını gösterir. Ya oluşturmadan önce kutuda düzenle ya da Diğer satırlarını sonradan elle taşı.

Daha fazla okuma: conventional commit'lerden bir changelog'a, commit formatının ne kazandırdığı ve nerede durduğu üzerine.