Follow

Module versioning

SpotMe modules use the concept of semantic versioning for version numbers.

Using same rules for designating version numbers across modules allows us to know what kind of changes the update is going to bring simply by looking at the version number.

Every version number at SpotMe consists of three parts (numbers):

  • major: indicates an incompatible change
  • minor: indicates a new capability, reset to 0 if major was increased
  • patch: indicates a bug fix, reset to 0 if minor was increased

This is then simply written as major.minor.patch (ex. 4.12.3).

When our team is releasing a new version of a module, the version number is decided based on those rules.

Why does this matter?

While we generally do not recommend to update modules on a live instance, in some occurrences you might want to do so to either fix a bug or enable new functionalities. If you do decide to update a module on a live instance so it is important to know what kind of changes might occur after the update.

Examples

  • Updating package from v3.2.1 to v3.2.2 means the new version includes only bug fixes. This is safe.
  • Updating package from v3.2.1 to v3.3.0 means the update includes a brand new capability. This is generally safe, but it might also change or rename existing capabilities.
  • Updating package from v3.2.1 to v4.0.0 means the new version is not compatible with previous one, either the data format, settings or functionality have changed drastically. This is not a safe update unless otherwise noted. Backstage will warn you before doing an update like this.
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.