OpenFin

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 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 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, 5.44.12. retrieves 5.44.12.27 when utilizing OpenFin’s CDN to host your Runtime assets because that is the greatest available version.

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

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, >=5 retrieves 6.49.15.18 when utilizing OpenFin’s CDN to host your runtime assets.

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

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

More examples…

Operators Semantic Version Retrieved Version
* 5.44.7.* 5.44.7.17
* 5.44.* 5.44.12.27
* 5.* 5.44.12.27
* 6.49.12.* 6.49.12.139
* 6.* 6.49.15.18
>= >=5.44.12 6.49.15.18
>= >=6.49.12 6.49.15.18
>= >=6 6.49.15.18

Note: Dated Information

These examples are based on the assetsUrl in your application config pointing to OpenFin’s CDN as of Dec 20, 2016.

Runtime version file

If, as an application owner, 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.

6.49.15.18
6.49.12.139
5.44.12.27
5.44.12.21
5.44.12.12
5.44.11.10
5.44.10.18
5.44.9.2

Have questions? Get in touch with us at support@openfin.co.


What's Next

For more information about hosting your own assets, please see our documentation on Hosting Assets.

Hosting Runtimes, RVM, and Other Assets

Semantic Versioning


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.