Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Multiple sources of project's version #372

Open
louis-langholtz opened this issue Nov 6, 2020 · 2 comments
Open

Multiple sources of project's version #372

louis-langholtz opened this issue Nov 6, 2020 · 2 comments
Assignees
Labels
Enhancement For suggestions or changes that enhance any part of the project and isn't a bug. Help Wanted For things that other people are encouraged to help with.
Milestone

Comments

@louis-langholtz
Copy link
Owner

Expected/Desired Behavior or Experience:

There's only a single source for what the project's version is or is supposed to be.

Actual Behavior:

There are multiple sources of the project's version:

  1. CMakeLists.txt.
  2. Documentation/Doxyfile.
  3. PlayRho/Common/Version.cpp.
  4. UnitTests/Version.cpp.
  5. git itself is also a source of the version via git tags.

This obviously complicates versioning which in turn complicates making new releases.

@louis-langholtz louis-langholtz added the Enhancement For suggestions or changes that enhance any part of the project and isn't a bug. label Nov 6, 2020
@louis-langholtz louis-langholtz added this to the 0.99 Beta Launch milestone Nov 6, 2020
@louis-langholtz louis-langholtz self-assigned this Nov 6, 2020
@louis-langholtz
Copy link
Owner Author

Regarding git, I'm interested in Google benchmark's mechanism for getting version information from git. Their top-level CMakeLists.txt does:

# Read the git tags to determine the project version
include(GetGitVersion)
get_git_version(GIT_VERSION)

# Tell the user what versions we are using
string(REGEX MATCH "[0-9]+\\.[0-9]+\\.[0-9]+" VERSION ${GIT_VERSION})
message(STATUS "Version: ${VERSION}")

louis-langholtz added a commit that referenced this issue Nov 7, 2020
Addresses #372: Multiple sources of project's version.
@louis-langholtz louis-langholtz added the Help Wanted For things that other people are encouraged to help with. label Nov 7, 2020
@louis-langholtz
Copy link
Owner Author

Remaining after merging Updates 20201105...

  1. CMakeLists.txt.
  2. git itself is also a source of the version via git tags.

Could take the version from git but then I'm wondering where non-git distributions get the version from. Keeping this issue open for now and marking with help-wanted.

@louis-langholtz louis-langholtz modified the milestones: 0.99 Beta Launch, 1.0+ Nov 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement For suggestions or changes that enhance any part of the project and isn't a bug. Help Wanted For things that other people are encouraged to help with.
Projects
None yet
Development

No branches or pull requests

1 participant