Skip to content

Latest commit

 

History

History
171 lines (102 loc) · 7.48 KB

addon-veroeffentlichung.md

File metadata and controls

171 lines (102 loc) · 7.48 KB
Raw

AddOn Veröffentlichung

Um eigene AddOns zu veröffentlichen sollten man folgenden Weg nehmen.

Erstellung des AddOn-Keys

Jedes AddOn hat eine eindeutige Kennung. Diese Kennung nennen wir Key und ist gleichzeitig auch der Ordnername. Um einen passenden Key zu registrieren und auch die Bezeichnung und Beschreibung des AddOns festzulegen, muss man sich zunächst in MyREDAXO registrieren und dann einloggen. Unter Meine AddOns kann dann die AddOn-Definition mit dem passenden Key angelegt werden.

Mein API-Key

Um verschiedene weitere Aktionen durchführen zu können, die man nun auf der eigenen REDAXO-Installation machen muss, braucht man einen API-Key. Diesen kann man sich in MyREDAXO erstellen. Dieser besteht aus einer Zeichenkette und sollte nicht weitergegeben werden, da man mit dem Key und dem eigenen Login Versionen veröffentlichen, löschen oder ändern kann.

Das Installer-AddOn

Jede aktuelle REDAXO-Version hat einen Installer. Darüber werden AddOns installiert und aktualisiert, aber auch eigene AddOns erstellt, bearbeitet und veröffentlicht.

Veröffentlichen einer Version

Settings

Einzelne Versionen müssen entwickelt und geprüft werden. Das macht man meistens lokal auf dem eigenen Rechner. Hier muss das AddOn, welches man veröffentlichen will, existieren. Zunächst muss aber der API-Key in den Installer Einstellungen eingetragen werden. Nur dadurch kann erkannt werden, zu welchen AddOns man Zugriff hat.

Settings

Einstellungsdialog

Meine Packages

Nun kann man über Core & Packages/Eigene hochladen einsehen, welche AddOns bereits registriert sind und auch in der lokalen Installation vorhanden sind. Das heißt, wenn man Änderungen durchführen und eine neue Version eines AddOns veröffentlichen möchte, muss genau dieses AddOn in der lokalen Installation zur Verfügung stehen.

Meine Packages

Eigene hochladen - Meine Packeges

Eigenes AddOn

Um ein AddOn zu veröffentlichen oder eine neue Version aufzuspielen, wählt man das gewünschte AddOn in der Liste aus. In dieser Liste können einzelne Versionen mit "Datei aktualisieren" aktualisiert werden oder über das "+" eine neue Version erstellt werden.

Eigenes AddOn

Eigenes AddOn

AddOn-Version aktualisieren / löschen

Eine Aktualisierung wird mit den vorhandenen Versionsinfos abgeglichen. D.h. wenn lokal eine spezielle Version läuft, dann kann man in den anderen Versionen nur die Beschreibung und den Status ändern. Sofern die ausgewählte Version mit der lokalen übereinstimmt oder man auf "ZIP-Datei erstellen und hochlanden" klickt, kann man die eigene lokale Version komplett hochladen und ersetzen.

Eine einzelne Version kann man über den Löschen-Button aus dem Online-Archiv entfernen.

AddOn aktualisieren

AddOn aktualisieren

AddOn-Version erstellen

Versionen werden direkt aus dem lokalen AddOn selbst herangezogen (package.yml). Diese Version ist entsprechend voreingestellt und die Beschreibung und der Status können gesetzt werden. Sofern diese Version online gestellt wird, ist sie sofort für andere REDAXO-User verfügbar. Mit "Assets aus dem Root-Assets-Ordner nehmen" können Assets aus dem REDAXO-Assets-Ordner übernommen werden.

AddOn erstellen

AddOn erstellen

Ausschließen von Development-Dateien im Package

Während der Entwicklung werden häufig Dateien benötigt, die im eigentlchen AddOn nicht erforderlich sind. Diese Dateien und Ordner kann man in der package.yml auf ignorieren setzen. Sie werden somit bei der AddOn-Veröffentlichung nicht mehr beachtet.

installer_ignore:
    - node_modules
    - .env
    - src

AddOn direkt aus GitHub heraus veröffentlichen

Mit der FriendsOfREDAXO/installer-action können AddOns direkt aus GitHub heraus released werden. Nach Einrichtung der installer-action werden GitHub-Releases automatisch in den Installer übertragen.

Voraussetung: Das AddOn muss vorab in MyREDAXO angelegt und beschrieben sein.

Informationen zur Einrichtung auf GitHub.

Updates

Sind Aktualisierungen an Datenbanken und Konfigurationen erforderlich sollte dem AddOn eine update.php beigelegt sein. Diese wird automatisch beim Update eines AddOns ausgeführt.

Häufig reicht es, hier die install.phpeinzubinden, da dort bereits die allgemeinen Config-Properties und die Konfiguration der Datenbank mittels rex_sql_table sichergestellt werden.

Weitergehende Anpassungen führt man dann nach dem include der install.php aus.

Beispiel

$addon = rex_addon::get('mein_addon');
$addon->includeFile(__DIR__ . '/install.php');

Updates testen, geheime AddOns

Mit hinterlegtem API-Key kann man über den Installer eigene, offline gestellte, AddOns/Versionen laden. Diese AddOn-Versionen sind nicht öffentlich. Auf diese Weise können Updates in Ruhe über den Installer getestet werden oder der Installer ggf. für private AddOn-Installationen genutzt werden.

Zu bedenken dabei ist, dass der API-Key auch Schreibrechte hat. Also alle Administratoren der REDAXO-Installation hätten damit Zugriff auf die eigenen AddOns. Sie könnten diese verändern, zerstören und auch löschen. Daher sollte der Key unbedingt wieder entfernt werden.

Meldung nach erfolgreicher Installation ausgeben

Es ist möglich im Installer eine Infordirekt nach erfolgter Installation auszugeben um z.B. auf die nächsten Schritte hinzuweisen.

$addon = rex_addon::get('mein_addon');
$addon->setProperty('successmsg', rex_i18n::msg('mein_addon_install_msg');

Meldung bei fehlerhafter Installation ausgeben

Sollte was während der Installation schief laufen, kann man die Installation als nicht erfolgreich markieren und eine Fehlermeldung ausgeben.

if ($something_bad_happened) {
    $addon->setProperty('installmsg', 'Installation fehlgeschlagen');
    $addon->setProperty('install', false);
}