Versionierung der Dokumente

Wenn Sie ein Dokument erstellen, bearbeiten oder veröffentlichen, ist es wichtig, die Version des Dokuments zu kennzeichnen. Die Versionierung hilft Ihnen und anderen, die Änderungen und den Stand des Dokuments nachzuvollziehen. Die zur Fortschreibung eingesetzten Werkzeuge unterstützen ausschließlich die Versionsverwaltung auf Basis von Git-Tags im semantischen Versionierungsschema.

Semantische Versionierung

Semantische Versionierung ist ein Schema zur Nummerierung von Versionen von Software, das die Bedeutung von Änderungen und die Kompatibilität zwischen verschiedenen Versionen klar definiert. Das Schema besteht aus drei Zahlen, die durch Punkte getrennt sind: MAJOR.MINOR.PATCH.

• Patch: Änderungen redaktioneller Art.
• Minor Release: Patch und Änderungen ohne direkte Auswirkung auf die Nutzenden.
• Major Release: Minor und Änderungen mit direkter Auswirkung auf die Nutzenden.

Die folgende Matrix zeigt die Zuordnung von Arten der Anpassung zu den jeweiligen Releasetypen (Major-Releases, Minor-Releases und Patches) für die Fortschreibung der IT-Architekturrichtlinien.

Tagging

Es ist empfehlenswert, wichtige Versionen Ihres Dokuments zu taggen. Ein Tag ist ein Bezeichner, der auf einen bestimmten Commit verweist. Sie können etwa einen Tag für die Version 1.0.0 Ihres Dokuments erstellen. Die verwendeten Werkzeuge beachten diesen Tag. Zum Beispiel wird durch das Anlegen eines Tags automatisch eine PDF-Datei für diese Version erzeugt und die Versionsnummer entsprechend (z.B. auf dem Deckblatt) eingesetzt.

Pre-Release Tags können verwendet werden, um eine Version Ihres Dokuments zu kennzeichnen, die noch nicht für die Produktion freigegeben ist, aber als offizieller Release-Kandidat gilt. Sie können etwa einen Tag für die Version 1.0.0-rc01 Ihres Dokuments erstellen.

Einen Tag können Sie in Ihrem Repository unter “Code” → “Tags” erstellen.

Schützen von Tags (Protected Tags)

Es ist empfehlenswert, Tags zu schützen, um zu verhindern, dass sie gelöscht oder überschrieben werden. Wir empfehlen Ihnen unter “Settings” → “Repository” → “Protected Tags” die folgenden Regeln zu definieren:

• Pattern: * (alle Tags)
• Allowed to create: Maintainer