Autobuild ist ein Framework zum Erstellen von Paketen und zum Verwalten von Abhängigkeiten eines Pakets von anderen Paketen. Es bietet eine einheitliche Schnittstelle zum Konfigurieren und Bauen von Paketen, ist jedoch kein Build-System wie make oder cmake. Für die Konfiguration und das Bauen Ihrer Bibliothek benötigen Sie weiterhin plattformspezifische make-, cmake- oder Projektdateien. Autobuild ermöglicht es Ihnen jedoch, diese Befehle aufzurufen und das Ergebnis mit einer einheitlichen Schnittstelle zu verpacken.

Hinweis:
Linden Labs Autobuild ist nicht dasselbe wie und auch nicht abgeleitet von GNU Autobuild, aber die Ähnlichkeiten können zu Verwechslungen führen. Wir bedauern diese Namensüberschneidung.

Autobuild wird aktiv weiterentwickelt, daher wird empfohlen, die neueste Version zu verwenden und regelmäßig zu aktualisieren.

• Python 3.7+ für Autobuild 3.x

pip install autobuild

Je nach Systemberechtigungen und ob Sie eine Python-virtualenv verwenden, müssen Sie möglicherweise Ihre PATH-Variable anpassen.

autobuild [Optionen] [Sub-Befehl]  

Dieser Abschnitt erklärt, wie Autobuild konfiguriert wird, um ein Quellpaket zu erstellen. Voraussetzung ist eine bestehende Quellverteilung und ein funktionierendes Build-System wie make oder cmake.

Autobuild ist kein Build-System wie make oder cmake. Es löst nicht die plattformspezifischen Probleme beim Kompilieren von Code, sondern bietet eine einheitliche Schnittstelle für Build- und Packaging-Prozesse auf Basis plattformspezifischer Tools.

Für jede Bibliothek oder Anwendung, die mit Autobuild verwaltet werden soll, benötigen Sie:

• Einen Build-Befehl (ggf. auch einen Konfigurationsbefehl) für jede unterstützte Plattform.
  • Linux: Typischerweise make mit Makefiles.
  • Windows: Beispielsweise devenv.com mit einer Projektdatei.

In den folgenden Abschnitten lernen Sie, wie Sie Autobuild so konfigurieren, dass es diese plattformspezifischen Befehle ausführt.

Die folgenden Schritte erstellen eine Autobuild-Konfiguration (standardmäßig autobuild.xml) für Ihr Projekt. Diese beschreibt:

• Die Ausgabe des Projekts,
• Abhängigkeiten (sogenannte Installables),
• Plattformspezifische Build- und Konfigurationsschritte.

Wechseln Sie in das Stammverzeichnis Ihres Projekts und führen Sie aus:

autobuild edit package

Dies startet einen interaktiven Dialog, in dem Sie:

• Einen Namen angeben,
• Den Pfad zu einer Versionsdatei (z. B. VERSION.txt) festlegen.

Falls Ihr Projekt ein Archiv für andere Projekte erstellen soll, können Sie auch eine Lizenz (license) und eine Lizenzdatei (license_file) angeben.

autobuild edit package name=test license=MIT license_file=LICENSES/test.txt version_file=VERSION.txt

Für ein UNIX-ähnliches Projekt mit configure und make:

autobuild edit configure platform=darwin name=Release command=../configure
autobuild edit build platform=darwin name=Release command=make options='--directory=..' default=True

• default=True markiert diese Konfiguration als Standard-Build.
• Die Befehle command, arguments und options werden zur Ausführung zusammengefügt.

autobuild build

Wiederholen Sie die Schritte für jede Plattform. Falls mehrere Plattformen gemeinsame Befehle verwenden (z. B. cmake), können Sie diese im common-Platform-Abschnitt definieren:

• Nicht spezifizierte Attribute werden von common geerbt.
• Plattformspezifische Einstellungen überschreiben die common-Werte.

Wenn Ihr Projekt andere Autobuild-Pakete benötigt, können Sie diese automatisch herunterladen lassen:

