SVN-Tutorial für WEBMM7

Transkript

1 SVN-Tutorial für WEBMM7 SVN-Tutorial für WEBMM Einleitung... 2 Grundprinzip von CVS... 2 Was ist Subversion?... 2 Unterschiede Subversion/CVS... 2 SmartSVN... 3 Installation / Einrichtung... 3 Update...10 Add...11 Commit...12 Geänderte Dateien...13 Remove...14 Compare...14 Rename/Copy/Move...16 Lock/Unlock...17 Log...18

2 Einleitung Auf dieser Seite wird für diejenigen, die sich unter CVS überhaupt nichts vorstellen können, kurz das Grundprinzip von CVS beschrieben. Außerdem wird Subversion kurz vorgestellt. Alle anderen können gleich ans Eingemachte, sprich zur Seite 2 gehen. Grundprinzip von CVS CVS (Concurrent Versions System) ist ein Tool zur Versionsverwaltung. Es ermöglicht Mitarbeitern eines Software-Projekts gemeinsam an Dateien (Quellcode) zu arbeiten und koordiniert dabei die Arbeiten der verschiedenen Entwickler. Einzelne Dateien können z.b. jederzeit verändert werden, es bleiben jedoch alle früheren Versionen erhalten, einsehbar und auch wiederherstellbar. Ebenso können die Unterschiede zwischen bestimmten Versionen verglichen werden. Alle Änderungen und Vorgänge werden dabei von CVS protokolliert und von den Mitarbeitern kommentiert. Um all dies zu ermöglichen, werden sämtliche Dateien eines Projekts an einer zentralen Stelle ( Repository ) gespeichert. Die Mitarbeiter des Projekts arbeiten nun mit lokalen Kopien dieser Dateien. Dazu holt man sich zunächst den aktuellen Stand aus dem Repository. Diesen Vorgang nennt man Check Out. Nun kann ein Mitarbeiter die für ihn relevanten Dateien lokal verändern, also z.b. neuen Quellcode hinzufügen oder vorhandenen Code verändern. Hat er einen neuen Entwicklungsstand erreicht, spielt er die neuen Versionen zurück ins Repository ( Check In ). Somit stehen die neuen Versionen allen anderen Mitarbeitern sofort zur Verfügung. Konflikte entstehen nun, wenn mehrere Mitarbeiter an ein und derselben Datei gleichzeitig arbeiten. Hier hilft CVS, indem es ermöglicht, einzelne Dateien vorübergehend für andere Mitarbeiter zu sperren ( Lock ) oder im Nachhinein alle Änderungen an der Datei zusammenzuführen ( Merge ). Das Zusammenführen funktioniert automatisch, außer wenn zwei Mitarbeiter an denselben Stellen (Textzeilen) gearbeitet haben. Dann müssen die Versionskonflikte von Hand behoben werden. Was ist Subversion? Subversion wird oft als Nachfolger von CVS bezeichnet, da bei seiner Entwicklung versucht wurde, die Schwächen von CVS zu beseitigen. Das Grundprinzip, sowie die Grundbefehle sind dabei weitestgehend identisch mit denen von CVS. Unterschiede Subversion/CVS Mit Subversion können nun Dateien und Verzeichnisse auch umbenannt oder verschoben werden (bei CVS war dies nur über einen Umweg möglich). Subversion erkennt und überträgt zudem bei neuen Versionen nur die geänderten Bereiche einer Datei und unterstützt dabei auch Binärdateien, also z.b. Bilder und Audiodateien. Das Versionsschema von Subversion bezieht sich nun auf das gesamte Repository und nicht mehr auf einzelne Dateien. Die Revisionsnummer einer Datei entspricht dabei der Revisionsnummer des Repositorys, als sie das letzte Mal geändert wurde. Die Revisionsnummer eines Verzeichnisses entspricht der höchsten Revisionsnummer der enthaltenen Dateien und Verzeichnisse. Subversion unterstützt auch so genannte atomare Commits, d.h. ein Commit wird entweder vollständig oder gar nicht ausgeführt. Bei Verbindungsabbrüchen entstehen somit keine unvollständigen Revisionen.

