From cba171929f3fcf5b2e620d50f8c1699cdc9a3393 Mon Sep 17 00:00:00 2001 From: Jan Zickermann <jan.zickermann@dataport.de> Date: Tue, 10 Dec 2024 13:39:43 +0100 Subject: [PATCH] #2 OZG-7121 Remove asciidoc Readme --- README.adoc | 94 ----------------------------------------------------- README.md | 3 ++ 2 files changed, 3 insertions(+), 94 deletions(-) delete mode 100644 README.adoc create mode 100644 README.md diff --git a/README.adoc b/README.adoc deleted file mode 100644 index bb8a831..0000000 --- a/README.adoc +++ /dev/null @@ -1,94 +0,0 @@ -:toc: -:toc-title: Inhalt -:toclevels: 3 - -## Build - -.Bauen des Projektes -[source,bash] ----- -$ mvn clean package ----- - -.Bauen des Projektes mit einem Profil -[source,bash] ----- -$ mvn clean package -P <Profilename> ----- - -Profile werden immer in der Reihenfolge angewendet, in welcher Sie angegeben wurden. - -.Verfügbare Profilnamen -- "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 - -.Beispiel -[source,bash] ----- -$ mvn clean package -P plantuml,asciidoctor ----- - -## Release-Erstellung - -Eine Konsole im Projektverzeichnis öffnen und in den develop Branch wechseln. - -[source,bash] -``` -$ git checkout develop -``` - -Branch aktualisieren. -[source,bash] -``` -$ git pull -``` - -Release 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.** - -[source,bash] -``` -$ mvn clean package gitflow:release-start -``` -In 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. - -[source,bash] -``` -$ mvn gitflow:release-finish -``` - - -== ASCIIDOC - -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 https://docs.asciidoctor.org/asciidoctor/latest/tooling/[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 -https://plantuml.com[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. - -=== Umwandeln in eine SVG Grafik - -Die Umwandlung in SVG erfolgt durch den Build mit dem Profil "asciidoctor". - -[source,bash] ----- -$ mvn clean package -Pasciidoctor ----- - diff --git a/README.md b/README.md new file mode 100644 index 0000000..a6ee46c --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# XTA-Test-Server + +Ein XTA-Server ohne Nutzer-Zugriffsbeschränkung für integrative Test-Umgebungen \ No newline at end of file -- GitLab