Versionskontrolle mit Subversion. Carnot 6.0

Transkript

1 Versionskontrolle mit Subversion Carnot 6.0

2 1 Sourceforge Ordnerstruktur repository-browser Arbeiten mit TortoiseSVN Lokale Arbeitskopie erstellen Dateien hinzufügen / löschen Locking-Mechanismus Branches / tags erstellen Konfliktbehebung Blame-Funktion Patches Metadaten

3 1 Sourceforge Sourceforge ist ein Repository in Form einer Website, welche Programmierern die Möglichkeit bietet, quelloffene Softwareprojekte zu erstellen und zu verwalten. Für die Entwicklung der neuen Carnot-Version wurde hier ein eigenes Projekt angelegt. Für dessen Nutzung müssen sich die Nutzer auf der Website registrieren und sich für den Bereich freischalten lassen. Um in das Projekt zu gelangen, muss das eigene Profil (siehe Abbildung 1) ausgewählt und unter Projects das Projekt Carnot gewählt werden. Abbildung 1: Sourceforge-Profil Unter Account Settings können alle persönlichen Einstellungen vorgenommen werden. Dazu zählt auch die Einstellung über welche Veränderungen im Projekt Benachrichtigungen verschickt werden sollen. Das Projekt Carnot ist dabei in unterschiedliche Reiter aufgeteilt: Summary (Zusammenfassung des Projekts) Files (Abgelegte Dateien: to-do-liste, Anleitung) Reviews (Raum für Bewertungen) Support (Sourceforge-Support) SVN (repository-browser des Projekts) Discussion (Foren zur Diskussion verschiedener Themen) Tickets (Aufgabenverteilung mit Stand der Bearbeitung; ob damit gearbeitet werden soll, muss noch diskutiert werden) 3

4 1.1 Ordnerstruktur repository-browser Der repository-browser ist der Ablageort für alle Projektdateien und deren Versionen. Hier erfolgt die Versionierung des Projekts in Form einer einfachen Revisionszählung automatisch. Jede vorgenommene und hochgeladene Änderung wird dabei als Revision bezeichnet und erhält eine fortlaufende Nummer. Bei jedem Commit (Hochladen von Änderungen) werden dabei nur die Unterschiede zur Version auf dem Server hochgeladen. Der repository Browser weist eine ganz bestimmte Ordnerstruktur auf: trunk: Hauptort der Arbeit; hier werden alle Dateioperationen, Veränderungen an Dateien und dergleichen durchgeführt branches: separates Ablegen der branches, d.h. alternativen Entwicklungspfaden; die Versionierung erfolgt hier unabhängig vom trunk tags: beinhaltet exakte, fixe Versionsstände, die nicht mehr verändert werden und für releases genutzt werden 2 Arbeiten mit TortoiseSVN TortoiseSVN ist ein freier Client für die Versionsverwaltung mit Subversion. Die Versionskontrolle ist zwar auch mit Hilfe der Windows-Kommandozeile möglich, jedoch erleichtert der Client mit seiner grafischen Oberfläche diese Arbeit enorm. Aus diesem Grund empfiehlt es sich, TortoiseSVN zu installieren. In Abbildung 2 sind die Funktionen des Tools dargestellt. Auf einzelne Funktionen wird dabei im weiteren Verlauf dieser Dokumentation eingegangen. 4

5 Abbildung 2: Funktionen von TortoiseSVN Wichtige Funktionen sind vor allem der Befehl Show log, mit dem alle Commits mit Kommentaren angezeigt werden und der Befehl Repo-browser, der den gesamten repository-browser anzeigt. Wurde eine Datei im Laufe des Projektes verändert, wird hier zusätzlich noch die Funktion Diff with previous version angeboten. Dadurch werden die Änderungen zwischen zwei Revisionen angezeigt. 2.1 Lokale Arbeitskopie erstellen Um im Projektordner arbeiten zu können, muss zunächst eine aktuelle Arbeitsversion auf der Festplatte abgelegt werden. Dabei kann der gesamte repository-browser oder nur der Unterordner trunk als Arbeitsordner benutzt werden. Um diese Arbeitskopie auf der Festplatte zu erzeugen, muss zunächst ein leerer Ordner an gewünschter Stelle erstellt werden. Nach erfolgreicher Installation von TortoiseSVN, bietet der Client durch Rechtsklick auf den Ordner die Option SVN Checkout an. 5

