Rolfsvaag_Datateknikk/Lumi
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
d1a5d3b832
Lumi/docs/updates.md
Franz Rolfsvaag d1a5d3b832 updates: allow confirmed unversioned repo updates
2026-06-16 10:05:37 +02:00

3.1 KiB
Raw Blame History

Lumi Updates

Lumi updates are managed from Admin > Updates. The page separates Core and Plugins into expandable sections and uses repository metadata to choose a safe target before any files are changed.

Version Policy

Core and plugin versions use major.minor.patch.

  • Patch: fixes only.
  • Minor: non-breaking features or design changes.
  • Major: potentially incompatible changes.

The UI tracks three values separately: current version, latest available version, and safe target version. Same-major updates can target the latest version. Major crossings are blocked unless metadata exposes a compatibility bridge, usually X.0.0, or another version marked with migration_kind: "compatibility_bridge" and compatible with the current install.

If the latest version is unsafe, the UI shows the safe target as the actionable version and lists why the absolute latest is not selected.

Updates to or from an unversioned install or target remain available so an admin can recover directly from the repository. They are treated as manual repo updates: the action button stays enabled, but the UI shows warnings and the confirmation modal states that version ordering, changelog range, and rollback safety cannot be verified from metadata.

Metadata

The updater looks for these files on the source branch:

  • update-manifest.json or lumi.manifest.json
  • CHANGELOG.md or changelog.json
  • plugins/<plugin_id>/plugin.json
  • plugins/<plugin_id>/CHANGELOG.md or changelog.json

Useful metadata fields include version, channel, compatible_from, migration_kind, migration_notes, rollback_safe, requirements, size, and changelog entries. Missing changelog data is shown as a warning.

Stable checks read main by default. The newest experimental-* branch is used only when explicitly selected on the updates page.

Snapshots And Revert

Before a core, plugin, repo, or ZIP update, Lumi creates a snapshot under data/snapshots/ and records metadata in the snapshot index:

  • target kind/id
  • from/to versions
  • source branch
  • update method
  • rollback safety
  • recovery marker id
  • major-crossing flag

Manual revert is available for core and individual plugins. Revert actions are limited to the previous-version snapshot for that target. Major-version rollback is blocked unless the snapshot or manifest explicitly marks rollback as safe.

ZIP Fallback

Core and plugin ZIP updates remain available, but they are hidden under Show advanced ZIP update options. ZIP updates create snapshots and recovery markers. They may bypass repo metadata and compatibility checks unless the ZIP contains valid manifest data, so use them as a manual fallback.

Progress Events

Admin update actions publish Server-Sent Events through GET /admin/updates/events. Event names include update:checking, update:metadata, update:snapshot, update:recovery_marker, update:download, update:apply, update:verify, update:complete, update:failed, and update:revert.

Core update success returns a five-second in-page notice before refresh/restart. Plugin update success updates progress for the affected plugin action without a whole-page refresh.