Subversion und Tortoise SVN Tutorial. Quelle: mit freundlicher Genehmigung von sd&m Research

Transkript

1 Subversion und Tortoise SVN Tutorial Quelle: mit freundlicher Genehmigung von sd&m Research

2 Agenda Agenda Tutorial Troubleshooting und FAQ Weiterführende Informationen Exkurs: Alternativ-Tool zu Tortoise Seite 2

3 Zugriff mit Tortoise SVN oder mit Web-Browser auf das Subversion-Repository Tutorial Seite 3

4 Tutorial Tutorial 1. Tools im Überblick 2. Zugang zum Repository 10. Lösen von Konflikten, die durch paralleles Bearbeiten desselben Dokuments entstanden sind 3. Client-Software einrichten 4. Repository-Inhalte initial auschecken 5. Integration in Windows Explorer / Kontext-Menu und Bedeutung der Icons im Explorer. 6. Das Kontextmenu 7. Änderung eines Dokumentes und Einstellung der neuen Version in das Repository 8. Aktualisierung des lokalen Arbeitsverzeichnisses Neue Versionen aus dem Repository holen 9. Erzeuge ein neues Dokument oder Verzeichnis und füge es zum Repository hinzu. 11. Exportieren, d.h. Kopieren von Dateien aus dem Arbeitsverzeichnis in ein anderes lokales Verzeichnis auf dem Arbeitsplatz 12. Ältere Versionen eines Dokuments oder Verzeichnisses holen 13. Verwenden von Log-Einträgen zur besseren Identifikation 14. Kommunikation von Dokumenten / Ordnern an andere Nutzer Seite 4

5 Tutorial 1. Tools im Überblick Das Dokumenten-Repository basiert auf der freien Versionsverwaltung Subversion (kurz "SVN", Version 1.3.0). Für Lese- und Schreibzugriffe wird eine SVN-Client-Software benötigt. Verschiedene Tools sind möglich, im folgenden wird nur Tortoise als der Defacto-Standard referenziert: Tortoise SVN 1.3.2: Integration des SVN-Clients in den Windows- Explorer und das Kontext-Menu Für reine Lese-Zugriffe reicht ein Web-Browser IE oder Firefox aus. Alternativ zu Tortoise kann auch Smart SVN (Foundation Edition) benutzt werden: Smart SVN ist SVN-Client mit eigener Explorer-GUI Seite 5

6 Tutorial 2. Zugang zum Repository TortoiseSVN (read + write) Browser Zugang (read only) Schreibender Zugriff auf das Repository vom Arbeitsplatz; Update und Commit von Änderungen Lesender Zugang über Web-Browser; Download von Dokumenten Seite 6

7 3. Client-Software einrichten 1/2 TortoiseSVN unter Windows: Komfortabler Zugriff auf das Subversion-Repository Tutorial Der TortoiseSVN Client kann von folgender Adresse bezogen werden: msi Die Installationsdatei liegt auch \\mucfs4\sr-daten Speichere die Installationsdatei (*.msi) in ein temporäres Verzeichnis auf deiner Festplatte (z.b. c:\temp). Starte die Installationsdatei durch Doppelklicken auf das Dateisymbol und folge den Installationsanweisungen. Nach der Installation ist es notwendig den Rechner neu zu starten. Seite 7

8 3. Client-Software einrichten 2/2 Deutsche Sprachdatei für TortoiseSVN unter Windows Tutorial Die deutsche Sprachdatei für den TortoiseSVN Client kann unter folgender Adresse runter geladen werden: Speichere die Installationsdatei (*.exe) in ein temporäres Verzeichnis auf deiner Festplatte (z.b. c:\temp). Starte die Installationsdatei durch Doppelklicken auf das Dateisymbol und folge den Installationsanweisungen. In einem beliebigen Verzeichnis in der Dateiliste mit der rechten Maustaste klicken. Es erscheint das Kontextmenü. Dort TortoiseSVN und anschließend Optionen anklicken. Im neu geöffneten Dialogfenster im Bereich Allgemein die Sprache auf Deutsch umstellen. Abschließend auf OK klicken. Seite 8

9 4. Repository-Inhalte initial auschecken. 1/2 Mit Tortoise SVN wird eine lokale Kopie des Depots angelegt. Tutorial Erzeuge ein leeres Verzeichnis dies wird das lokale Arbeitsverzeichnis für die Dokumente. Achtung: Zu lange Pfad-Namen können Probleme bereiten. Daher sollte das Arbeitsverzeichnis möglichst weit oben im Pfad angelegt werden. Öffne das Arbeitsverzeichnis, drücke die rechte Maustaste und wähle "SVN Auschecken " Gebe die URL des Repositorys eins... oder auch eines Teils des Repositorys ein. Der gesamte Repository-Inhalt wird in das angegebene Checkout-Verzeichnis kopiert. Stelle sicher, dass genug freier Speicher vorhanden ist. Abhängig von der URL des Repositories ist es auch möglich, nur Teile des Repositories auszuchecken. Seite 9