3 SmartSVN SmartSVN ist eine grafische Benutzeroberfläche für Subversion. Es funktioniert ähnlich einem Dateibrowser, mit dem man seine lokalen Dateien mit dem Repository abgleichen kann. Installation / Einrichtung Zunächst lädt man sich die Installationsdatei von runter. Hier findet man Versionen für Windows und für den Mac. Die Installation (auf Windows) funktioniert wie man es gewohnt ist, sprich Installations-Verzeichnis wählen und immer schön Next > klicken: Nach erfolgreicher Installation startet man das Programm mit dem Icon auf dem Desktop und erhält zunächst mal folgendes Fenster, in dem man den ersten Punkt auswählt:

4 Nach einem Klick auf OK kommen verschiedene Eingabemasken, mit denen man sich ein Projekt einrichtet. Das sollte zunächst folgendermaßen aussehen: Man klickt nun auf Manage, um seine Profile zu verwalten:

5 Mit dem Befehl Add kann man nun ein neues Profil erstellen, was dann so aussehen sollte: Bitte darauf achten oben Https auszuwählen und bei den Login-Daten natürlich eure eigene RZ- Kennung einzugeben. Als Profil-Name kann man eingeben was man möchte. Sollte natürlich einigermaßen sinnvoll sein Mit Verify connection kann man seine Einstellungen gleich mal prüfen lassen (falls man gerade mit dem Internet verbunden ist). Es erscheint folgendes Fenster, das man mit OK schließt: Darauf folgt:

6 Und bei erfolgreicher Verbindung muss man noch den Server-Fingerprint akzeptieren: Hat alles funktioniert, hat man nun ein neues Repository eingerichtet: Man schließt dieses Fenster nun mit OK und befindet sich zurück im Eingangsdialog (siehe Seite 3). Das neue Profil ist bereits ausgewählt, also klickt man auf Next > :

7 Daraufhin wird von SmartSVN die Verzeichnisstruktur vom Entwicklungsserver gelesen und folgendermaßen angezeigt: HEAD bedeutet dabei die aktuellste Revision. Über Filter Revisions könnte man auch frühere Revisionen auschecken, was aber in unserem Fall zunächst keinen Sinn macht. Also weiter mit Next> : Hier wählt man nun sein lokales Verzeichnis aus, in das man die Dateien auschecken will. Dies ist somit gleichzeitig euer Arbeitsverzeichnis, in meinem Fall D:\Daten\FHA\PA2\WEBMM7_Redaktion. Wie Benjamin bereits beschrieben hat, wählt man am Besten zunächst ein leeres Verzeichnis aus, in das man später seine bereits vorhandenen Dateien kopiert. Weiter mit Next > :

8 Hier kann man dem Projekt einen Namen geben und zur Liste hinzufügen. Noch ein weiteres Next> und man sieht eine Zusammenfassung der bisherigen Einstellungen: Jetzt aber genug und mit nach einem Klick auf Finish werden die Dateien und Verzeichnisse vom Server in euer lokales Verzeichnis kopiert. Was dann zunächst folgendermaßen aussieht:

9 In der linken Spalte sieht man die Ordnerstruktur, rechts die im ausgewählten Ordner enthaltenen Dateien. Im unteren Bereich werden verschiedene Log-Informationen ausgegeben, z.b. dass beim letzten Check-Out sechs Verzeichnisse dazugefügt wurden (siehe links unten). Nun ist alles fertig eingerichtet und man kann sich an die Arbeit machen, sprich seine Dateien lokal bearbeiten und mit dem Repository abgleichen. Wie das funktioniert, werde ich auf den nächsten Seiten kurz beschreiben. Dazu verwende ich jedoch nicht den Entwicklungsserver, sondern richte mir ein neues Projekt Test_SVN ein. Dazu einfach SmartSVN schließen und neu starten und wieder Check out project from repository wählen. Alles weitere funktioniert dann genauso wie oben für den Entwicklungsserver beschrieben, außer dass ich im neuen Repository-Profil als Repository-Pfad statt /entwicklung den Ordner /public_mm angebe und als lokales Arbeitsverzeichnis ebenfalls ein Testverzeichnis nehme. In Zukunft kann man beim Start von SmartSVN dann übrigens auswählen, welches Projekt man bearbeiten möchte:

