15.7 Versionsverwaltung mit Bazaar

15.7.1 Was ist Bazaar?

Bazaar (http://bazaar-vcs.org/) ist ein frei verfügbares dezentrales Versionsverwaltungssystem und eine Implementierung des GNU Arch-Protokolls. Es besteht eine enge Zusammenarbeit zwischen dem Team rund um Bazaar und der GNU Arch-Community.

Bazaar verfolgt einen etwas anderen Ansatz als andere Versionskontrollen: Jede Revision, d. h. Änderung am Quelltext, ist eindeutig identifizierbar. Dadurch sind Zusammenführungen von an sich komplett ungleichartigen Quellcodebäumen möglich. Die Website Launchpad bietet einen kostenlosen Hosting-Dienst für Bazaar-Projekte im Bereich Open Source an.

Bazaar wird zurzeit (Stand: Juni 2008) hauptsächlich für die Entwicklung von Ubuntu und Launchpad (siehe Abschnitt auf Seite ) eingesetzt, steht aber selbstverständlich auch anderen freien Softwareprojekten zur Verfügung. Auch Sie können bei einer Zusammarbeit von mehreren Benutzern von den Möglichkeiten einer Versionsverwaltung profitieren. Im Februar 2008 wurde Bazaar ein offizielles GNU-Projekt und hat damit den offiziellen Segen von Richard Stallman erhalten. Es ist erhältlich für die Plattformen Windows, GNU/Linux und Mac OS. Canonical bietet offiziellen und kostenpflichtigen Support für Bazaar an. In Abschnitt auf Seite haben Sie bereits mehr über GNU erfahren.

Was ist eine Versionsverwaltung?

Unter einer Versionsverwaltung versteht man ein System, welches zur Versionierung und zur Kontrolle bei gemeinsamen Zugriffen auf Dateien eingesetzt wird. Hierzu müssen alle laufenden Änderungen erfasst und alle Versionsstände der Dateien in einem Repository mit Zeitangabe und Benutzerkennung gespeichert werden. Eine solche Versionsverwaltung ist die essentielle Grundlage für ein Content Management System. Die Benutzer können entweder mit dem aktuellen Stand einer Datei arbeiten oder auf Wunsch auf die archivierten Stände zurückgreifen. Diese Funktion macht eine Versionsverwaltung nicht nur für Benutzer in Teams, sondern auch für einzelne Entwickler interessant. Auf diese Weise kann jederzeit eine ältere Version aufgerufen werden, falls eine Änderung nicht funktioniert oder der Benutzer nicht mehr sicher ist, was nun alles geändert wurde.

Ein Beispiel ist die Wikipedia. Hier erzeugt die Software nach jeder Änderung eines Artikels eine neue Version. Da zu jedem Versionswechsel die grundlegenden Angaben wie Verfasser und Uhrzeit festgehalten werden, kann jeder genau nachvollziehen, wer was wann geändert hat. Bei Bedarf – beispielsweise bei versehentlichen Änderungen – kann zu einer früheren Version zurückgekehrt werden. Es wird sichergestellt, dass jeder Benutzer mit dem aktuellen Stand arbeitet oder auf Wunsch auf die archivierten Stände zugreifen kann. Dadurch ist eine Versionsverwaltung nicht nur für professionelle Entwickler in großen Teams, sondern auch für einzelne Entwickler interessant.

Das zentrale Archiv wird als »Repository« (engl. für Behälter, Aufbewahrungsort) bezeichnet.

Server – ja oder nein?

GNU arch operiert dezentral, folglich gibt es keine Notwendigkeit für einen zentralen Server mit getrennter Benutzerverwaltung gibt. Allerdings unterstützt Bazaar sowohl den Ansatz mit als auch den ohne zentralen Server. Es ist darüber hinaus möglich, beide Ansätze gleichzeitig bei einem Projekt anzuwenden.

Installation

Bazaar ist selbstverständlich über die Repositorys von Ubuntu erhältlich. Sie installieren die nötigen Pakete mittels

sudo apt-get install bzr bzr-gtk

Das Paket bzr-gtk stellt olive, eine optionale grafische Oberfläche für Bazaar zur Verfügung (siehe Abbildung).

15.7.2 Ein erstes kleines Projekt

Bevor Sie mit der grafischen Oberfläche von Bazaar arbeiten können, müssen Sie einige Angaben im Terminal erledigen.

Kennung erstellen

Eine grundlegende Aufgabe eines Versionsverwaltungssystems ist die Möglichkeit zur Zusammenarbeit mehrerer Projektteilnehmer. Um vorgenommene Änderungen am Projekt einzelnen Mitgliedern dieser Gruppe zuordnen zu können, muss Bazaar mitgeteilt werden, wer an dem Projekt arbeitet.

Der erste Schritt besteht also darin, dass Sie sich Bazaar einmal persönlich vorstellen und dem Programm Ihren Namen und Ihre E-Mail-Adresse verraten.

Dies geschieht durch das Kommando

bzr whoami "Marcus Fischer bzr@marcus-fischer.com"

Bitte achten Sie darauf, dass Sie auch wirklich die Anführungszeichen verwenden. Ansonsten meldet sich Bazaar mit einem Fehler.

Bazaar richtet jetzt eine Konfigurationsdatei ein, in der Ihr Name und Ihre E-Mail-Adresse vorhanden ist. Um die Korrektheit Ihrer Daten zu überprüfen, können Sie mit

bzr whoami 
Marcus Fischer bzr@marcus-fischer.com

die vorhandenen Angaben überprüfen.

Projekt auswählen

Erstellen Sie nun ein Verzeichnis, das als Heimat Ihres Projektes dienen soll und füllen es mit den Dateien, die von Bazaar verwaltet werden sollen. In diesem Beispiel lege ich mit dem Befehl touch einige (leere) Textdokumente an.

mkdir Projekt 
cd Projekt 
touch test1.txt test2.txt test3.txt

Bazaar weiß an dieser Stelle natürlich noch nicht, dass es für dieses Verzeichnis zuständig ist, bzw. dieses überwachen soll. Zu diesem Zweck müssen Sie Bazaar in diesem Verzeichnis initialisieren. Achten Sie bei der Initialisierung darauf, dass Sie sich im Terminal wirklich in dem gewählten Verzeichnis befinden!

Sie erreichen die Initialisierung mittels

bzr init

Wundern Sie sich nicht, wenn der Befehl keine Antwort erzeugt. Da es sich Bazaar um ein offizielles GNU-Projekt handelt, folgt es auch den Prinzipien von GNU. Dies bedeutet unter anderem, dass bei der erfolgreichen Ausführung eines Befehls keine Rückmeldung erfolgt. Nur Fehler führen zu Hinweisen.

In Wirklichkeit war Bazaar im Hintergrund sehr fleißig, denn es hat durch den Initialisierungsvorgang einen sogenannten Zweig erstellt. In einem solchen Zweig werden die Dateien einer Versionsverwaltung gespeichert, wie beispielsweise Angaben über Änderungen an den vorhandenen Dateien.

Sie können ab diesem Zeitpunkt auch die grafische Oberfläche Olive einsetzen (siehe Abbildung). Ein beliebiges Projekt kann man sich bei einer Zusammenarbeit mehrerer Teilnehmer vorstellen wie einen Baum, dessen Zweige einzelnen Entwicklungen gleicht. Alle Zweige führen zurück zum Stamm des Baumes und damit letztendlich zum Projekt selbst. In diesem Zusammenhang versteht man auch die Namensgebung Olive, die sich als Frucht eines dieser Zweige begreift.

Abbildung 15.14 Mit Olive können Sie Bazaar auch mittels einer grafischen Oberfläche verwenden.

Der nächste Schritt besteht darin, dass Sie Bazaar erzählen, welche Dateien in diesem Zweig verfolgt (engl. to track) werden sollen. Bazaar geht hierbei nicht automatisch davon aus, dass alle Dateien innerhalb eines Zweiges verfolgt werden sollen. Sie erreichen eine komplette Verfolgung aller Dateien durch

user$ bzr add 
added test1.txt 
added test2.txt 
added test3.txt

Hier werden rekursiv alle Dateien innerhalb des Zweiges hinzugefügt. Wenn Sie nur einzelne Dateien verfolgen möchten, geben Sie diese einfach hinter bzr add ... an.

Legen Sie jetzt einen Startpunkt fest, ab dem die Verfolgung der Dateien durch Bazaar beginnen soll. Dies erreichen Sie dadurch, indem Sie den derzeitigen Stand Ihrer Dateien Bazaar hinzufügen. Sie machen einen sogenannten Snapshot:

bzr commit -m "Erste Version"

Wir geben der derzeitigen Stand den Kommentar »Erste Version« mit auf den Weg. Bitte gewöhnen Sie sich das Kommentieren an, damit Sie später noch den Überblick haben, wann welche Änderung vorgenommen wurde.

Snapshot

Es mag verwirrend erscheinen, dass wir zuerst einem Zweig Dateien hinzufügen und danach diese Dateien Bazaar mitteilen. Hierbei ist wichtig zu unterscheiden, dass wir im ersten Schritt Bazaar lediglich mitgeteilt haben, welche Dateien verfolgt werden sollen. Im zweiten Schritt lassen wir Bazaar einen sogenannten »Snapshot« (dt. Schnappschuss) dieser Dateien erstellen.

Bazaar speichert diese Snapshots ab, so dass Sie zu einem späteren Zeitpunkt auf Wunsch Ihre Änderungen verwerfen und dem damaligen Zeitpunkt des Snapshots zurückkehren können. Wie ich bereits erwähnte, ist Bazaar ein dezentrales Versionskontrollsystem und benötigt daher keinen Zugriff auf einen zentralen Server, um diese Snapshots abzupeichern. Alle nötigen Konfigurationsdateien, Revisionen und Verfolgungsprotokolle werden in dem aktuellen Verzeichnis im versteckten Ordner ./bzr gespeichert.

Änderungen vornehmen

Eine (Projekt-)Entwicklung sollte möglichst dynamisch erfolgen, und so haben wir es im Laufe der Zeit mit vielen Änderungen zu tun. Also nehmen wir eine Änderung an einer der Dateien vor. Wir haben leere Textdateien angelegt, sodass es sich jetzt anbieten würde, wenn wir eine dieser Dateien mit Inhalt füllen.

Rufen Sie also eine dieser Dateien mit Ihrem Lieblingseditor auf (grafisch oder im Terminal mit gedit test1.txt). In Olive reicht es, wenn Sie die zu ändernde Datei doppelt anklicken. Schreiben Sie als nächstes etwas dort hinein, beispielsweise das Wort test. Nach dem Abspeichern dieser Änderungen im Editor können Sie diesen wieder schließen und sich mithilfe von Bazaar die Veränderung anzeigen lassen:

bzr diff 
=== modified file 'test1.txt' 
--- test1.txt 2008-04-29 13:41:39 +0000 
+++ test1.txt 2008-04-29 14:29:41 +0000 
@@ –0,0 +1,1 @@ 
+test

Sie können sich die Veränderungen auch mit Olive anzeigen lassen. Klicken Sie zu diesem Zweck einfach auf den Button Diff (siehe Abbildung).

Abbildung 15.15 Veränderungen an den Dateien lassen sich leicht verfolgen.

Nach umfangreichen Änderungen macht es Sinn, wenn Sie einen neuen Snapshot anlegen:

bzr commit -m "Ein Wort hinzugefügt" 
Committed revision 2.

Selbstverständlich brauchen Sie nicht bei jeder kleinen Änderung (wie die eben beschriebene) einen neuen Snapshot anlegen. Aber wenn Sie dies tun, dann achten Sie auf einen aussagekräftige Bezeichnung. Das erleichtert das spätere Nachvollziehen einzelner Änderungen im sogenannten »Revisions-Log«.

Revisions-Log

Das Revisions-Log stellt quasi die Geschichte Ihres Zweiges dar, indem es alle angefertigten Snapshots mit den dazugehörigen Kommentaren auflistet. Sie können sich die bisherige Geschichte ansehen, indem Sie bzr log im Terminal eingeben:

bzr log 
------------------------------------------------------------ 
revno: 2 
committer: Marcus Fischer bzr@marcus-fischer.com 
branch nick: Projekt 
timestamp: Tue 2008-04-29 16:41:42 +0200 
message: 
  Ein Wort hinzugefügt 
------------------------------------------------------------ 
revno: 1 
committer: Marcus Fischer bzr@marcus-fischer.com 
branch nick: Projekt 
timestamp: Tue 2008-04-29 15:41:39 +0200 
message: 
  Erste Version

Grafisch erreichen Sie dies, wenn Sie in Olive auf den Button Log klicken.

15.7.3 Das Projekt veröffentlichen

Bisher haben Sie ausschließlich alleine an Ihrem Projekt gearbeitet. Auch hierbei ist es durchaus sinnvoll, ein Versionskontrollsystem wie Bazaar zu benutzen, beispielsweise um bei Fehlern zu einem früheren Zustand der Entwicklung zurückkkehren zu können.

Wenn Sie mit mehreren Benutzern zusammen an einem Projekt arbeiten, macht dieser lokale Zweig Ihrer Entwicklung wenig Sinn, wenn er nicht mit anderen abgeglichen werden kann. Zum Abgleich benötigen Sie entweder Zugriff auf einen privaten Server per FTP oder Sie legen sich einen Account bei Launchpad an. Wenn Sie eine Homepage besitzen, haben Sie oftmals auch einen FTP-Zugang und etwas Platz auf dem Server.

Launchpad ist eine Sammlung von Werkzeugen zur Entwicklung und Bereitstellung von freien Software-Projekten. Sie erfahren mehr über Launchpad in Abschnitt auf Seite .

FTP-Server

Wir beginnen mit der Veröffentlichung auf einem FTP-Server. Im Folgenden gehen wir davon aus, dass auf dem Server ein Ordner mit dem Namen /Projekt existiert. Installieren Sie für die Verwendung von sFTP zuerst das Paket paramiko:

sudo apt-get install python-paramiko

Zum Veröffentlichen existiert in Bazaar der Befehl push:

bzr push --create-prefix sftp://your.name@example.com/Projekt 
2 revision(s) pushed.

Durch diesen Befehl erstellt Bazaar den entsprechenden Ordner auf dem Server und schieben (engl: to push) Ihren Zweig in diesen. Jetzt kann jeder Benutzer seinen eigenen Zweig erstellen, indem er folgendes in seinem Terminal eingibt:

bzr branch http://www.example.com/Projekt

Launchpad

Wenn Sie keinen eigenen FTP-Server besitzen oder eine elegante und dazu noch kostenfreie Möglichkeit suchen Ihren Zweig zu veröffentlichen, dann bietet Ihnen Canonical einen kostenlosen Account auf Launchpad an.

Um Launchpad nutzen zu können, benötigen Sie ein Benutzerkonto (engl. account). Die Anmeldung von Launchpad ist kostenlos. Sie benötigen außerdem einen SSH-Schlüssel, um Launchpad mit Bazaar nutzen zu können.

Wie Sie einen SSH-Schlüssel erstellen, ist in Abschnitt auf Seite beschrieben.

Öffnen Sie nun Ihren Launchpad-Account und registrieren Sie Ihr Projekt, indem Sie im Reiter »Code« links auf den Link Register branch klicken.

Nach der Registrierung können Sie Ihr Projekt mit Bazaar hochladen (siehe Abbildung). Dies geschieht durch

bzr push bzr+ssh://Ihr.Name@bazaar.launchpad.net/ Ihr.Name/+junk/Projekt

Den Eintrag Ihr.Name ersetzen Sie bitte durch Ihren Benutzernamen auf Launchpad. Diesen Namen können Sie sich – je nach Verfügbarkeit – zulegen und muss nicht zwangsläufig Ihrem realen Namen entsprechen.

Lassen Sie sich nicht durch das Kürzel +junk in der Adresse Ihres Projektes verunsichern. Dies bedeutet auf keinen Fall, dass Ihr Projekt automatisch dem Müll zugeordnet wird, sondern lediglich, dass Ihr Projekt mit keinem anderen auf Launchpad existierenden Projekt verknüpft ist.

Abbildung 15.16 Die Startseite von Launchpad

Launchpad ist eine Basis für die Entwicklung von Open-Source-Software, auch wenn die Plattform selber noch nicht Open Source ist (Stand: Mai 2008). Dies bedeutet, dass selbstverständlich jeder Interessierte eine eigenen Kopie Ihres Zweiges anlegen kann. Dies geschieht durch die Kenntnis der Adresse und der Eingabe folgender Zeile in einem Terminal:

bzr branch http://bazaar.launchpad.net/ Ihr.Name/+junk/Projekt

Auf Ihrer Launchpad-Projektseite können Sie sich ebenfalls umfangreiche Informationen, beispielsweise das Revisions-Log, ansehen (siehe Abbildung).

Selbstverständlich können Sie sich auch jederzeit Kopien von den Projekten anderer Benutzer anlegen und ihnen bei der Entwicklung helfen. Launchpad vereinfacht erheblich die Zusammenarbeit an solchen Projekten.

Abbildung 15.17 Ihr Branch in Launchpad

Auf dem Laufenden bleiben

Wenn mehrere Personen gemeinsam an einem Projekt arbeiten, kann es natürlich passieren, dass die Teilnehmer gleichzeitig daran arbeiten. Daher ist es sehr wichtig, dass Sie lokal immer einen aktuellen Zweig vorhalten. Dies geschieht durch regelmäßiges Abgleichen mit dem sogenannten »Hauptzweig«, dem Repository, von dem alle Teilnehmer eine Kopie auf ihren lokalen Rechnern besitzen.

Dier Abgleich ist nichts anderes als das Zusammenführen diverser Änderungen und geschieht durch

bzr merge

Prüfen Sie, was sich verändert hat:

bzr diff

Wenn Sie mit den Änderungen einverstanden sind, können Sie diese zu Ihrem persönlichen Zweig hinzufügen:

bzr commit -m "Abgleich" 
Committed revision xy.

Änderungen hochladen

Zurzeit profitieren Sie nur von dem Projekt, geben aber nichts zurück. Wenn Sie die Änderungen, die Sie selbst an dem Projekt getätigt haben, hochladen möchten, bietet sich der sogenannte »merge directive« (Befehl oder Richlinie zur Zusamenführung) an.

Dieser merge directive ist eine maschinenlesbare Anfrage nach einem partiellen Zusammenführen der »Patches« (Flicken). In der Regel enthält eine solche Anfrage eine Vorschau des Patches und die nötigen Revisionen oder einen Zweig, der die diese enthält:

bzr send -o mein-code.patch

Nachdem Sie den Patch hochgeladen haben, wird automatisch eine E-Mail an alle Teilnehmer des Projekts sowie den »Maintainer« (Hauptentwickler) des Projektes verschickt. Die Hauptentwickler des Projektes (Ersteller des Zweiges) sind nun in der Lage Ihre Verbesserungsvorschläge zu begutachten und bei Bedarf in den Hauptzweig zu integrieren.

Die vorliegende Anleitung ersetzt selbstverständlich keine umfassende Dokumentation, sollte aber dennoch für einen Einstieg genügen. Um mehr über Bazaar zu lernen, können Sie auch die integrierte Hilfe nutzen. Mit

bzr help

erfahren Sie mehr über die Arbeitsweise von Bazaar, und durch

bzr help commands

erhalten Sie eine Übersicht und Erklärung aller Bazaar-Befehle.

Ihr Kommentar