Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Embedded Version Number (2.0.0-alpha) #596

Merged
merged 3 commits into from
Jul 27, 2021
Merged

Embedded Version Number (2.0.0-alpha) #596

merged 3 commits into from
Jul 27, 2021

Conversation

ptheywood
Copy link
Member

@ptheywood ptheywood commented Jul 16, 2021

Embeds the FLAME GPU version number in the c++ headers and python module.

  • Define the Major, Minor, Patch and Pre-release version components in CMake
    • Initially 2.0.0-alpha, to be followed by 2.0.0-alpha.1, 2.0.0-beta[.N], 2.0.0-pr.N and then 2.0.0
    • For now this will be defined in CMake rather than the header file itself, which is currently dynamically generaetd
  • Embed the version number as a macro in a header file
    • FLAMEGPU_VERSION - a 7+ digit integer endcoding major, minor and patch, if multiple API versions are intended to be supported
  • static constexpr for MAJOR, MINOR, PATCH, PRERELEASE and BUILDMETADATA in the flamegpu namespace
    • BUILDMETADATA is the old git commit hash.
  • Embed the namespaced members into the python wheel
  • Factor in the release version number in RTC comparisons, including the metadata.
  • Document how the version numbers work (SemVer, -alpha[.N] for very early pre-releases, -rc[.x] for almost stable releases candidates
  • Rename flamegpu2 CMake target to flamegpu, as it will/may eventually become 3.x.y

This will close #591 and close #163.

In the future, the location of the version definiation, and checking of the include directory metadata may change (see #600)

cmake/version.cmake Outdated Show resolved Hide resolved
@ptheywood ptheywood marked this pull request as ready for review July 21, 2021 16:32
Also renames / adjusts the tempdirectory and FLAMEGPU_TMP_DIR environment variable
This is is to avoid having to make this change once the first API break occurs
@ptheywood ptheywood merged commit e5ff599 into master Jul 27, 2021
@ptheywood ptheywood deleted the embedded-version branch July 27, 2021 12:31
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Embeded Version Number Project Rename / Version numbering
2 participants