Skip to content

Dev: Versioning

markusTraber edited this page Jun 18, 2020 · 5 revisions

Version Number

For IVA, we will be using a three-part version number: Major version, minor version and patch. This versioning system is basically a Semantic Versioning System, without having a public API.

Examples for Version numbers:

  • 1.43.3
  • 0.1.0
  • 5.2.1

Major version

The major version is shown in the first part of the version number. It indicates major (feature) changes to the software. For IVA this means for example, a new audiovisual output has been added, the overall architecture of the app changed or the UX significantly changed.

Specifically for the "Semantic Versioning System", it indicates that changes to the public API have been made, that are not backwards compatible.

Minor version

The minor version is shown in the second part of the version number. It indicates minor (feature) changes to the software. This could be for example smaller features, like adding some GUI elements or improving performance.

Specifically for the "Semantic Versioning System", it indicates that changes to the public API have been made, which are backwards compatible.

Patch version

The patch version is shown in the third part of the version number. It indicates only bugs, that have been fixed.

Releases and Tags

For each release, we will use the inbuilt "Release" function of Github. A tag based on the version number will be created automatically. For the version number follow the aboved described versioning system.