Skip to content
Snippets Groups Projects
Commit cba17192 authored by Jan Zickermann's avatar Jan Zickermann
Browse files

#2 OZG-7121 Remove asciidoc Readme

parent ed472681
No related branches found
No related tags found
1 merge request!3Resolve "xta-test-server helm-chart mit Deployment und Keystore-Secrets/Certificate-Resources"
: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
----
# XTA-Test-Server
Ein XTA-Server ohne Nutzer-Zugriffsbeschränkung für integrative Test-Umgebungen
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment