From fee760cde23af6a75dbf1931ed4dd69087ef8a70 Mon Sep 17 00:00:00 2001 From: studio-prisma <282898618+studio-prisma@users.noreply.github.com> Date: Mon, 26 Oct 2026 18:23:32 +0100 Subject: [PATCH] docs: correct the plugin-ID note and the uninstall consequences The 0.6.0 notes said the new plugin ID loses the stored configuration. osTicket 1.18 keys an installation by its install path and the config by the plugin's database id; replacing the folder under the same name keeps everything. The rollback section said the mapping table survives an uninstall; pre_uninstall drops both tables and deletes the webhooks. --- CHANGELOG.md | 4 ++-- docs/INSTALL.de.md | 4 +++- docs/INSTALL.md | 4 +++- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7052b01..32927fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,8 +17,8 @@ Erste öffentliche Veröffentlichung. Alles davor lief unveröffentlicht auf ein ### Geändert - Der Release-Workflow liest den Tag über `env` und akzeptiert nur `vX.Y.Z` und `vX.Y.Z-rc.N`, statt den Tag direkt in Shell-Code einzusetzen. -### Geändert — BRECHEND für Vorab-Installationen -- **Plugin-ID ist jetzt `studio-prisma:trello-sync`.** osTicket schlüsselt die gespeicherte Plugin-Konfiguration über diese ID. Wer eine unveröffentlichte Vorabversion einsetzt, verliert beim Update die Einstellungen und muss Board-Zuordnung, API-Key, Token und Secret neu setzen. **Vor dem Update die Konfiguration abschreiben.** +### Geändert — Vorab-Installationen: Ordnernamen beibehalten +- **Plugin-ID ist jetzt `studio-prisma:trello-sync`.** Für bestehende Installationen ist das unkritisch: osTicket 1.18 findet ein installiertes Plugin über seinen Installationspfad (`include/plugins/`) und legt die Konfiguration unter `plugin..instance.` ab; die Manifest-ID dient nur der Signaturprüfung von PHAR-Paketen (`include/class.plugin.php`). Wer den Plugin-Ordner **unter demselben Namen** ersetzt, behält alle Einstellungen. Ein anderer Ordnername ist eine neue Installation mit leerer Konfiguration. Das alte Plugin dann **nicht** deinstallieren, solange die Mapping-Daten gebraucht werden: die Deinstallation entfernt die Webhooks bei Trello und löscht beide Tabellen. *(Korrigiert am 2026-10-26: die erste Fassung dieser Notiz sagte fälschlich einen Verlust der Einstellungen voraus.)* - `author` und `url` im Manifest zeigen auf studio-prisma. ### Hinzugefügt diff --git a/docs/INSTALL.de.md b/docs/INSTALL.de.md index f434a39..8cc3336 100644 --- a/docs/INSTALL.de.md +++ b/docs/INSTALL.de.md @@ -224,4 +224,6 @@ Trello ist ein US-Anbieter. Alles Synchronisierte verlässt die EU. Das ist eine ## Rollback -Plugin im Admin-Panel deaktivieren. Es wird nichts gelöscht, auf keiner Seite. Für die vollständige Entfernung in der Plugin-Liste deinstallieren und `include/plugins/trello-sync/` löschen. Die Mapping-Tabelle `ost_trello_map` bleibt stehen — für einen sauberen Neustart von Hand droppen. +Plugin im Admin-Panel deaktivieren. Es wird nichts gelöscht, auf keiner Seite. Für die vollständige Entfernung in der Plugin-Liste deinstallieren und `include/plugins/trello-sync/` löschen. **Die Deinstallation ist nicht umkehrbar:** sie entfernt die Webhooks bei Trello und löscht beide Tabellen, `ost_trello_map` (Ticket ↔ Karte) und `ost_trello_board`. Vorher sichern, falls die Zuordnungen noch gebraucht werden. + +**Update** heißt: Ordnerinhalt **unter demselben Ordnernamen** ersetzen. osTicket findet ein installiertes Plugin über seinen Installationspfad und behält die Konfiguration dieser Installation; zum Update nicht deinstallieren. diff --git a/docs/INSTALL.md b/docs/INSTALL.md index e29970b..49bab80 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -224,4 +224,6 @@ Trello is a US provider. Everything synchronised leaves the EU. That is a deploy ## Rollback -Disable the plugin in the admin panel. Nothing is deleted, on either side. To remove it entirely, uninstall it in the plugin list and delete `include/plugins/trello-sync/`. The mapping table `ost_trello_map` stays behind — drop it manually if you want a clean slate. +Disable the plugin in the admin panel. Nothing is deleted, on either side. To remove it entirely, uninstall it in the plugin list and delete `include/plugins/trello-sync/`. **Uninstalling is not reversible:** it deletes the webhooks at Trello and drops both tables, `ost_trello_map` (ticket ↔ card links) and `ost_trello_board`. Back them up first if you may need the links again. + +**Updating** means replacing the folder contents under the **same folder name**. osTicket finds an installed plugin by its install path and keeps its configuration under that installation; do not uninstall to update.