Module versioning and updates

Module versioning

The SpotMe modules, when updates are made, follow a set of specific rules when it comes to updating the version numbers.

These rules are applied to all module version numbers. The version number is therefore written as major.minor.patch (for example v4.12.3), and when our team is releasing a new version of a module, the new version number is decided based on these rules:

• major (v4.12.3): A change of the major indicates an entirely new version of the module.
  Example: The change results invariably in a user interface or experience change for app users on mobile or web app, or a module's default email template, that is used to communicate with the attendees, has been modified or added.
  
  
• minor (v4.12.3): A change of the major indicates a new capability was added to the module.
  Example: The change results in an optional user interface or experience change for app users, that can be enabled via a dedicated Backstage setting (that by default is not enabled), and that by default does not impact app users.
  
  
• patch (v4.12.3): A change of the patch indicates an unnoticeable change.
  Example: The change does not result in a user interface or experience change for app users.

Module updates in workspaces and templates

Patch version updates are pushed automatically for any non-live workspaces and all templates.

For live workspaces, no version updates are pushed automatically. A notification will appear in the workspace Marketplace mentioning that an update is pending, for any patch, minor, or major version updates. The user will need to update the workspace’s modules in the Marketplace.

For workspace templates, no version updates are pushed automatically. A notification will appear in the workspace template’s Marketplace mentioning that an update is pending, for any patch, minor, or major version updates.

For any newly created workspaces that are created using a workspace template, the newly created workspace will take all the modules that are present in the template, and will automatically update them with all the latest minor updates and patches that are available.
If a major update is available for a module in the template (and the template is not updated with it), it will not be automatically deployed to the newly created workspace.

Best practices for module updates

With regards to module updates, please make sure that you:

• Update your workspace templates as soon as possible, and always test to make sure that any implemented changes or new functionalities described in the release notes are working as expected.
• Update your workspaces before the event goes live, and always test to make sure that any implemented changes or new functionalities described in the release notes are working as expected.
• Take into consideration any potential compliance reviews that may take place days or weeks before the app is due to go live, as updating modules after the approval/review may have an impact on the workspace and make changes that are outside of what was approved/reviewed.

If the event is live or in the invitation phase (if the initial invitation emails were already sent to the attendees, or whenever any attendee can reach any part of the app or registration page), do not update the modules unless specifically recommended by the SpotMe Team.

It is important to keep in mind that new functionalities or changes that are implemented as part of a module update can introduce new behaviours that, depending on your existing workspace configuration, may impact your event.

For more information on how to install and update modules, please refer to Installing and updating modules from the Marketplace.