6 URL-Einstellung Unterordner z.b. trunk auswählen Auswahl der Revisionsnummer Abbildung 3: SVN Checkout Durch Auswählen dieser Option öffnet sich das in der Abbildung zu erkennende Einstellungsfenster. Hier müssen die URL vom Sourceforge-Server des repositorybrowsers ( und die Revisionsnummer (HEAD revision = aktuelle Version) spezifiziert werden. Des Weiteren können über den Button Choose items einzelne Dateien oder Unterordner ausgewählt werden. Bei der Verbindung zum Server muss der Benutzername und das Passwort der Seite Sourceforge eingegeben werden. Hier bietet es sich an, die Eingaben zu speichern, damit sie nicht bei jedem Verbindungsaufbau zum Server erneut eingegeben werden müssen. Durch den checkout des repository-browsers bzw. des trunks werden alle Inhalte des Projektordners lokal gespeichert. Die Symboliken auf den Dateien kennzeichnen die Aktualität dieser Daten. Liegen keine Unterschiede zur Version auf dem Server vor, werden die Dateien mit einem grünen Hacken gekennzeichnet. Anderenfalls deutet ein rotes Ausrufezeichen auf Modifikationen hin. Des Weiteren werden durch den checkout weitere SVN-Optionen freigeschaltet. Zu beachten ist, dass nur im Hauptarbeitsordner trunk gearbeitet wird. Damit immer mit der aktuellsten Version gearbeitet wird, muss der erstellte Arbeitsordner regelmäßig aktualisiert werden. Hierfür stellt TortoiseSVN die Funktion SVN Update (Rechtsklick auf den Dateiordner) zur Verfügung (siehe Abbildung 4). 6

7 Abbildung 4: TortoiseSVN Grundfunktionen Nach Änderungen im Projektordner müssen diese auf den Server geladen werden. Hierfür dient die Funktion SVN Commit. Bei jedem Commit müssen die vorgenommenen Änderungen kommentiert werden (siehe Abbildung 5). Dies dient einer besseren Übersicht über den Entwicklungsprozess. Kommentar über Änderung Abbildung 5: Commit kommentieren Dabei erhält jeder durchgeführte Commit eine neue Revisionsnummer mit allen Änderungskommentaren. 7

8 2.2 Dateien hinzufügen / löschen Um Dateien dem Projektordner hinzuzufügen, werden sie zunächst einfach an die entsprechende Stelle im Ordner kopiert. Dadurch stehen sie allerdings noch nicht unter Versionskontrolle. Dafür ist es notwendig, jede hinzugefügte Datei dem repository-browser hinzuzufügen. Im Menü von TortoiseSVN (Rechtsklick auf hinzuzufügende Datei) steht hierfür die Funktion Add bereit (siehe Abbildung 2). Um Dateien zu löschen, wird die Delete-Funktion von TortoiseSVN benutzt. Nach dem Hinzufügen oder Löschen von Dateien muss der neue Versionstand durch einen Commit hochgeladen werden. 2.3 Locking-Mechanismus Um das gleichzeitige Arbeiten am Projekt zu erleichtern, bietet SVN die Möglichkeit, Dateien zu sperren. Diese Sperrung ist unmittelbar für jeden sichtbar und bedarf keines Commits. Durch die Sperrung einer Datei können andere Nutzer diese Datei nicht bearbeiten, d.h. ein Commit von Änderungen ist nur bedingt möglich. Bei dem Versuch Änderungen hochzuladen wird der Nutzer auf die Sperre eines anderen Nutzers hingewiesen. Die Sperre kann allerdings aufgehoben werden, wenn sie als überflüssig erachtet wird bzw. wenn der andere vergessen hat die Sperre nach der Bearbeitung wieder aufzuheben. Dies bedarf allerdings der Kommunikation zwischen den verschiedenen Bearbeitern. Um eine Datei zu sperren, wird die Funktion Get lock von TortoiseSVN benutzt (siehe Abbildung 2). Bei der Sperrung einer Datei ist die Angabe eines Grunds für die Sperrung zwingend erforderlich, damit andere Nutzer die Sperrung nachvollziehen können. Üblich ist es, hier einen Zeitraum für die Sperrung mit anzugeben. 8

9 Grund und Zeitraum der Sperrung Gesperrte Datei Force-Funktion Abbildung 6: Get-Lock Eine Sperre kann, wie bereits erwähnt, aufgehoben werden. Hierfür dient die Force- Funktion von TortoiseSVN (siehe Abbildung 6). Damit wird die Sperre eines anderen Users durch die eigene überschrieben. Diese Funktion sollte aber nur in Absprache mit den anderen Nutzern bzw. aus einem triftigen Grund verwendet werden. 2.4 Branches / tags erstellen Branches und tags sind in Subversion nur eigene Ordner. Das bedeutet, zu einem bestimmten Zeitpunkt wird der aktuelle Arbeitsordner (trunk) in einen eigenen spezifischen Ordner der beiden Unterordner kopiert. Dieser Vorgang findet nur im repository-browser statt, d.h. die Kopie des Arbeitsordners wird hier erstellt und abgelegt. Bei der Benennung der Unterordner sind Namenskonventionen festzulegen. Um einen branch bzw. tag zu erstellen, wird die Verzweigungs-Funktion (Branch/tag) von TortoiseSVN benutzt (siehe Abbildung 2). Beim Anlegen dieser Kopie müssen Urpungs- und Zielort spezifiziert, der Vorgang kommentiert und die zu kopierende Revison ausgewählt werden (siehe Abbildung 7). 9

10 Ursprungsort Zielort über repository-browser auswählen Vorgang kommentieren Revision auswählen Abbildung 7: Branch / tag erstellen Um mit dem erstellten branch / tag arbeiten zu können, ist es notwendig, einen Switch durchzuführen. Das bedeutet, der aktuelle Arbeitsordner wird auf einen anderen Arbeitsordner im repository-browser umgestellt. Bei einem tag ist allerdings darauf zu achten, dass dieser nach der Erstellung nicht mehr verändert werden darf, da er einen fixen Stand des Projektes widerspiegelt. Zielort über repository-browser auswählen Revision auswählen Abbildung 8: Switch-Befehl 10

11 2.5 Konfliktbehebung Durch das Arbeiten vieler verschiedener Leute an einem Projekt, können leicht Konflikte bei der Bearbeitung von Dateien entstehen. Durch die stetige Weiterentwicklung des Projekts muss die lokale Arbeitskopie regelmäßig aktualisiert werden (SVN update). Wenn mehrere Personen an der gleichen Datei arbeiten, können beim Update bzw. beim Commit Fehler (siehe Abbildung 9) auftreten. In solch einem Fall muss eine Konfliktbehebung durchgeführt werden. Abbildung 9: Konflikt beim Hochladen Durch Bestätigung mit OK öffnet sich das in Abbildung 10 gezeigte Fenster. Abbildung 10: Konfliktbehebung Durch Auswählen der Update-Funktion wird die lokale Arbeitskopie durch die aus dem repository-browser ersetzt. Dabei weist TortoiseSVN darauf hin, dass die veränderte Datei einen Konflikt aufweist (siehe Abbildung 11): 11

12 Abbildung 11: Konflikt beim Update Durch Bestätigen mit OK kann der Konflikt behoben werden. Dabei bietet TortoiseSVN verschiedene Möglichkeiten an die Konflikte zu lösen (siehe Abbildung 12). Durch das Update werden drei zusätzliche, temporäre Dateien erzeugt und im entsprechenden Ordner abgelegt. Diese können mit einem Texteditor geöffnet und verändert werden. Konflikt wurde manuell gelöst Meine Version übernehmen Konfliktdetails ansehen und bearbeiten Andere Version übernehmen Abbildung 12: Konfliktlösung 12

13 Die unterschiedlichen Möglichkeiten der Konfliktlösung sind: 1. Manuelle Bearbeitung der Datei mit anschließendem Klicken auf Resolved 2. Übernehmen der anderen Version 3. Übernehmen der eigenen Version 4. Änderungen mit TortoiseMerge anzeigen lassen und dort bearbeiten und Konflikt lösen Die vierte Möglichkeit der Konfliktlösung ist, wenn keine der beiden Versionen stimmt, die beste. Dabei werden beide Versionen gleichzeitig geöffnet und Unterschiede an den entsprechenden Stellen gekennzeichnet (siehe Abbildung 13). Das funktioniert allerdings nur für Textdokumente wie z.b. Sourcecode. Abbildung 13: TortoiseMerge Durch diese Konfliktlösungsmethoden wird der Commit möglich und die Revision im repository-browser wird aktualisiert. 2.6 Blame-Funktion Die Blame-Funktion (siehe Abbildung 2) dient dazu, herauszufinden wer welche Änderungen vorgenommen hat. Das ist vor allem dann wichtig, wenn viele Personen dieselbe Datei bearbeiten und sich dadurch viele verschiedene Änderungen ergeben. 13

14 Bei der Blame-Funktion kann spezifiziert werden, seit welcher und bis zu welcher Revision die Änderungen angezeigt werden sollen (siehe Abbildung 14). Anfangsrevision Endrevision Abbildung 14: Blame-Funktion Dadurch wird für jede Zeile im Textdokument ein Kommentar mit Änderungszeitpunkt (Revisionsnummer) und Änderungsverantwortlichem eingefügt. 2.7 Patches TortoiseSVN bietet die Möglichkeit, Patches zu erstellen. Dabei handelt es sich um eine Sammlung von Änderungen im lokalen Arbeitsordner, komprimiert in eine Datei, die von anderen Personen auf deren Arbeitsordner angewendet werden kann. Vorteil bei dieser Vorgehensweise ist, dass der Weg über den repository-browser übersprungen wird und nur ein Paket von Änderungen an die jeweiligen Nutzer übergeben werden kann. Hierfür wird der Befehl Create patch (siehe Abbildung 2) benutzt. Dabei wird automatisch erkannt welche Änderungen in welchen Dateien vorgenommen wurden. Bei der Erstellung des Patches werden die vorgenommenen Änderungen nochmals angezeigt. Um einen Patch im eigenen Ordner zu übernehmen, wird der Befehl Apply patch von TortoiseSVN benutzt. Dabei öffnet sich der Dialog File Patches in dem der Befehl Patch all items ausgewählt werden muss, damit alle Änderungen übernommen werden. Auch hierbei werden die vorgenommenen Änderungen angezeigt. 14

15 2.8 Metadaten Metadaten sind Daten über Dateien. Diese bieten die Möglichkeit, verschiedene Informationen für diese Datei (z.b. Fälligkeit oder Priorität) zusätzlich zu hinterlegen und zu versionieren. Diese Metadaten können mit Hilfe von TortoiseSVN einfach über den Befehl Properties (siehe Abbildung 2) angelegt werden. Dadurch öffnet sich der in Abbildung 15 gezeigte Dialog. Neuen Eintrag anlegen und Kategorie auswählen Abbildung 15: Metadaten anlegen Beim Anlegen einer neuen Metadatei müssen der Name und der entsprechende Wert eingetragen werden. Durch einen Commit muss diese Änderung hochgeladen werden. 15