Projekt-Readme angepasst.

This commit is contained in:
2022-01-29 12:02:05 +01:00
parent c1b3c6cdac
commit 22084fb40d

View File

@@ -1,7 +1,7 @@
# README # # README #
Dieses Projekt enthält die Servicedefinitionen von OMDS 3 als WSDLs und XSDs. Dieses Projekt enthält die Servicedefinitionen von OMDS 3 als WSDLs und XSDs.
Ferner sind die Dokumentationen der Seriveces als Word-Dateien enthalten. Ferner sind die Dokumentationen der Services als Word-Dateien enthalten.
Git-Workflow Git-Workflow
------------ ------------
@@ -9,23 +9,24 @@ Seit dem 1.9.2019 folgt das Projekt folgt dem GitFlow-Workflow, welcher [hier](h
Es gibt folgende Haupt-Branches: Es gibt folgende Haupt-Branches:
* master - der Master repräsentiert seit dem 1.9.2019 die offizielle Hauptentwicklungslinie und enthält die Releases als Tags * **master** - der Master repräsentiert seit dem 1.9.2019 die offizielle Hauptentwicklungslinie und enthält die Releases als Tags
* develop - der Branch für die laufende Entwicklung, hier findet aktudie Entwicklung für Version 1.6 statt * **develop** - der Branch für die laufende Entwicklung, der Development-Branch kann der Veröffentlichung um mehrere Versionen vorauseilen.
Es können auch Services oder Objekte wieder verworfen werden.
* release/1.5 - die Version 1.5 * **release/...** - der aktuelle Release-Candidate für die kommende Version. Dieser enthält nur solche Services und Objekte, die mit hoher Wahrscheinlichkeit im neuen Release enthalten sind.
* Release_1.4 - der Zweig für die Entwicklung von Version 1.4 (abgeschlossen, 1.4 ist veröffentlicht) * **feature/...** - Feature-Branches, in denen eigene Features modelliert werden, die noch so früh in der Diskussion sind, dass sie nicht einmal in den Development-Branch aufgenommen wurden.
* Release_1.3 - der Zweig für die Entwicklung von Version 1.3 (abgeschlossen, 1.3 ist veröffentlicht)
Daneben existieren einzelne Feature-Branches, welche nur für Entwickler nach Absprache interessant sind.
Projektaufbau Projektaufbau
------------- -------------
Der Projektaufbau ist wie folgt: Die Inhalte des Projekts sind in den folgenden Verzeichnissen organisiert:
* src/main/resources/def - XSD und WSDL-Files * doc - Die Dokumentation der Services als Word Files
* src/main/resources/bind - Binding Definitionen für Apache CXF Framework * docEntw - Die Dokumentation von Services, die noch nicht für den Release vorgesehen sind.
* doc - Die Dokumentation als Word Files * docGen - Die mittels XMLSPY generierte Dokumentation (nur in den Veröffentlichungen enthalten)
* src/main/java - beispielhaft mit CXF generierte Java-Klassen * src/main/java - beispielhaft mit CXF generierte Java-Klassen
* src/main/resources/bind - Binding Definitionen für Apache CXF Framework
* src/main/resources/def - XSD und WSDL-Files
Im Verzeichnis *src/main/resources/def* sind in Unterverzeichnisssen auch ältere Versionen Im Verzeichnis *src/main/resources/def* sind in Unterverzeichnisssen auch ältere Versionen
von OMDS 3 Definitionen enthahlten, damit ein einfacher Vergleich zwischen Versionen möglich ist. von OMDS 3 Definitionen enthahlten, damit ein einfacher Vergleich zwischen Versionen möglich ist.