Software Versionsverwaltung mit SVN

Aus HSHL Mechatronik
(Weitergeleitet von Software Versionsverwaltung)
Zur Navigation springen Zur Suche springen

Autor: Prof. Schneider

USVN

uSVN Benutzeroberfläche: https://svn.hshl.de/

Einleitung

Als Software Versionsverwaltung nutzen wir an der HSHL Subversion (SVN). Subversion ist ein freies/Open-Source Versionskontrollsystem. Das bedeutet, Subversion verwaltet Dateien und Verzeichnisse und die Änderungen an ihnen im Lauf der Zeit. Das erlaubt Ihnen, alte Versionen Ihrer Daten wiederherzustellen oder die Geschichte der Änderungen zu verfolgen. Unter diesem Blickwinkel denken viele Leute bei einem Versionskontrollsystem an eine Art „Zeitmaschine“.

Subversion kann netzwerkübergreifend arbeiten, was die Benutzung durch Menschen an verschiedenen Computern ermöglicht. Auf einer bestimmten Ebene fördert die Fähigkeit unterschiedlicher Personen dieselbe Menge an Daten bearbeiten und verwalten zu können die Zusammenarbeit. Ohne auf einen einzigen Kanal, über den alle Änderungen abgewickelt werden müssen, beschränkt zu sein, kann das Vorankommen beschleunigt werden. Und weil die Arbeit versioniert ist, braucht nicht befürchtet zu werden, dass die Qualität bei Verlust dieses Kanals geopfert wird – falls irgendeine falsche Änderung an den Daten gemacht wird, kann man sie einfach zurücknehmen.

USVN ist ein browserbasiertes Verwaltungssystem. Auf Ihrem Rechner benötigen Sie eine Client-Software um auf den Server zugreifen zu können. Eine ausführliche Zusammenstellung verfügbarer Clients finden Sie unter dieser Zusammenstellung und Vergleich von SVN-Clients, die für jeden Client die abgedeckten Funktionen aufführt.

Warum sollten Sie SVN nutzen?

  • Ihre Daten sind auf einem Server sicher und weltweit für Sie zugänglich.
  • Teammitglieder können auf ihre Arbeitsergebnisse zugreifen, auch wenn Sie verhindert sind.
  • Kommentare ermöglichen die schnelle Identifizierung von Änderungen.
  • Änderungen erfolgen persönlich - sie finden über die Historie sofort heraus, wer was programmiert hat.
  • Dateien liegen ihnen nur in einer Version vor - der aktuellen. Die Historie dieser Datei ist jederzeit rückverfolgbar und wiederherstellbar.
  • Fertige Stände Ihrer Software können mit einem Stempel (Tag) versehen und später schnell wiederhergestellt werden.
  • Versionsverwaltung ist Industriestandard und die Übung im Studium wird Ihnen später helfen sich zurecht zu finden.

Handbücher/Einführungen

Im Internet finden sich zahlreiche Anleitungen zu SVN und der Bedienung mit Tortoise SVN.

SVN Schnellstart

  1. Loggen Sie sich via usvn ein und ändern Sie Ihr Passwort
  2. Vorname_Nachname::Kennwort1 (z. B. Max_Mustermann Kennwort1). Achtung, Groß- und Kleinschreibung sind bei Nutzername und Passwort zu beachten!
  3. Prüfen Sie, ob Sie Zugang zum passenden Repositorium haben.
  4. Installieren Sie Tortoise SVN für Windows (Mac) inkl. "Language-Pack"
  5. Hochschulrechner:
    1. Legen Sie sich auf der Datenpartition unter \SVN ein Repositorium an.
    2. Sichern Sie alle Ihren Quelltext in Ihrem Gruppenordner.
  6. Eigener Rechner:
    1. Beliebigen Ordner erstellen (Empfehlung: Ordner ohne Leerstellen etc. verwenden, damit für Programmierung/Matlab/... keine Probleme)
    2. SVN > auschecken/checkout
  7. Machen Sie sich mit der Funktion von SVN bekannt.
  8. Antworten auf alle Fragen finden Sie hier.

Grundregeln im Umgang mit SVN

Nutzen Sie die folgende Liste und arbeiten Sie nachhaltig in SVN. Diese Liste ist lang, lohnt sich jedoch sehr, da sie die wichtigsten Regeln und Erkenntnisse beim Umgang und effizienten Arbeit mit SVN zeigt.

  1. Spätestens an jedem Arbeitstag sollten Sie ihre Daten ins Projektarchiv übertragen (="commit"), wenn nicht sogar nach jeder wichtigen Änderung
  2. Überlassen Sie SVN die Versionierung. Falsch wäre die Speicherung von 3 Dokumenten: Dokument_v1, Dokument_v2, Dokument_v3. Richtig: Dokument wurde 3x in SVN übertragen (Commit).
  3. Sichern Sie nur wichtige Dateien in SVN (auf keinen Fall Kompilat, Backup-Sicherheitskopien, temporäre Dateien (*.bak,...).
  4. Sichern Sie keine Binärdateien.
  5. Sichern Sie keine großen Videos oder große Bilder (max. 1MB pro Bild). Hier hilft z. B. ein Reduzieren der Auflösung oder Bildgröße.
  6. Testen Sie Ihren Quelltext sorgfältig vor dem Übertragen.
  7. Führen Sie zu Beginn Ihrer Arbeit und vor jedem "commit" stets ein "update" durch.
  8. Aktualisieren Sie vor dem Übertragen das gesamte Quellverzeichnis und testen Sie ggf. Ihre Funktion/Software etc. erneut.
  9. Sie sind verantwortlich für alle Fehler, die durch Ihr Änderungen entstehen. Also: testen, aktialisieren, Konflikte lösen, nochmal testen und übertragen.
  10. Sichern Sie nur getesteten Quellcode in SVN, welcher über Header und Kommentare verfügt.
  11. Übertragen Sie stets nur die Änderungen und nicht ein komplettes Verzeichnis.
  12. Wenn Sie eine Datei hinzufügen nutzen Sie SVN Add und anschließend SVN Commit
  13. Wenn es Konflikte gibt, kontaktieren Sie das Teammitglied und beheben Sie die Konflikte gemeinsam um Schäden zu vermeiden.
  14. Sie sind für Ihre Änderungen verantwortlich. Verwenden Sie Ihren Nutzernamen und Passwort.
  15. Checken Sie nur die Projekte aus, an denen Sie auch arbeiten.
  16. Sperren ("Lock") Sie Dateien nur dann, wenn diese zur Bearbeitung eine Sperre benötigen. Normalfall: Nie! Bei binären Dateien (Office-Dokumente, Bilder,...): Immer!
    1. Sperren werden automatisch entfernt beim Übertragungen (="commit") oder manuell über das Kontextmenü von z. B. TortoiseSVN.
    2. Sperren können über "Check for Modifications" überprüft werden. (Lokale tauchen direkt auf und um alle zusehen muss "Check Repository" verwendet werden)
  17. Übertragen (engl. "commit") Sie nur mit Kommentaren.
    1. Kommentare sollten verständlich und kurz gehalten werden.
    2. Kommentare erläutern Ihrer Änderungen. Was haben Sie geändert? (Jedoch nicht: Welche Datei ist neu, welche gelöscht etc.: das sieht man im Log-Bericht automatisch)
    3. Anzahl der Änderungen
    4. Typ der Änderung (Änderung, Bug Fix,…)
    5. Was macht die Änderung?
    6. Wichtige Details
    7. Ggf. Link zur Anforderung
    8. Ggf. Link zum Testbericht
    9. Name und Datum sind nicht notwendig!
  18. Lesen Sie ggf. zu Beginn Ihrer Arbeit das Log-File ("Show Log") und befolgen Sie die Hinweise.
  19. Verschieben Sie Inhalte nur mit der rechten Maustaste "SVN Move versioned Item(s) here".
  20. Versionieren Sie ausschließlich die Primärdateien. Nicht erlaubt sind:
    1. Compiler-, Build- oder Debug-Dateien oder Backups (z. B. .asv, .bkp, ~Dateinamen)
    2. Temporäre Ordner oder Ordner die nur für den Arbeitsrechner erstellt werden (z. B. .vs)
    3. Videodateien die nicht als Eingabedatei für Programme dienen
    4. Externe Bibliotheken die im gleichen Umfang im Internet zur Verfügung stehen (z. B. opencv)
  21. Vermeiden Sie in Ordnerbezeichnungen und Dateiennamen Sonderzeichen, Freizeichen und Umlaute (z. B. Uebung_1_2).
  22. Cleanup wird benötigt, wenn Fehler aufgetreten sind bei einem Commit oder Update.
    1. Cleanup sollte im Obersten Ornder verwendet werden.
    2. In den meisten Fällen sollte "Clean up working copy status" und "Refresh shell overlays" genügen.
    3. Genaue Befehl Beschreibung ist hier aufzufinden [1]
    4. Weitere TortoiseSVN Regeln

Umgang mit binären (nicht textbasierten) Dateien

SVN spielt seine Stärke besonders dann aus, wenn textbasierte Dateien versioniert werden sollen, z. B. Programmcode, Skripte etc. Beim Versionieren werden dann die Änderungen von verschiedenen Nutzern zusammengeführt.

Bei binären Dateien (Bilder, Excel-Tabellen, ...) macht dieses Vorgehen keinen Sinn, da durch das Zusammenführen nicht mehr richtig interpretierbare Dateien resulieren können. Um auch diese Dateien per SVN versionieren zu können, müssen so genannte Sperren genutzt werden. Vorgehen beim Arbeiten mit Sperren:

  • Per Rechtsklick - Tortoise SVN - Eigenschaften - Neu - Dateisperre kann eingestellt werden, dass eine Datei eine Sperre benötigt.
  • Eine Datei mit dieser Eigenschaft ist dann in jeder Arbeitskopie zu Beginn gesperrt, d. h. schreibgeschützt.

Zum Arbeiten mit dieser Datei befolgen Sie folgende Schritte:

  1. Rechtsklick auf die Datei - Tortoise SVN - Sperre holen >> Datei ist entsperrt, d. h. veränderbar (Schreibschutz aufgehoben)
  2. Datei ändern und speichern
  3. Beim Übertragen per Rechtsklick auf die Datei - Tortoise SVN - Übertragen ist die Datei wieder gesperrt.
  4. Hinweis: Beim letzten Schritt kann das automatische Wieder-Sperren deaktiviert werden, falls Sie z. B. gleich weiter mit der Datei arbeiten möchten.

Wann sollte man Daten übertragen?

  1. Sie haben einen SW-Stand zu dem Sie zurückkehren möchten.
  2. Übertragen Sie zusammenhängenden Dateien in einer Operation. Nutzen Sie eine Nachricht (engl. Message) für alle Dateien.
  3. Übertragen Sie Daten als Backup.
  4. Übertragen Sie Daten von einem Arbeitsrechner, um diese mit anderen zu teilen.

Anforderungen an Ihr Passwort

Für das Arbeiten mit SVN ist zwingend ein sicheres Passwort erforderlich. Bechaten Sie nachfolgende Regeln

  • Das Passwort muss mindestens 12 Zeichen umfassen.
  • Es sollte mindestens 2 Sonderzeichen, eine Zahl, einen Kleinbuchstaben und einen Großbuchstaben enthalten.
  • Für das Passwort sind folgende Zeichen erlaubt:
    • Kleinbuchstaben ( a - z )
    • Großbuchstaben ( A - Z )
    • Ziffern ( 0 - 9 )
    • die Sonderzeichen ( ) [ ] { } ? ! $ % & / = * + ~ , . ; : < > - _

Keine Zugriffsrechte

Wenn Sie auf Ihren Ordner auf einem Hochschulrechner keine Zugriffsrechte habe, obwohl diese eingerichtet wurden, kann es sein, das eine Vorgängerin das Password gespeichert hat.

Mit nachfolgenden Schritten löschen Sie das hinterlegte Passwort:

  • Tortoise SVN > Settings
  • Saved Data > Authentification data > Clear all

ClearAll.jpg

Verbindungsprobleme

Bei Verbindungsproblemen schreiben Sie bitte eine Email an die IT (it-support@hshl.de‎) und beschreiben Sie freundlich Ihr Problem und senden Sie folgende Infos:

  • Betreff: Ticket#2013120310000018
  • Fehlermeldung
  • Zeit
  • Client
  • Netz (HSHL oder Web incl. IP Adresse)

Einführungsvideo

Video Kurzeinführung

Hinweis: Für die Ansicht dieses privaten Videos ist eine Anmeldung bei YouTube erforderlich.

Video Tutorials

Mit den folgenden Video Tutorial lernen Sie spielend leicht und kostenlos den Einstieg in die Versionskontrolle:

  • Christopher Janietz- Versionskontrolle mit Git und SVN bei LinkedIn
  • Julian Robichaux - SVN for Java Developers bei LinkedIn

Den kostenlosen Zugang zum LinkedIN Portal erhalten Sie über den Bibliothekskatalog unter dem Reiter "Literatur und Fachdatenbanken".

Weblinks

Versionskontrolle mit Git und SVN

Literatur