10 Ich wähle nun das Test-Projekt und befinde mich anschließend auf dem Hauptbildschirm von SmartSVN: Wie man sieht sind bereits einige Testdateien im Repository vorhanden. Zu jeder Datei werden ausführliche Informationen angezeigt, z.b. die aktuelle Revision der Datei, ob die Datei gesperrt ist (Lock), wann sie zum letzten Mal commited wurde oder wer zuletzt daran gearbeitet hat (Author). Update Bei jedem Start von SmartSVN sollte man sich zunächst einmal die aktuellen Versionen der Dateien aus dem Repository laden. Hierzu wählt man entweder in der linken Spalte das Root-Verzeichnis oder ein Unterverzeichnis aus oder man selektiert im rechten Bereich einzelne Dateien. Anschließend klickt man mit der rechten Maustaste darauf und wählt Update (oder man drückt einfach Strg+U): Hier kann man nun auswählen, ob man die neueste Version der Datei holen möchte (HEAD) oder ob man zu einer bestimmten Revision zurückkehren möchte. Mit OK werden die Dateien aktualisiert. Das Ergebnis des Vorgangs wird im Output-Fenster links unten ausgegeben. Ein Update ist übrigens auch dann empfehlenswert, wenn man Dateien bearbeiten möchte. So ist man sicher, die aktuellste Version der Datei zu bearbeiten und vermeidet unnötige Versionskonflikte.

11 Add Mit dem Add-Befehl können neue Dateien zum Repository hinzugefügt werden. Dazu kopiert man die Dateien einfach an die gewünschte Stelle in sein Arbeitsverzeichnis (lokal). Dies macht man nicht mit SmartSVN, sondern wie gewohnt mit dem Windows Explorer oder beim Mac dem Finder. Man kann natürlich auch einfach eine neue Datei im Arbeitsverzeichnis erstellen: Kehrt man nun zu SmartSVN zurück, merkt dies automatisch, dass eine neue Datei hinzugefügt wurde und markiert diese mit einem entsprechenden Symbol: Möchte man diese Datei nun zur Versionskontrolle hinzufügen, klickt man sie mit der rechten Maustaste an und wählt Add. Alternativ drückt man Strg und + auf dem Nummernblock:

12 Die Datei wurde nun hinzugefügt: Commit Da bei CVS/Subversion jede Veränderung an den lokalen Daten mit einem Commit abgeschlossen werden muss, ist die Datei nach dem Hinzufügen noch nicht sofort im Repository verfügbar. Es könnte ja sein, dass man die Datei zuvor noch bearbeiten möchte. Um die Datei endgültig zum Repository hinzuzufügen, wählt man den Befehl Commit (rechte Maustaste auf Datei):

13 Hier gibt man nun bei Commit Message die Begründung ein, warum man die Datei hinzugefügt oder verändert hat. Dies ist wichtig, damit die anderen Mitarbeiter nachvollziehen können, was mit den Dateien im Repository geschieht. Nun klickt man auf Next > und erhält folgenden Dialog: Hier bestätigt man noch mal, dass man die Datei committen, in diesem Fall also zum Repository hinzufügen möchte. Was übrigens für einzelne Dateien funktioniert, funktioniert genauso gut auch für ganze Verzeichnisse, außer dass man hier noch auswählen kann, ob man rekursiv alle Unterverzeichnisse ebenfalls hinzufügen möchte: Beim Commit werden dann auch alle Unterverzeichnisse und Dateien hinzugefügt und stehen ab sofort allen anderen Mitarbeitern des Projekts zur Verfügung: Geänderte Dateien Wie bereits im Grundprinzip auf Seite 1 beschrieben, werden bei CVS/SVN die Dateien wie gewohnt lokal bearbeitet. Erst wenn man denkt, einen nächsten Entwicklungsschritt erreicht zu haben, der auch den anderen Mitarbeitern zur Verfügung stehen sollte, lädt man die geänderten Dateien ins

