eez-open / modular-psu-firmware

Firmware for EEZ Bench Box 3 (BB3)
https://www.envox.eu/eez-bb3/
GNU General Public License v3.0
94 stars 42 forks source link

Versioning scheme and (in)compatible changes #293

Open fietser28 opened 2 years ago

fietser28 commented 2 years ago

The current development version of the firmware (1.8) is not compatible with the V2 resource files for python scripts generated with studio that are being used with versions <1.8. When upgrading from 1.7 to 1.8 a user has to be recompiled and uploaded to the BB3 to make sure the resource files are V3. I think this can be seen as binary incompatible. This situation might confuse users (it is not a major upgrade).

A common way to look at this is semantic versioning (semver.org) with MAJOR.MINOR.PATCH version numbers. With semantic versioning an new version with binary incompatibility becomes a new MAJOR version (e.g. 2.0.0)

There are several ways to avoid this situation with the BB3: