Versioning

Versioning

To ensure consistency in managing VIP application versions and their Boutiques descriptors, we define:

• $AppName: a descriptor name field
• $AppVersion: a descriptor tool-version field

When importing an app in VIP, $AppName and $AppVersion are restricted to the following characters:

• alphanumerical characters [0-9A-Za-z]
• U+0020 space
• U+002B plus +
• U+002D hyphen-minus -
• U+002E dot .
• U+0040 at @
• U+005F underscore _

Other UTF-8 characters are not allowed in these two fields.

In addition, using space in filenames is not recommended, so when naming a descriptor file, we define:

• $AppFileName: $AppName where space has been replaced with underscore _
• $AppFileVersion: $AppName where space has been replaced with underscore _

A boutiques descriptor file in the vip-apps-boutiques-descriptors repository must be named exactly: $AppFileName-$AppFileVersion.json

Convention for Boutiques Descriptor Versions

• The application version number remains unchanged.
• A suffix is added to indicate the version of the Boutiques descriptor.
• The first version of the descriptor has no suffix.
• Subsequent versions of the descriptor are incremented with the suffix "-1", "-2", etc.

Example

If the Freesurfer application is version "6.5", then:

• The first version of the descriptor will be: "6.5", with descriptor filename Freesurfer-6.5.json.
• An updated descriptor version will be: "6.5-1", with descriptor filename Freesurfer-6.5-1.json.
• A second descriptor update will be: "6.5-2", with descriptor filename Freesurfer-6.5-2.json.