Ein Paket vor der Veröffentlichung prüfen
Diese Seite ist für Entwickler und Prüfende, die ein Seitenpaket prüfen, bevor es veröffentlicht wird. Eine Version auf dem Paketserver wird von jeder Installation genutzt, die seinen Index liest, sodass ein kaputtes Paket für alle auf einmal scheitert. Jede Prüfung unten fängt etwas ab, das die anderen übersehen; führen Sie sie in dieser Reihenfolge aus, von der günstigsten bis zu der, die eine Testinstallation braucht.
Inhalt
- Die Prüfungen auf einen Blick
- Die Definition mit xmllint prüfen
- In das Archiv sehen
- ezpm validate ausführen
- Auf eine Testinstallation hochladen
- Die Schaltfläche Prüfen
- Was keine Prüfung abdeckt
- Verwandte Seiten
Die Prüfungen auf einen Blick
| Prüfung | Braucht | Fängt ab |
|---|---|---|
xmllint --noout package.xml | Nichts als die Datei | XML, das nicht wohlgeformt ist |
tar -tzf und find -type l | Das Archiv und den Quellordner | Falschen Aufbau, Links, Dateien, die nicht hineingehören |
php ezpm.php validate | Eine Installation von Exponential, aus der Shell | Die Definition, wie der Kernel sie liest, den Namen, fehlende Dokumente |
Hochladen auf package/upload | Eine Testinstallation und die Richtlinie package/import | Alles, was der Upload-Inspektor prüft |
| Eine frische Installation | Eine Sandbox | Abhängigkeiten, Installationsskripte, die Website selbst |
Die Definition mit xmllint prüfen
xmllint --noout packages/example_site/package.xml && echo well-formedKeine Ausgabe von xmllint bedeutet, dass das Dokument wohlgeformt ist. Alle 16 Dateien package.xml der zwei Quell-Repositorys von 7x und
die index.xml von 6.0.15 bestehen diese Prüfung (18.10.2026). Über den Inhalt sagt sie nichts: Ein leerer <name> ist wohlgeformt.
In das Archiv sehen
tar -tzf example_site.ezpkg | head -20
find packages/example_site -type lWas Sie sehen sollten, und warum:
- To do:
package.xmlals einfacher Eintragpackage.xml, nicht in einem Ordner: Der Import sucht nach einem Eintrag genau dieses Namens (eZPackage::importUnaudited()).packages/build.shführttaraus jedem Paketordner heraus über*aus, was diesen Aufbau ergibt. - To do: Nur die Verzeichnisse, die das Paket nutzt:
documents/,files/,settings/,simplefiles/und die Unterverzeichnisse seiner Installationselemente (ezcontentclass/,ezcontentobject/,ezextension/). - To do: Kein
.git,.DS_Store, keine Backups von Editoren, keinnode_modules:build.shlässt sie mit seiner ListeEXCLUDESweg. - To do:
find -type lgibt nichts aus. Ein Link auf eine Datei des Pakets wird als Kopie davon importiert, aber ein Link aus dem Paket heraus, auf ein Verzeichnis oder ins Leere, ein Gerät oder eine FIFO wird mit einem Hinweis weggelassen (link_outside,link_directory,link_missing,special_file), sodass fehlt, was das Paket braucht; ein Eintrag mit..oder einem absoluten Pfad lässt jeden Import das Paket abweisen (unsafe_path).
Warnung Dateien oben in einem Paket neben
package.xmlüberstehenbuild.sh, das den ganzen Ordner archiviert, aber keinen Export aus der Administration oderezpm.php export:eZPackage::exportToArchive()kopiert nur die Definition,documents/,files/,simplefiles/,settings/und die Unterverzeichnisse der Installationselemente.cjw_multisite_democontenthält vier Dateien oben (cjw-class-additions.xml,cjw-explayouts.json,cjw-paths.json,cjw-starter-import.json), muss also aus seinem Quellordner neu gebaut und darf nie erneut exportiert werden.
ezpm validate ausführen
ezpm.php im Wurzelverzeichnis des Projekts hat einen Befehl validate (kernel/private/classes/commands/ezpm.php). Er nimmt ein Archiv,
ein Paketverzeichnis oder den Namen eines importierten Pakets und importiert nichts:
php ezpm.php validate var/tmp/example_site.ezpkg
php ezpm.php validate packages/example_site
php ezpm.php help validateEr führt expPackageJson::validateDirectory() aus (kernel/classes/exppackagejson.php), das prüft:
- dass es eine
package.xmloderpackage.jsongibt; - jedes Dokument als XML und im JSON-Format gegen
share/package/schema/package-v1.jsonund die SHA-256-Prüfsummen vonpackage.json; - die Definition, wie der Kernel sie liest (
eZPackage::parseDOMTree()): einen Namen, einfache Tokens für Version und Typ; - den Namen mit
eZPackage::isValidName(); - dass jedes Dokument, das ein Installationselement nennt (
<sub-directory>/<filename>.xmlund die Objektdateien von Inhaltselementen), im Paket liegt.
Er endet mit PASS <name> (xml): N documents, M files oder gibt eine Zeile error pro Problem und FAIL <source>: N error(s) mit dem
Exit-Code 1 aus, sodass er ein Build-Skript stoppen kann. Ein Archiv wird zuerst in ein privates Arbeitsverzeichnis entpackt, wobei unsichere
Einträge so abgewiesen werden wie bei einem Import, und das Verzeichnis wird danach entfernt.
Hinweis
validateführt die Prüfungen des Upload-Inspektors für Dateiname, gzip-Signatur, Größengrenzen und die Elemente<ezpublish>und<packaging>nicht aus. Das Hochladen unten tut es.
Auf eine Testinstallation hochladen
package/upload in der Administration ist die strengste Tür (Anleitung zu Paketen, Hochladen).
Bevor irgendetwas entpackt wird, prüft eZPackageUploadInspector::inspect() in dieser Reihenfolge: Eine Datei wurde gesendet; ihr Name endet
auf eine erlaubte Endung; sie ist nicht größer als MaxArchiveSize; sie beginnt mit der gzip-Signatur; jeder Eintrag ist sicher und
innerhalb von MaxEntries und MaxUnpackedSize; es gibt oben eine package.xml oder package.json von höchstens 16 MiB; die Definition
hat eine Wurzel <package> ohne DOCTYPE, einen gültigen Namen, <ezpublish>, <packaging> und einen brauchbaren Hersteller. Dann führt er
dasselbe validateDirectory() aus wie ezpm.php validate und zeigt die ersten 20 Fehler.
Die Meldungen sind die aus eZPackageUploadInspector::message(), etwa „Der package.xml des Archivs fehlen die Versions- oder
Paketierungsangaben.“ Die Grenzen stehen in settings/package.ini [UploadSettings].
Nutzen Sie eine Testinstallation: Ein Hochladen importiert das Paket wirklich, und derselbe Name lässt sich nicht zweimal importieren. Um es erneut zu versuchen, entfernen Sie das Paket zuerst auf seiner Seite.
Die Schaltfläche Prüfen
Die Seite eines importierten Pakets (package/view/full/<name>) hat eine Schaltfläche Prüfen. Sie führt validateDirectory() auf dem
Paket aus, wie es im Repository liegt, und zeigt das Ergebnis auf der Seite bis zur nächsten Aktion am Paket. Sie ist der schnellste Weg, ein
Paket zu prüfen, das der Setup-Assistent importiert hat, der selbst nicht prüft.
Was keine Prüfung abdeckt
Keine der Prüfungen oben liest die Bedeutung eines Pakets. Diese bleiben einer Testinstallation und der Prüfung durch Menschen überlassen:
- ob sich jedes
<require>finden lässt und neu genug ist (Abhängigkeiten angeben); - ob jedes
<settings-file>existiert (ein fehlendes überspringt der Schritt zum Anlegen der Websites stillschweigend); - ob die Installationsskripte auf den Datenbank-Engines laufen, die Sie unterstützen;
- ob die Attribute
md5sumzu ihren Dateien passen; - ob Lizenz, Changelog und Vorschaubild vorhanden und richtig sind.
Führen Sie vor der Veröffentlichung eine vollständige Installation in einer Sandbox aus: In einer Sandbox testen.
Verwandte Seiten
- Anforderungen an die Dokumentation von Seitenpaketen
- Die Checkliste der Anforderungen
- Pflichtfelder in package.xml
- Mit build.sh neu bauen
- ezpm: der Paketmanager auf der Kommandozeile
- Das JSON-Paketformat
- Seitenpakete: hier beginnen
- Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.
Werden Sie Exponential-Partner
Partner teilen ihre Informationen, stellen Mittel bereit, geben Beiträge zurück und entwickeln die Produkte mit uns, und so wächst Exponential. Eine Partner-Website und ein Dashboard sind für Mitte 2027 geplant: Werden Sie noch heute Partner, damit wir schneller wachsen und neue Funktionen früher liefern.