Build
$ mvn clean package$ mvn clean package -P <Profilename>Profile werden immer in der Reihenfolge angewendet, in welcher Sie angegeben wurden.
-
"zip" - Erstellen von einer Zip-Datei mit allem Projektinhalten
-
"plantuml" - Umwandeln der *.puml-Grafiken in das SVG-Format zum Einbetten in die Dokumentation
-
"asciidoctor" - Erstellen der Dokumentation im Format HTML und PDF
$ mvn clean package -P plantuml,asciidoctorRelease-Erstellung
Eine Konsole im Projektverzeichnis öffnen und in den develop Branch wechseln.
$ git checkout developBranch aktualisieren.
$ git pullRelease beginnen. In der Konsole wird die nächste Releaseversion abgefragt. Wichtig: Es dürfen keine Release-Branches (origin/release/…) mehr offen sein, anderenfalls kann kein neues Release gestartet werden. Weiterhin dürfen keine unveröffentlichten Änderungen im Projekt vorhanden sein.
$ mvn clean package gitflow:release-startIn diesem Schritt wird ein Release-Branch erzeugt. In diesem können bei Bedarf letzte Änderungen durchgeführt werden.
Wichtig: Es soll kein Push zurück ins Repository erfolgen, die Änderungen werden nur via Commit ins Repository übertragen. Release abschließen ohne Deployment. Das Deployment übernimmt GitLab.
$ mvn gitflow:release-finishASCIIDOC
Für die Projektdokumentation wird ASCIIDOC verwendet. ASCIIDOC bietet viel mehr Möglichkeiten bei der Dokumentation als Markdown.
Editor
Es gibt die verschiedensten Editoren für ASCIIDOC Dateien (siehe Link). Der Eclipse ASCIDOC Editor hat Probleme SVG Dateien korrekt im Preview anzuzeigen. Der Editor für Visual Studio Code hat diese Probleme nicht.
PlantUML
Für die Erstellung von Klassendiagrammen und Sequenzdiagrammen wird PlantUML verwendet. Die Diagramme werden in die ASCIIDOC Dokumente als SVG Grafik eingebunden. Dies ist wichtig, da anderenfalls die Diagramme im GitLab Projekt nicht dargestellt werden. Das Rendern von PlantUML Diagrammen ist im GitLab nicht aktiviert.