Veröffentlichungen
Diese Seite beschreibt das genaue Verfahren zur Veröffentlichung von Axelix.
Es gibt zwei Veröffentlichungsarten mit demselben Grundprinzip: Beide liefern alle Komponenten gleichzeitig unter einer Version aus:
- Eine Minor-Version entsteht aus
masterund eröffnet eine neue LinieX.Y. - Eine Patch-Version entsteht aus dem Patch-Branch dieser Linie (
X.Y.x) und bringt alle Komponenten aufX.Y.Z.
Auch Major-Versionen sind vorgesehen. Sobald diese anstehen, dokumentieren wir auch deren Veröffentlichung.
Die zugrunde liegende Branch-Struktur beschreibt das Branching-Modell.
Minor-Versionen
Eine Minor-Veröffentlichung liefert alle Komponenten gemeinsam unter X.Y.0 aus und kennzeichnet dies durch einen Tag vX.Y.0 auf master, siehe
eine Version für alle Komponenten.
Die Schritte in ihrer Reihenfolge:
1. Vorbereitungen
Die Vorbereitungen umfassen manuelle Änderungen vor der Veröffentlichung. Alle gelangen in einen einzigen Commit auf master, damit sich
die Veröffentlichung bei einer Verschiebung sauber zurücksetzen oder per Cherry-pick übernehmen lässt.
- Gemeinsame Version setzen. Zwischen Veröffentlichungen trägt
axelixVersionin dergradle.propertiesim Repository-Stammverzeichnis die kommende Version mit-SNAPSHOT, etwa3.1.0-SNAPSHOTwährend der Entwicklung von3.1.0. Entfernen Sie zur Veröffentlichung das Suffix und setzen Sie exakt die zu veröffentlichende Version, für3.1.0also3.1.0. Die Release-Pipeline liest diesen Wert und benennt danach den Tag. Sie verweigert die Veröffentlichung einer-SNAPSHOT-Version. Diegradle.propertiesim Repository-Stammverzeichnis ist der einzige Ablageort der Version, von dem alle Komponenten sie erben. - Playgrounds aktualisieren. Die Beispielanwendungen unter
playgrounds/sind bewusst separate Projekte. Sie erbenaxelixVersionnicht, sondern geben ihre Starter- und Plugin-Versionen explizit an. Aktualisieren Sie diese auf die zu veröffentlichende Version. - Dokumentation aktualisieren. Wir versionieren die Dokumentation nur pro Major-Linie. Während der Entwicklung einer Minor-Version erhalten neue Funktionen Hinweise auf eine kommende Veröffentlichung. Sobald die Minor-Version diese Funktionen ausliefert, werden die Hinweise durch entsprechende Veröffentlichungshinweise ersetzt.
2. Release-Pipeline starten
Wir erstellen den Tag nicht von Hand. Die Release-Pipeline liest die Version aus gradle.properties und führt
die Vorabprüfungen aus. Anschließend veröffentlicht sie die Maven-Artefakte (Starter und Plugins), baut und überträgt
das Master-Docker-Image und paketiert und signiert das Helm-Chart. Erst danach erstellt und überträgt sie den Tag
vX.Y.0 und aktualisiert anschließend das Helm-Chart-Repository. Artefakte können daher bereits veröffentlicht sein,
wenn die Pipeline vor der Tag-Erstellung fehlschlägt.
Versionshinweise werden von Hand geschrieben
Die Pipeline erstellt den Tag, aber keine Versionshinweise. Diese schreibt der Entwickler, der die Veröffentlichung durchführt,
manuell für den neu erstellten Tag vX.Y.0.
Patch-Versionen
Wie jede Axelix-Veröffentlichung liefert eine Patch-Version alle Komponenten unter einer Version aus. Komponentenspezifische Patches gibt es nicht.
Das Verfahren entspricht einer Minor-Veröffentlichung mit einem strukturellen Unterschied: Es verwendet den Patch-Branch der Minor-Linie statt master.
Der Dokumentationsschritt entfällt, da Patches die Dokumentation nicht ändern.
- Patch-Branch auschecken. Patch-Arbeiten liegen auf dem einzigen Branch der Linie namens
X.Y.x. Das wörtlichexkennzeichnet die gesamte Patch-Linie. Anders als ein Tag hat der Branch kein Präfixv. Er wird vom Minor-TagvX.Y.0abgezweigt, siehe Branching-Modell → Wo Patch-Arbeiten stattfinden. Erstellen Sie ihn vom Tag, wenn dies der erste Patch der Linie ist. Andernfalls existiert er bereits. - Korrekturen in diesen Branch übernehmen. Üblicherweise gelangt eine Korrektur zuerst nach
masterund wird dann zurückportiert. Nur die vom Patch tatsächlich korrigierten Teile ändern sich. - Vorbereitungen auf dem Branch in einem Commit.
- Gemeinsame Version setzen. Setzen Sie
axelixVersionin dergradle.propertiesim Repository-Stammverzeichnis auf die neue Patch-VersionX.Y.Z. Anders alsmasterträgt der Patch-Branch zwischen Veröffentlichungen kein Suffix-SNAPSHOT. Er bleibt bei der zuletzt veröffentlichten Version seiner Linie, bis der nächste Patch sie erhöht. - Playgrounds aktualisieren. Aktualisieren Sie die Beispielanwendungen auf die neue Patch-Version. Wie bei Minor-Veröffentlichungen geben sie ihre Axelix-Versionen explizit an und erben
axelixVersionnicht.
- Gemeinsame Version setzen. Setzen Sie
- Release-Pipeline starten. Es ist dieselbe Pipeline wie bei einer Minor-Version, gestartet vom Patch-Branch
statt von
master. Sie folgt derselben oben beschriebenen Reihenfolge für Prüfungen, Veröffentlichung, Paketierung und Tag-Erstellung mit VersionX.Y.Zund TagvX.Y.Z. Wie jeder Axelix-Tag trägt er das Präfixv. Die Pipeline erstellt auch hier den Tag, aber keine Versionshinweise. Diese schreibt der Entwickler manuell zum neuen Tag.
Beispiel
Angenommen, die Version 3.1.0 benötigt eine Korrektur im Axelix Spring Boot 3 Starter:
- Der Patch liegt im Branch
3.1.x, abgezweigt vom Tagv3.1.0. Wenn es für3.1schon einen Patch gab, existiert dieser Branch bereits. Andernfalls erstellen wir ihn vonv3.1.0. - Wir portieren die Korrektur von
masterauf diesen Branch zurück. - In der
gradle.propertiesim Repository-Stammverzeichnis setzen wiraxelixVersionauf3.1.1, die gewünschte Patch-Version, und aktualisieren die Playgrounds auf3.1.1. - Wir starten die Release-Pipeline vom Branch
3.1.x. Sie veröffentlicht die Maven-Artefakte und das Master-Image unter3.1.1, paketiert das Helm-Chart und erstellt und überträgt danach den gemeinsamen Tagv3.1.1. Anschließend aktualisiert sie das Chart-Repository. Jede Komponente erhält die Version3.1.1, obwohl sich nur ein Starter geändert hat.
Das Ergebnis entspricht der Zusage einer Version für alle Komponenten:
Nach der Veröffentlichung existiert 3.1.1 für sämtliche Komponenten. Ob Sie alle bereitgestellten Komponenten zugleich aktualisieren oder nur die tatsächlich
korrigierte, entscheiden Sie selbst. Kompatibilität ist durch major.minor garantiert,
sodass unterschiedliche Patch-Stände bereitgestellter Komponenten immer sicher sind.