Sürümler
Bu sayfa, Axelix'i yayımlamak için izlediğimiz süreci ayrıntılı olarak açıklar.
İki sürüm türü vardır ve aynı biçimi paylaşırlar: ikisi de tüm bileşenleri aynı anda, tek sürüm altında sunar:
- Minör sürüm,
master'dan oluşturulur ve yeni birX.Yserisi açar. - Yama sürümü, serinin yama dalından (
X.Y.x) oluşturulur ve tüm bileşenleriX.Y.Zsürümüne taşır.
Elbette ana sürümlerimiz de olacak. Ana sürüm zamanı geldiğinde onu da belgeleyeceğiz.
Bunların temelindeki dal yapısı için Dal modeli sayfasına bakın.
Minör sürümler
Minör sürüm tüm bileşenleri tek X.Y.0 sürümü altında birlikte yayımlar ve master üzerinde vX.Y.0 etiketiyle işaretler
(tüm bileşenler için tek sürüm bölümüne bakın).
Süreç sırasıyla şöyledir:
1. Hazırlık
Hazırlık, sürümden önce yapılan elle değişiklikler kümesidir. Hepsi master üzerinde tek commit'e girer;
böylece ertelememiz gerekirse tüm sürüm temizce geri alınabilir veya cherry-pick edilebilir.
- Tüm bileşenlerin sürümünü ayarlayın. Sürümler arasında kök
gradle.propertiesiçindekiaxelixVersion, gelecek sürümü-SNAPSHOTson ekiyle taşır; örneğin3.1.0geliştirilirken3.1.0-SNAPSHOT. Hazırlıkta bu son ek kaldırılır ve yayımladığımız tam sürüm ayarlanır;3.1.0için3.1.0yapın. Yayım işlem hattının okuduğu ve oluşan etiketin adını aldığı değer budur; işlem hattı-SNAPSHOTsürümünü yayımlamayı reddeder. Kökgradle.properties, sürümün bulunduğu tek yerdir; tüm bileşenler onu buradan devralır. - Playground sürümlerini artırın.
playgrounds/altındaki örnek uygulamalar tasarım gereği ayrı projelerdir;axelixVersiondeğerini devralmaz, kullandıkları Axelix starter ve eklenti sürümlerini açıkça sabitlerler. Bu sabit sürümleri yayımlanacak sürüme yükseltin. - Dokümantasyonu güncelleyin. Dokümantasyonu yalnızca ana seri başına sürümlendiririz. Örneğin minör sürüm geliştirilirken sunacağı özelliklere “yakında” bildirimleri ekleriz; bunları sunan minör sürümü yayımladığımızda ilgili “yayımlandı” bildirimleriyle değiştiririz.
2. Yayım işlem hattını başlatın
Etiketi elle oluşturmayız. Yayım işlem hattı gradle.properties dosyasından sürümü okur ve yayım öncesi denetimleri
çalıştırır. Ardından Maven artifact'larını (starter ve eklentiler) yayımlar, Master Docker imajını derleyip gönderir,
Helm chart'ı paketleyip imzalar. Ancak bundan sonra vX.Y.0 etiketini oluşturup gönderir ve Helm chart deposunu günceller.
Bu nedenle işlem hattı etiket oluşturmadan önce başarısız olursa artifact'lar zaten yayımlanmış olabilir.
Sürüm notları elle yazılır
İşlem hattı etiketi ve JAR ile Helm varlıklarının eklendiği bir taslak GitHub sürümü oluşturur.
Sürümü hazırlayan geliştirici, taslağın vX.Y.0 notlarını düzenlemeli ve ardından taslak sürümü elle yayımlamalıdır.
Yalnızca notları yazmak sürümü yayımlamaz.
Yama sürümleri
Her Axelix sürümü gibi yama sürümü de tüm bileşenleri tek sürüm altında sunar; bileşen başına yama yoktur.
Süreç minör sürüme benzer, tek yapısal fark master yerine minör serinin yama dalından oluşturulmasıdır.
Dokümantasyon adımı atlanır; yamalar dokümantasyonu değiştirmez.
-
Yama dalına geçin. Yama çalışmaları serinin
X.Y.xadlı tek dalında bulunur. Gerçekx, tüm yama serisini işaretler; etiketin aksine dal adındavön eki yoktur. Minör sürümünvX.Y.0etiketinden ayrılır (Dal modeli → Yama çalışmaları nerede yapılır? bölümüne bakın). Serinin ilk yamasıysa etiketten oluşturun; değilse zaten vardır. -
Düzeltmeleri bu dala alın. Düzeltme genellikle önce
master'a girer ve yama dalına geri taşınır; yalnızca yamanın gerçekten düzelttiği şey değişir. -
Dal üzerinde hazırlık (tek commit).
- Tüm bileşenlerin sürümünü ayarlayın. Kök
gradle.propertiesiçindekiaxelixVersiondeğerini yeni yama sürümüX.Y.Zyapın.master'ın aksine yama dalı sürümler arasında-SNAPSHOTson eki taşımaz; bir sonraki yama artırana kadar serisinin son yayımlanan sürümünde kalır. - Playground sürümlerini artırın. Minör sürümle aynı nedenle örnek uygulamaları yeni yama sürümüne güncelleyin:
playground'lar Axelix sürümlerini açıkça sabitler ve
axelixVersiondeğerini devralmaz.
- Tüm bileşenlerin sürümünü ayarlayın. Kök
-
Yayım işlem hattını başlatın. Minör sürümdeki aynı işlem hattıdır, ancak
masteryerine yama dalından başlatılır. Yukarıdaki denetim, yayımlama, paketleme ve etiketleme sırasınıX.Y.Zsürümü vevX.Y.Zetiketiyle izler. Her Axelix etiketi gibivön eki taşır. Minör sürümde olduğu gibi JAR ve Helm varlıkları içeren taslak GitHub sürümü oluşturur. Geliştirici yeni etiketin taslak notlarını düzenlemeli ve ardından taslak sürümü elle yayımlamalıdır.
Uygulamalı örnek
3.1.0 sürümünde Axelix Spring Boot 3 Starter için düzeltme gerektiğini varsayalım:
- Yama,
v3.1.0etiketinden ayrılan3.1.xdalında bulunur.3.1serisine daha önce yama yapılmışsa dal zaten vardır; değilsev3.1.0etiketinden oluştururuz. - Düzeltmeyi
master'dan bu dala geri taşırız. - Kök
gradle.propertiesiçindeaxelixVersiondeğerini yayımlamak istediğimiz yama sürümü3.1.1yapar ve playground'ları3.1.1sürümüne yükseltiriz. - Yayım işlem hattını
3.1.xdalından başlatırız. Maven artifact'larını ve Master imajını3.1.1ile yayımlar, Helm chart'ı paketler, ardından tüm bileşenlerinv3.1.1etiketini oluşturup gönderir. Sonra chart deposunu günceller. Gerçekte yalnızca bir starter değişmiş olsa da her bileşen3.1.1sürümünü alır.
Sonuç, tüm bileşenler için tek sürüm sözünün
karşılığıdır: yayımdan sonra 3.1.1 tüm bileşenler için vardır. Dağıtılmış her bileşeni aynı anda mı yoksa yalnızca
düzeltileni mi yükselteceğiniz size kalmıştır;
uyumluluk major.minor ile garanti edilir,
bu nedenle dağıtılmış bileşenler arasındaki yama düzeyi farkı her zaman güvenlidir.