Versioning

[lilleyse]

This project is composed of a few different parts:

• C++ library for streaming 3D Tiles into a USD stage
• Python library that wraps the C++ streaming library
• Omniverse Kit extension - front-end UI that can be added to Omniverse Code, Omniverse Create
• ... future libraries
• ... future kit extensions

Are these versioned separately or together? The kit extension version is here and the change log is here. This is what's shown when loading the extension in Omniverse Code/Create. Meanwhile the C++ library version is here. If we want to version everything together we need to be careful that these don't get out of sync.

I think it makes more sense if the C++/Python library are versioned separately from the Kit extensions since the C++ library may have users outside of the Omniverse ecosystem.

[lilleyse]

Semantic versioning is required for Omniverse Kit extensions:

From https://docs.omniverse.nvidia.com/py/kit/docs/guide/extensions.html#extension-dependencies

It is important to keep extensions versioned properly and express breaking changes using Semantic Versioning.

From https://github.com/NVIDIA-Omniverse/kit-extension-template#sharing-extensions:

For each new release increment extension version (in extension.toml) and update the changelog (in docs/CHANGELOG.md). Semantic versionning must be used to express severity of API changes.

[lilleyse]

A few other things to add here:

• We don't have a Python API yet but that will factor into versioning: Python API #12
• The C++ code is a carbonite plugin that may be versioned separately depending on ABI breakages: http://omniverse-docs.s3-website-us-east-1.amazonaws.com/carbonite/142.0-pre/docs/carb/Framework.html#versioning