keithm-xmos
commented
1 year ago Below are some ideas that pop to mind. We will need to investigate these a bit and document a recommended solution.
- CMake's FetchContent supports cloning (recursively if needed) the SDK repo and checking out a SHA or tag. This happens at configure-time which could make for sad users if they need to re-configure many times. But, if only a single configure is typical, this is a reasonable solution. We would want to verify this works as expected.
- The version string is in the settings.json file. We could add a CMake macro to read and parse this.
- It is also possible that CMake has machinery for this already. Will need to investigate.
xhuw
Thank you for submitting an SDK feature request. Please provide as much information you can.
Describe the feature
For my project we do not intend to distribute a copy of the SDK with the source code. This means we will be relying on customers downloading the correct version of the SDK. I want the build to fail with a sensible message if they have downloaded an unsupported version.
I could manually parse the changelog or the latest git tag. But both of these options are brittle to change.
I don't know if there is a proper cmake way to support this. Any solution that lets me query the version of the SDK at configure time is good. Or perhaps specify the required version and the SDK could fail when it notices it isn't that version.
Will this change any current APIs? How?
no, I think this should be an additive feature
Who will benefit with this feature?
me :) anyone writing a project using the SDK that wants deterministic builds but doesn't want to submodule the SDK
Any Other info
low priority. If this feature request is accepted then before the end of the year would be best. If not I will parse the changelog