10 4. Repository-Inhalte initial auschecken. 2/2 Mit Tortoise SVN wird eine lokale Kopie des Depots angelegt. Tutorial Das Passwort kann durch jeden Benutzer selbst geändert werden Wird Anmeldedaten speichern angewählt, so wird ein wiederholtes Authentifizieren bei jedem weiteren Zugriff auf das Repository vermieden. Achtung: Das Passwort wird im Klartext (!!!) in einer Datei innerhalb des Nutzer-Windows-Profils gespeichert. Der Inhalt des Repositorys wird nun ausgecheckt und in das gewählte Arbeitsverzeichnis kopiert. Dieser Vorgang kann abhängig von der Größe des Repositories und der Verbindung zum Server einige Zeit dauern. Nach dem vollständigen Auschecken wird der OK-Button aktiv. Der Inhalt des Repositories ist jetzt auf dem Rechner und kann bearbeitet werden. Seite 10

11 5. Integration in Windows Explorer / Kontext-Menu und Bedeutung der Icons im Explorer. Tutorial TortoiseSVN ist den Windows Explorer integriert. Aktionen werden über das Kontextmenü (separates Menü: TortoiseSVN) gesteuert. Der aktuelle Status eines Dokuments oder Verzeichnisses wird über das Icon dargestellt. Das Dokument oder Verzeichnis existiert in der aktuellen Version im Repository. Das Dokument oder Verzeichnis wurde lokal geändert, die Version des Repositorys ist unverändert. Das Dokument oder Verzeichnis ist gesperrt. Es besteht ein Konflikt oder Problem mit dem Dokument/Verzeichnis (2 Benutzer haben parallel etwas geändert) Das Dokument oder Verzeichnis wird mit dem nächsten Commit dem Repository hinzugefügt. Das Dokument oder Verzeichnis wird mit dem nächsten Commit aus dem Repository gelöscht. Seite 11

12 Tutorial 6. Das Kontextmenu Update auf die neuste Version des Dokuments/Verzeichnisses aus dem Repository Checked die lokale Version der markierten Dokumente/Verzeichnisse ein. (der möglicher Lock muss vorher aufgehoben sein) Zeige die Historie der Änderungen des Repositories Der Repository-Browser erlaubt Änderungen des Repositories, ohne lokale Kopien zu haben Suche des Repository nach neueren Versionen der markierten Dokumente/Verzeichnisse. Update zu einer definierten Version eines Dokuments/Verzeichnisses des Repositorys. Umbenennen eines markierten Dokuments/Verzeichnisses im Repository. Löschen eines markierten Dokuments/Verzeichnisses aus dem Repository. Exklusive Sperre auf ein Dokument so, dass kein anderer Benutzer Änderungen vornehmen kann. Freigabe der Sperre auf das Dokument ohne ein Commit der Änderungen. Überschreiben der lokalen Kopie eines Dokuments mit der aktuellen Version des Repositorys. (Undo) Bereinigen von Konflikten durch parallele Updates. (Optimistisches Sperren) Markieren von Konflikten als gelöst. Danach ist ein Commit der Änderungen möglich. Achtung: Dateien im Repository dürfen nicht im Windows Explorer direkt umbenannt werden, sondern immer nur über die TortoiseSVN-Funktion Rename, da sonst die Historie verloren geht! Seite 12

13 Tutorial 7. Änderung eines Dokumentes und Einstellung der neuen Version in das Repository Wie gewohnt: Navigiere mit dem Windows Explorer zu dem zu ändernden Dokument (im Beispiel die Datei HowTo_DocumentRepository.ppt) Öffnen des Dokuments im entsprechenden Editor (hier: PowerPoint). Speichern des Dokuments nach der Änderung Der Status des Dokuments hat sich geändert von nach, um anzuzeigen, dass der Inhalt sich geändert hat. Nur das lokale Dokument hat sich bis dato geändert, noch nicht die Version im Repository. Um die Änderungen ins Repository einzustellen, ist ein Commit der lokalen Dateien nötig. Durch einen Rechtsklick auf die Datei im Explorer wird das Kontextmenü geöffnet. Wähle SVN Übertragen... (Commit) Ein neuer Dialog erscheint, in dem Kommentare zur Änderung gemacht werden können. Der Kommentar sollte auch für andere Benutzer verständlich sein. Änderungen an mehreren Dokumenten können in einem gemeinsamen Commit übertragen werden (innerhalb einer Transaktion). Achtung: Um Konflikte durch paralleles Bearbeiten zu vermeiden, kann eine Sperre vor dem Ändern des Dokuments gesetzt werden (Menupunkt "Sperre holen"). Seite 13