autobuild installables add GL \
  url=http://example.com/GL-darwin-20101004.tar.bz2 \
  hash=0b7c1d43dc2b39301fef6c05948fb826

autobuild installables edit GL platform=windows \
  url=http://example.com/GL-windows-20101001a.tar.bz2 \
  hash=a94538d064cd0a235b2a95389e7e8ee8

autobuild install GL

• Die Dateien werden im packages-Verzeichnis des Build-Ordners abgelegt.

• Zum Deinstallieren:

  autobuild uninstall GL

Fügen Sie Dateien hinzu, die ins Archiv aufgenommen werden sollen:

autobuild manifest add 'include/*.h' 'lib/*.so'

• Glob-Patterns sind unterstützt.
• Lizenzdateien werden automatisch eingebunden.

autobuild package

• Das Archiv wird nach dem Schema <name>-<version>-<platform>-<buildid>.tar.bz2 benannt (z. B. test-1.0-darwin-20230530.tar.bz2).

Baut das aktuelle Paket und kopiert die Ausgabedateien in das Build-Verzeichnis, damit autobuild package sie anschließend verpacken kann.

Konfiguriert Build-Ziele für die gewählte Plattform.

🛠 Optionen identisch zu autobuild build.

Zusätzlich:

Bearbeitet die Paketdefinition.

• build – definiert Build-Befehl(e)
• configure – definiert Konfigurations-Schritte
• package – setzt Paket-Metadaten (Name, Lizenz etc.)
• platform – definiert Plattform-spezifische Einstellungen

• name: Name der Konfiguration
• platform: Zielplattform
• command: auszuführender Build-Befehl
• options: Optionen
• arguments: Argumente

• name: Paketname
• description: Beschreibung
• copyright: Urheberrecht
• license: Lizenztyp
• license_file: Pfad zur Lizenzdatei (relativ zum Paketstamm)
• version_file: Datei mit der Versionsnummer nach dem Build

• name: Plattformname
• build_directory: Verzeichnis für den Buildprozess

Installiert Abhängigkeitspakete, die während des Builds benötigt werden.

• Paketname(n): z. B. openal, assimp
• Oder: gar kein Paketname = installiert alle im Abschnitt installables definierten Pakete

📢 Hinweis: Bei privaten GitHub/GitLab-Paketen brauchst du Umgebungsvariablen:

AUTOBUILD_GITHUB_TOKEN
AUTOBUILD_GITLAB_TOKEN

Verwaltet externe Abhängigkeiten des Projekts.

autobuild installables [add|edit|remove|print] <name> [attribute=value ...]

Beispiel:

autobuild installables edit openal platform=windows64 \
  url=... hash=... hash_algorithm=sha1 version=1.24.2-r1

• url: Download-URL
• hash: Prüfsumme der Datei
• hash_algorithm: z. B. sha1, md5, blake2b
• creds: optional github oder gitlab für geschützte Repos

Definiert die Datei-/Verzeichnismuster für Dateien, die mit dem Befehl autobuild package in ein Archiv gepackt werden sollen.

• command: Unterbefehl – add, remove, clear oder print
• pattern: Dateipfad-Muster (z. B. lib/*.dll, include/**/*.h)

Packt die durch autobuild build erzeugten Artefakte in ein Distributionsarchiv.

Zeigt die aktuelle autobuild.xml-Konfiguration lesbar für Menschen an.

Zeigt die Shell-Umgebungsvariablen, die für Autobuild erforderlich sind, z. B.:

eval "$(autobuild source_environment)"

autobuild source_environment [varsfile]

• varsfile: Pfad zu einer Variablendatei (z. B. AUTOBUILD_VARIABLES_FILE)
• Erlaubt gemeinsame Konfigurationswerte (wie Compiler-Flags) für mehrere Projekte.

Beispiel: Linden Lab verwendet so eine Datei im viewer-build-variables-Repository.

Deinstalliert Pakete, die zuvor mit autobuild install installiert wurden.

• Paketname(n), die deinstalliert werden sollen