Automatisiertes Bauen von .deb-Paketen aus VCS-Snapshots

Axel Beckert

Debian / ETH Zürich

abe@debian.org
http://noone.org/abe/

Übersicht

• Kurzvorstellung: Conkeror
• Warum?
• Worauf muß man achten?
• Beispiel-Implementation
• Aussichten
• Ressourcen / Links

Kurzvorstellung: Conkeror

• Komplett mit der Tastatur bedienbarer Webbrowser
• Look & Feel von GNU Emacs und Lynx
• Wie Firefox, Thunderbird, Sunbird, etc. eine sog. XULRunner Application, d.h. die Gecko Rendering Engine
• Nicht zu verwechseln mit Konqueror (WebKit/KHTML)
• Fing als Firefox-Erweiterung an, vimperator ein Fork davon
• Viele Features fehlen noch, z.B. Bookmark- + Cookie-Management
• In Debian seit Lenny, In Ubuntu seit Jaunty.

Warum?

• Aktuelle Snapshots der Entwicklerversion für die Community
• Trotzdem einfach und schnell zu installieren via APT (apt-get, aptitude, synaptic, etc.) — einfacher als wget …; tar xzf …; cd …; make; make test; sudo make install → breitere Tester-Basis
• Regelmäßiges Testen der neusten Version für den Maintainer des Debian-Paketes
• Regelmäßiges Testen, ob das Paket mit der neusten Version der Software noch baut

Worauf muß man achten?

• Versionsnummer: kleiner als ein aus dem gleichen Snapshot gebautes, normales Paket
• Changelog-Eintrag sollte klar machen, daß das Paket automatisiert gebaut wurde und nicht getestet ist.
• GnuPG- und SSH-Keys: Ohne Passphrase → sollten für nichts anderes verwendet werden.
• Die Pakete sollten nicht aus Versehen in die offiziellen Repositories von Debian hochgeladen werden. :-)
• Ggf. nicht das Build-Skript direkt aus dem VCS-Repository nehmen sondern manuelle Kopie.

Beispiel-Implementation

• Webbrowser Conkeror (Debian-Paket conkeror, http://repo.or.cz/w/conkeror.git)
• Paketierung (das Verzeichnis "debian") ist im git-Repository von Upstream
• Skript zum Bauen der Snapshot-.debs ebenfalls im Upstream-Repository: http://repo.or.cz/w/conkeror.git/blob/HEAD:/contrib/debian/nightlybuild.sh

Ablauf des Build-Skriptes

• Ausgecheckte Kopie ("MASTERDIR") dient als Cache
  (initial anlegen, sonst aktualisieren)
• Wegwerfkopie davon ("BUILDDIR") zum Paketbauen
  (ggf. alte Kopie vorher löschen)
• Versionsnummer des Snapshots berechnen
• Upstream-Source-Tarball (.orig.tar.gz) erstellen
• Changelog-Eintrag erstellen
• Binärpaket bauen
• Upload und danach Paketliste neubauen

Generieren einer Versionsnummer

• Version der Software feststellen, z.B. im Quellcode oder letzter Eintrag im Debian Changelog
• Sollte aktuelles Datum und Uhrzeit enthalten (z.B. Unix Timestamp)
• Hinweis auf Snapshot oder VCS in der Versionsnummer schadet nicht
• Versionsnummer sollte kleiner sein als von manuell gebautem Snapshot
• Beispiele:
  • $UPSTREAM+$VCS$UNIXTIMESTAMP-~nightlybuild1
  • $UPSTREAM~$VCS$DATE-~dailybuild$UNIXTIMESTAMP

Generieren eines Changelog-Eintrages

• "UNRELEASED" als Distribution eintragen (kein offizielles Paket, verhindert versehentlichen Upload)
• Kurzbeschreibung des automatischen Paketbaus.
• Kontaktadresse und Datum.
• Beispiel:

  $PACKAGE ($NIGHTLY_VERSION) UNRELEASED; urgency=low
  
    * Automatically built package based on the state of
      $REPOSITORY at $DATE (Commit $COMMIT_ID)
  
   -- $PACKAGE Nightly Build Script <$CONTACT>  $DATE
  

Bauen und Signieren

• Upstream-Source-Tarball bauen, z.B. mit:
  • make dist,
  • make -f debian/rules get-orig-source oder
  • tar cvzf $PACKAGE_$VERSION.orig.tar.gz --exclude=.git --exclude=debian $PACKAGE
• Binär- und Source-Paket bauen, z.B. mit dpkg-buildpackage, debuild, pbuilder, pdebuild, etc.
• Ggf. Signieren (passphrase-loser Key, der nur dafür verwendet wird), z.B. mit debsign
• Bauen für andere Architekturen: Kann o.g. Source-Paket als Basis nehmen, d.h. wie ein normaler Buildd funktionieren.

Hochladen und Paketlisten neu generieren

• Ggf. Hochladen, z.B. rsync oder scp mit passphrase-losem Key, dput, dupload, etc.
• Paketliste des APT-Archives neu bauen, z.B. mit reprepro oder mini-dinstall, angestoßen per ssh, inoticoming, cron, incron, dnotify, etc.)

Aussichten

• Ein generisches Skript zum Bauen beliebiger Pakete aus VCS-Snapshots.
• Je nach Paket muß evtl. lokal noch ein Skript geschrieben werden, das die Versionsnummer oder zumindest ein Teil davon generiert.
• Bauen nur nach Änderungen im Repository (hat Vor- und Nachteile)

Ressourcen

• Conkeror Nightly .Debs: http://noone.org/conkeror-nightly-debs/
• Skript zum Generieren der Conkeror Nightly .Debs: http://repo.or.cz/w/conkeror.git/blob/HEAD:/contrib/debian/nightlybuild.sh
• Offizielle Conkeror Debian-Pakete: http://packages.debian.org/conkeror

Danke

• Nicholas A. Zigarovich für die Idee zu den Conkeror Nightly .Debs
• Eric A. Meyer für S5