14 Tutorial 8. Aktualisierung des lokalen Arbeitsverzeichnisses - Neue Versionen aus dem Repository holen Holen aller Änderungen aus dem Repository Um alle Änderungen aus dem Repository als lokale Kopie zu holen, gehe auf das oberste Verzeichnis der lokalen Kopie und öffne das Kontextmenü mit der rechten Maustaste. Wähle SVN Aktualisieren zum Übertragen der neuesten Version sämtlicher Dokumente und Verzeichnisse im Repository (nur Änderungen werden übertragen) Änderungen sehen und einzelne Änderungen holen Klicke mit der rechten Maustaste auf ein Verzeichnis in der lokalen Kopie und wähle TortoiseSVN / Prüfe auf Änderungen In dem Dialog klicke auf Prüfe auf Änderungen zum Sehen aller Änderungen im Repository, die derzeit nicht auf der lokalen Kopie sind (Maximiere das Fenster um alle Kommentare zu sehen) Durch Rechtsklick auf ein Dokument/Verzeichnis wird ein Menü geöffnet. Dort SVN Aktualisieren wählen, um die lokale Kopie mit der neuesten Repository-Version zu aktualisieren. Seite 14

15 9. Erzeuge ein neues Dokument oder Verzeichnis und füge es zum Repository hinzu. Tutorial Gehe im Windows Explorer zu dem Verzeichnis, wo ein neues Verzeichnis bzw. Dokument erstellt werden soll. Erzeuge das Verzeichnis oder Dokument (z.b. mit Excel, Word, PowerPoint, Visio) Klicke mit der rechten Maustaste auf das Verzeichnis/Dokument und wähle TortoiseSVN / Hinzufügen Es erscheint ein Dialog, der alle Dokumente/Verzeichnisse zeigt, die dem Repository hinzugefügt werden. Anmerkung: Wird ein Verzeichnis neu hinzugefügt, werden auch rekursiv alle darunter liegenden Dateien zum Repository hinzugefügt. Die neuen Inhalte sind nun mit markiert. Das bedeutet, dass sie mit dem nächsten Commit dem Repository hinzugefügt werden. Die Inhalte können nun per SVN Übertragen dem Repository hinzugefügt werden, oder es können erst weitere Änderungen gemacht werden. Seite 15

16 10. Lösen von Konflikten, die durch paralleles Bearbeiten desselben Dokuments entstanden sind Beim Einstellen von Änderungen kann es passieren, dass gemeldet wird, dass die Datei von einem anderen Benutzer bereits geändert wurde. TortoiseSVN meldet dies, indem es anzeigt, dass bereits eine neuere Version im Repository existiert, welche ein Einchecken verhindert. Führe als Erstes ein SVN Aktualisieren durch. Das Update informiert den Benutzer über den bestehenden Konflikt. Nach dem Update liegen 3 Dateien für eine Datei mit Konflikten vor: filename.ext - die Datei mit den lokalen Änderungen filename.ext.rxx - die Dateiversion vor den lokalen Änderungen (alte Version) filename.ext.ryy - die aktuelle Dateiversion aus dem Repository mit den Änderungen eines anderen Benutzers (neue Version) Nun müssen die Konflikte manuell behoben werden. Danach stelle sicher, dass alle Änderungen und Anpassungen in der Datei filename.ext gespeichert werden. Nach dem Beheben der Konflikte verwende das TortoiseSVN Kontextmenü (rechte Maustaste) und markiere den Konflikt als aufgelöst. Führe ein Commit (SVN Übertragen) auf den Änderungen durch. Tutorial Seite 16

17 11. Exportieren, d.h. Kopieren von Dateien aus dem Arbeitsverzeichnis in ein anderes lokales Verzeichnis auf dem Arbeitsplatz Wie gewohnt: Benutze die Standard Kopierund Einfügemechanismen des Windows Explorers Tutorial Seite 17

18 Tutorial 12. Ältere Versionen eines Dokuments oder Verzeichnisses holen Manchmal ist es notwendig auf ältere Versionen eines Dokuments zurückzugreifen. Für TortoiseSVN ist dies ein Update auf eine definierte Versionsnummer. Wähle im TortoiseSVN-Kontextmenü. Es erscheint ein Dialog, in dem eine Versionsnummer eingegeben oder über die Log- Einträge eine Version ausgewählt werden kann. Achtung! Wenn an einer älteren Version Änderungen vorgenommen werden, wird TortoiseSVN beim Commit einen Konflikt melden. Seite 18

