Versioning

With the new update, notification, features, CricketUI will check GitHub at every startup and compare the current version to the latest release tag. We must be very strict with how we handle versioning and releases. These are my thoughts and partly documentation to how the notifications work.

Stable releasing

Stable releasing

   Application Name = "UI3141-3201"
   tag = "V1.0.0"

This shows the application name, version and the tag Stable. This is already done, and nothing new needs to happen. However, after a stable release is made, increment version by one and tag = "git" to signify development of the next version. This is very important, otherwise things may break in the updater logic.

   Application Name = "Cricket"
   tag = "V2.0.0"

This shows the application name, version and the tag Stable. This is already done, and nothing new needs to happen. However, after a stable release is made, increment version by one and tag = "git" to signify development of the next version.

   Application Name = "Cricket"
   tag = "V2.2.0"

This shows the application name, version and the tag Stable. This is already done, in this release version updated Python Pep8 standard and release in Raspberry PI OS. However, after a stable release is made, increment version by one and tag = "git" to signify development of the next version.

   Application Name= "Cricket"
   tag = "V2.3.0"

This shows the application name, version and the tag Stable. This is already done, in this release version added Model2301 Connection Exerciser. However, after a stable release is made, increment version by one and tag = "git" to signify development of the next version.

   Application Name= "Cricket"
   tag = "V2.4.0"

This shows the application name, version and the tag Stable. This is already done, in this release version Add new feature support for Three computer System and Two Computer System . However, after a stable release is made, increment version by one and tag = "git" to signify development of the next version.

   Application Name= "Cricket"
   tag = "V2.5.0"

This shows the application name, version and the tag Stable. This is already done, in this release version Feature added-Plotting of VBUS VI, USB Tree View removed and merged to logwindow. . However, after a stable release is made, increment version by one and tag = "git" to signify development of the next version.

Use cases:

clone from github using tag_name please reffer the git clonecommand

   git clone --recursive https://github.com/mcci-usb/COLLECTION-cricket-ui.git --branch <tag_name> --single-branch

These are cases that need to be checked for proper notifications

• Old release (v1.0.0 - Stable) to new release (v2.0.0 - Stable).
  • This is why it in important to increment version by 1 immediately after release and tag it as git. Singularity still has this git tag and UI version, and so it will compare the release and the internal version - if the internal version is the same or higher, then that means there is a stable release that should supersede current Singularity release.
• CricketUI release (v2.0.0 - git) to stable release (v2.2.0 - Stable)
• CricketUI releasing (v2.2.0 - git) to statble release(v2.3.0 - Stable)
• CricketUI releasing (v2.3.0 - git) to statble release(v2.4.0 - Stable)
• CricketUI releasing (v2.4.0 - git) to statble release(v2.5.0 - Stable)