Semantic Versioning

Overview

OpenFin’s Runtime Version Manager (RVM) supports semantic versioning for applications tested and verified to run in multiple OpenFin Runtime versions. This feature is especially useful for Application Providers who need to target OpenFin Runtimes that are hosted within a Desktop Owner’s environment. In these cases, it is possible that a Desktop Owner is only hosting 4-6 approved Runtime versions for use within their infrastructure.

Operators

Application providers can designate the valid Runtime versions utilizing two sets of operators in the version property of the Runtime object of their application config:

WildCard (*)

To be used in any digit grouping and with a partial version of the Runtime. Using * indicates to the RVM to obtain the greatest available version for that specified grouping + wildcard. For example, 16.83.53.* retrieves 16.83.53.26 when utilizing OpenFin’s CDN to host your Runtime assets because that is the greatest available version.

Wildcard example

},
"assetsUrl": "http://cdn.openfin.co/release/runtime/",
"runtime": {
    "version": "16.83.53.*",
},

Greater Than Or Equals To (>=)

To be used before the first digit of a version and can be used with a partial version. Using >= indicates to the RVM to obtain the greatest available version, with consideration to a minimum version. For example, >=15 retrieves 16.83.53.26 (as of SEP 1, 2020) when utilizing OpenFin’s CDN to host your runtime assets.

},
"assetsUrl": "http://cdn.openfin.co/release/runtime/",
"runtime": {
    "version": ">=15",
},

Visit our Runtime versions page for a list of available ‘stable’ Runtime versions.

More examples…

Operators
*
*
*
>=
>=
>=

🚧

Note: Dated Information

These examples are based on the assetsUrl in your application config pointing to OpenFin’s CDN as of SEP 1, 2020.

Runtime version file

If, as an Application Provider, you are hosting your own assets and desire to take advantage of semantic versioning, a file of all available runtime versions needs to be specified under the location where you store OpenFin runtime assets.

HOSTED_URL/release/runtimeVersions

The file must contain all available versions separated by a new line. Here is an example set from OpenFin’s Runtime Versions file, located here.

16.83.53.26
16.83.52.32
16.83.51.26
15.80.50.54
15.80.49.30
15.80.48.13
14.78.47.23

Have questions? Get in touch with us at [email protected].


Did this page help you?