Skip to main content

Updates

How to safely update SigmaOrders to newer versions.

Standard Updateโ€‹

  1. Backup the plugin folder: cp -r plugins/SigmaOrders plugins/SigmaOrders.backup
  2. Stop the server gracefully (wait for operations to complete).
  3. Remove the old SigmaOrders.jar and place the new one in plugins/.
  4. Start the server and watch console for update messages.

Config and database updates are automatic: config.yml gets new options with defaults while preserving existing settings (no manual migration); database schema/tables update on startup with data preserved (no manual SQL needed).

Version Compatibilityโ€‹

  • Breaking changes: possible in major version updates - review config changes, test on a dev server first, check release notes.
  • Backward compatibility: config files keep working with old keys; database migrations are automatic; deprecated API methods remain until the next major version.

Update Checklistโ€‹

Before updatingAfter updating
Read changelogVerify plugin loads successfully
Backup plugin folderCheck console for errors
Backup database.dbTest basic functionality (/orders)
Test on dev server if availableVerify configuration still works
Note current version for rollbackCheck database integrity

Rollback Procedureโ€‹

  1. Stop the server.
  2. Restore the backup:
    rm -rf plugins/SigmaOrders
    cp -r plugins/SigmaOrders.backup plugins/SigmaOrders
  3. Restore the database if needed: cp plugins/SigmaOrders.backup/database.db plugins/SigmaOrders/
  4. Start the server and report the issue if applicable.

Update Notificationsโ€‹

The plugin checks for updates on startup via its manifest system and prints notifications to console on each server start.

Development/snapshot builds may be unstable - backup more frequently and test thoroughly before production use.

See Alsoโ€‹