14 Repository. Dies nennt man einen COMMIT. Jegliche Änderungen an Dateien, was auch Umbenennen, Löschen oder Hinzufügen (wie bereits oben beschrieben) von Dateien beinhaltet, müssen bei CVS/SVN mit einem COMMIT abgeschlossen werden. Erst dann stehen die geänderten Daten im Repository zur Verfügung. Angenommen, wir bearbeiten die Datei Datei1.txt. Dies kann mit einem beliebigen externen Editor geschehen. Kehrt man nun zu SmartSVN zurück, merkt das Programm, dass die Datei geändert wurde und markiert diese als Modified : Möchte man diese Datei nun ins Repository laden, wählt man wieder den Befehl Commit. Die geänderte Datei wird nun hochgeladen und erhält eine neue Revisions-Nummer. Remove Hinzugefügte Dateien kann man mit dem Befehl Remove und einem anschließenden COMMIT auch wieder entfernen. Aber Achtung: Die Dateien werden dann auch lokal aus eurem Arbeitsverzeichnis gelöscht. Möchte man die gelöschten Dateien wiederherstellen, kann man das Verzeichnis, das die Dateien enthielt, zu einer früheren Revision zurückführen. Dazu klickt an im Verzeichnisfenster links das entsprechende Verzeichnis mit der rechten Maustaste an, wählt Update und gibt eine frühere Revision als die aktuelle ein. Also z.b. Dadurch wird das gesamte Verzeichnis (lokal) zu dieser Revision zurückgeführt. Und mit etwas Glück enthält die Revision auch die versehentlich gelöschte Datei, d.h. die Datei ist nun lokal wieder verfügbar. Jetzt kann man diese Datei an einen temporären Ordner verschieben (mit dem Windows Explorer), dann in SmartSVN das Verzeichnis wieder zur aktuellsten Revision updaten (Datei ist wieder weg und alles auf dem neuesten Stand), die Datei anschließend wieder ins Arbeitsverzeichnis kopieren und neu hinzufügen (siehe Add). Dadurch enthält die neueste Revision des Repositorys auch wieder diese Datei. Dies ist etwas umständlich, aber ich habe leider noch keinen anderen Weg in SmartSVN gefunden. Also am besten vorher prüfen, was man löscht. Compare Mit dem Compare-Befehl kann man sich die Unterschiede zwischen lokaler Kopie und der Version im Repository anzeigen lassen. Dies sieht beispielsweise folgendermaßen aus:

15 Links sieht man die Datei aus dem repository und rechts die lokale Kopie. In diesem Fall wurde lokal die Zeile 3 bearbeitet. Wenn man möchte kann man die Änderungen einzeln wieder rückgängig machen. Dazu wählt man die Zeile aus und wählt Take left block.

16 Rename/Copy/Move Möchte man Dateien umbenenen, kopieren oder verschieben, sollte man dies mit SmartSVN und nicht mit dem Windows Explorer machen. Dadurch stellt man sicher, dass z.b. ein Umbenenen auch als solches erkannt wird. Ansonsten kann es passieren, dass SmartSVN meint, dass die Datei nicht umbenannt wurde, sondern dass eine Datei gelöscht wurde und eine neue Datei hinzugefügt wurde oder es sonst zu irgendwelchen Unstimmigkeiten kommt. Umbenennen mit SmartSVN geht ganz einfach. Dazu die Datei auswählen, F2 drücken und den neuen Namen eingeben: SmartSVN erstellt dann eine Kopie der Datei mit dem neuen Dateinamen und markiert die alte Datei als Removed : Ein COMMIT beider Dateien führt die Änderungen dann auch im Repository durch. Ein Verschieben oder Kopieren einer Datei funktioniert ähnlich, außer dass man hier noch ein neues Verzeichnis auswählen kann:

17 Lock/Unlock Manchmal ist es sinnvoll, Dateien vor dem Bearbeiten für andere Mitarbeiter zu sperren. Dadurch vermeidet man, dass andere Mitarbeiter an diesen Dateien ebenfalls Änderungen durchführen und es so u.u. zu Versionskonflikten kommt. In SmartSVN kann man wie bei allen anderen Befehlen die entsprechenden Dateien selektieren und mit dem Befehl Lock sperren. Dies geschieht übrigens bei SmartSVN nicht über das Kontextmenü (rechte Maustaste), sondern über diese Symbole: Es erscheint daraufhin folgender Dialog: Hier gibt man einen sinnvollen Grund für die Sperre ein. Nach Klick auf OK ist die Datei sofort gesperrt und zwar solange, bis man sie durch einen entsprechenden Unlock-Befehl wieder freigibt oder die Datei committet. Bei einem COMMIT kann man angeben, ob die Sperre beibehalten werden soll ( Keep locks ): Dann ist die Datei auch nach dem COMMIT noch gesperrt und muss manuell mit Unlock freigegeben werden:

18 Log Es ist auch möglich, sich einen Log-Bericht aller Änderungen in einem bestimmten Zeitraum für eine Datei anzeigen zu lassen. Dazu wählt man im Kontextmenü den Befehl Log oder man drückt Strg+L: Daraufhin werden für den gewählten Zeitraum alle Änderungen folgendermaßen ausgegeben: Man kann dann in der linken Spalte eine Revision auswählen und sieht in der rechten Spalte die entsprechende Meldung, wieso diese Änderung ausgeführt wurde. Natürlich nur dann, wenn die Mitarbeiter auch einen entsprechenden Kommentar eingegeben haben.