19 Tutorial 13. Verwenden von Log-Einträgen zur besseren Identifikation Über den Log-Browser kann die gesamte Historie zu einem Dokument/Verzeichnis im Repository eingesehen werden. Der Browser besteht aus 3 Abschnitten: Liste der Versionen, Kommentare und Aktionen. Wird ein Eintrag in der Liste ausgewählt, wird der entsprechende Kommentar zu der Version und die Aktion zu dem Dokument/Verzeichnis angezeigt. Durch einen Rechtsklick auf der Aktion wird ein Kontextmenü geöffnet mit dem das Dokument geöffnet werden kann. Wenn der Log-Browser auf dem obersten Verzeichnis geöffnet wird, kann das Log für das gesamte Repository eingesehen werden. Der Log-Browser bietet verschiedene Möglichkeiten, den Inhalt der Versionsliste zu filtern (z.b. Zeitintervall). Der Log-Browser zeigt nur die ersten 100 Einträge. Um die nächsten Einträge zu sehen, klicke auf Seite 19

20 Tutorial 14. Kommunikation von Dokumenten / Ordnern an andere Nutzer Über den Web-Browser-Zugang kann man leicht die URL eines Dokumentes oder Ordners an andere Repository-Benutzer kommunizieren. Hierzu öffnet man den Web-Browser (IE oder Firefox) mit Sicht auf das Repository Nach Navigation zum Dokument / Ordner im Browser kann die URL desselben kopiert und einfach an andere Nutzer weitergegeben werden. Seite 20

21 Agenda Agenda Tutorial Troubleshooting und und FAQ FAQ Weiterführende Informationen Exkurs: Alternativ-Tool zu Tortoise Seite 21

22 Troubleshooting und FAQ Bekannte Probleme von Tortoise SVN. Icons werden nach einer Änderung des Status nicht geändert => Drücke F5 im Windows Explorer (update) Error 502 Bad Gateway => Timeout. In den meisten Fällen hilft hier die Aktion erneut durchzuführen Seite 22

23 Troubleshooting und FAQ Troubleshooting Q: Ich bekomme eine solche Fehlermeldung: A: Der lokale File-Name (inkl. des Pfades) ist zu lang (vermutliche Beschränkung: 255 Zeichen). Entweder muss der Name des Files gekürzt werden oder das lokale Arbeitsverzeichnis muss höher in die Directory-Hierarchie verlegt werden. Q: Ich bekomme eine solche Fehlermeldung: A: Ein Versionskonflikt liegt vor. Vor der durchzuführenden Client-Aktion muss zunächst eine Aktualisierung des Files durchgeführt werden. Seite 23

24 Troubleshooting und FAQ FAQ Q: Werden auch über den Browser-Zugang Berechtigungen abgeprüft? A: Ja. User und Passwort sind diesselben, die auch beim initialen Checkout des Repositories (siehe Folie 16) benutzt werden. Q: Wozu brauche ich den Browser-Zugang, wenn ich doch Tortoise habe? A: Wirklich benötigt wird der Zugang nicht. Er ist jedoch hilfreich, wenn man nur "mal kurz was schauen will"... oder wenn man an andere Repository-User einen Hinweis verschicken will der Art "Neues Dokument XYZ jetzt verfügbar", da man im Browser sehr einfach die URL zum Dokument als eindeutigen Speicherort kopieren kann. Siehe Tutorial-Punkt #14 Q: Brauche ich die lokalen Unterverzeichnisse ".svn", die in meinem Arbeitsverzeichnis überall zu finden sind? A: Ja, diese werden benötigt. Bitte nicht "anfassen"... Seite 24

25 Agenda Agenda Tutorial Troubleshooting und FAQ Weiterführende Informationen Exkurs: Alternativ-Tool zu Tortoise Seite 25

26 Weiterführende Informationen Links für Tortoise SVN und Subversion Homepage TortoiseSVN FAQ Mehrsprachige Dokumentation TortoiseSVN book ase Homepage SubVersion FAQ Versionskontrolle mit SubVersion SubVersion book Seite 26

27 Agenda Agenda Tutorial Troubleshooting und FAQ Weiterführende Informationen Exkurs: Alternativ-Tool zu zu Tortoise Seite 27

28 Exkurs: Alternativ-Tool zu Tortoise Alternativ zu Tortoise SVN kann auch Smart SVN empfohlen werden. Von der Homepage kann der Subversion Client Smart SVN als "Free Foundation Version" heruntergeladen werden. Im Gegensatz zu Tortoise SVN hängt sich Smart SVN nicht in den Windows Explorer / das Kontext-Menu ein, sondern bietet eine eigene Explorer-ähnliche Sicht auf das Dokumenten-Repository. Die Folgefolie zeigt einen Screenshot von SmartSVN mit Blick auf das Dokumenten-Repository. Tortoise SVN und Smart SVN können auch parallel auf dem gleichen lokalen Arbeitsverzeichnis betrieben werden. Seite 28

29 Exkurs: Alternativ-Tool zu Tortoise