Package-Builder "Sherpa"

Package Building war bislang immer kompliziert, nun ein einfacher Anwenderfreundlicher (Entwicklerfreundlicher) Weg um Packages erheblich schneller zu erstellen


Auf unserem letzten MODX Usertreffen in Köln sind wir übereingekommen das es aktuell sehr aufwendig ist seine erstellten Code Snippets in Packages zu übernehmen. So werden immer wieder riesige build skripte von Projekt zu Projekt kopiert und angepasst. Jedes mal müssen eine Menge an Snippets, Chunks und alles was ein Package ausmacht zusammen gesammelt werden und wieder neu zusammengesetzt.

Hier kam der Wunsch auf nur durch die Angabe einer Kategorie alles zusammenpacken zu lassen. Und noch im laufe des Meetups wurde fleissig programmiert. Und zu einem ersten Entwurf zusammengesetzt.

Grundlage der Arbeiten hier war das modCategory Objekt welches Verknüpfungen zu praktisch allen Komponenten bildet.

Packagebuilder Sherpa 0.0.1 herunterladen

Die Inhalte werden entpackt und das _buildpackage verzeichniss in das MODX gelegt in welchem wir unser Package erstellt haben. Anschließend kopieren wir die build.default.php auf einen neuen Namen der unserem Package gerecht wird, und passen die Datei mit wenigen Handgriffen auf unser Package an. 

// Category that will be extracted
define('PKG_CATEGORY',   'Package Category Name');  

// Packagename in Packagemanager, should be without whitespacesdefine('PKG_NAME',       'PackageName');  

// Directory name below /core/components/ and /assets/components/ will be in lowercase
define('PKG_NAME_LOWER', 'packagename');  

define('PKG_VERSION',    '0.0.1');
define('PKG_RELEASE',    'beta1');

 

Nun nur noch die Datei ausführen und das Package wird gepackt und heruntergeladen. Anschließend müssen noch einige Dokumentationsdateien angelegt werden. Die Dateien für die Lizenzinformationen, Readme und das Changelog sind in diesem Builder Pflicht da ich diese als so elementar ansehe und ein «naja das mach ich später» meist ohnehin nie in die Tat umgesetzt wird.

Die neu gewonnene Package Datei kann nun auf einem MODX Revolution wieder installiert werden über die Package Verwaltung.

Dies ist noch ein sehr früher WIP Release und dient erst mal zur Demonstration. Bislang werden nur die Direkten Elemente Elemente Chunk, Snippet, Templates, Templatevariablen, Plugins und die dazugehörigen Dateien unter assets/ und core/components/ gepackt. Snippet Parameter, Pluginevents und vieles andere geht aktuell in diesem Build noch verloren.


Comments (0)


Add a Comment





Allowed tags: <b><i><br>Add a new comment: