Entwicklung
Hast du PHP, composer, make und Docker auf deinem Rechner installiert, kannst du make dev
ausführen, um eine Wordpress-Instanz mit Docker Compose zu starten.
Anschließend kannst du mit deinem Browser http://localhost:8082
besuchen und das Wordpress nach deinem Belieben kurz einrichten.
Das Plugin wird automatisch in das Wordpress eingebunden. Du musst es allerdings noch aktivieren. Mehr dazu findest du im Abschnitt Ersteinrichtung.
Formatierung
Die Code kann automatisch mit dem Aufruf make style
formatiert werden. Dafür braucht es im System zusätzlich eine NodeJS-Installation.
Verbreitung
Das Wordpress Plugin kann als ZIP-Archiv generiert werden. Dafür reicht es das make build
Kommando auszuführen. Es ist dann unter dist/aura-wordpress.zip
zu finden.
Update der Kiota-API Clients
Das Projekt nutzt API Clients, die auf Basis der von AURA bereitgestellten API-Beschreibungen im OpenAPI-Format generiert werden.
Die API Clients selbst können über make update-clients
automatisiert aktualisiert werden. Leider scheint die Generierung der Clients nicht vollständig deterministisch zu sein, so dass bei der Übernahme der Änderung ins Code-Repository Vorsicht geboten ist.
Konkret passiert es häufiger, dass die URL-Query-Parameter von API-Endpunkten nicht korrekt übernommen werden. Ein entsprechendes Diff sieht z.B. folgendermaßen aus.
- parent::__construct($requestAdapter, [], '{+baseurl}/api/v1/users/{?search*}');
+ parent::__construct($requestAdapter, [], '{+baseurl}/api/v1/users');
Alle Steering-Endpunkte enden auf einen Slash (/
). Wird dieser samt Query-Parametern entfernt, sollte die entsprechende Änderung im Regelfall nicht übernommen werden solange nicht explizit geprüft wurde, ob der API-Endpunkt tatsächlich dahingehend verändert wurde. Stellt es sich heraus, dass die Query-Parameter zu Unrecht entfernt wurden, können die entsprechenden Änderungen einfach verworfen werden.