From 7c7fc38532f130fb378c327cb633a38909001d21 Mon Sep 17 00:00:00 2001 From: Chadwick Boulay Date: Mon, 2 Nov 2026 02:09:31 -0500 Subject: [PATCH] Derive the project version from the git tag; bump to 3.0.0 project() VERSION now comes from the nearest v*/numeric git tag via cmake/ProjectVersion.cmake (same approach as App-LabRecorder), falling back to a literal for source archives without .git. CPack uses the full tag so pre-release suffixes (e.g. 3.0.0b1) survive into package names, and Debian prereleases sort before the final release. The fallback is 3.0.0: NA500 (GES 500) support warranted a major bump. CI checkout now fetches full history so tags are visible. Co-Authored-By: Claude --- .github/workflows/build.yml | 2 ++ CMakeLists.txt | 16 +++++++--- cmake/ProjectVersion.cmake | 62 +++++++++++++++++++++++++++++++++++++ 3 files changed, 76 insertions(+), 4 deletions(-) create mode 100644 cmake/ProjectVersion.cmake diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3c11085..3b2098e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -46,6 +46,8 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 + with: + fetch-depth: 0 # ----------------------------------------------------------------------- # Install CMake 3.28+ (Ubuntu 22.04 ships with 3.22) diff --git a/CMakeLists.txt b/CMakeLists.txt index 1022c4e..b72b7e7 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -5,11 +5,15 @@ if(POLICY CMP0177) cmake_policy(SET CMP0177 NEW) endif() +# Keep the fallback current when tagging releases: source archives have no .git. +include(cmake/ProjectVersion.cmake) +egiamp_version_from_git(EGIAMP_VERSION EGIAMP_VERSION_FULL FALLBACK "3.0.0") + project(EGIAmpServer + VERSION ${EGIAMP_VERSION} DESCRIPTION "EGI AmpServer to LSL bridge" HOMEPAGE_URL "https://github.com/labstreaminglayer/App-EGIAmpServer/" - LANGUAGES CXX - VERSION 2.2.0) + LANGUAGES CXX) set(CMAKE_CXX_STANDARD 20) set(CMAKE_CXX_STANDARD_REQUIRED ON) @@ -226,11 +230,11 @@ LSL_get_target_arch() LSL_get_os_name() set(CPACK_PACKAGE_NAME "${PROJECT_NAME}") -set(CPACK_PACKAGE_VERSION "${PROJECT_VERSION}") +set(CPACK_PACKAGE_VERSION "${EGIAMP_VERSION_FULL}") set(CPACK_PACKAGE_VENDOR "Labstreaminglayer") set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "${PROJECT_DESCRIPTION}") set(CPACK_PACKAGE_HOMEPAGE_URL "${PROJECT_HOMEPAGE_URL}") -set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${PROJECT_VERSION}-${LSL_OS}_${LSL_ARCH}") +set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${EGIAMP_VERSION_FULL}-${LSL_OS}_${LSL_ARCH}") set(CPACK_STRIP_FILES ON) if(WIN32) @@ -239,6 +243,10 @@ elseif(APPLE) set(CPACK_GENERATOR TGZ) else() set(CPACK_GENERATOR DEB TGZ) + # Debian prereleases must sort before the corresponding stable release. + string(REGEX REPLACE + "^([0-9]+\\.[0-9]+\\.[0-9]+)[.-]?((alpha|beta|rc|a|b)[0-9]+)$" + "\\1~\\2" CPACK_DEBIAN_PACKAGE_VERSION "${EGIAMP_VERSION_FULL}") set(CPACK_DEBIAN_PACKAGE_MAINTAINER "LabStreamingLayer Developers") set(CPACK_DEBIAN_PACKAGE_SECTION "science") set(CPACK_DEBIAN_FILE_NAME "${CPACK_PACKAGE_FILE_NAME}.deb") diff --git a/cmake/ProjectVersion.cmake b/cmake/ProjectVersion.cmake new file mode 100644 index 0000000..710d1ca --- /dev/null +++ b/cmake/ProjectVersion.cmake @@ -0,0 +1,62 @@ +# ProjectVersion.cmake +# Derive the project version from the most recent git tag. +# +# Tags may be `3.0.0`, `v3.0.0`, or prereleases such as `v3.0.0b1`. This module +# turns the nearest such tag into: +# - a strict MAJOR.MINOR.PATCH string suitable for project(... VERSION ...) +# - the full tag (sans leading `v`), preserving any pre-release suffix, for +# packaging metadata. +# +# It must be included and called BEFORE project(), since project() needs the +# numeric version. When git or a matching tag is unavailable (release tarballs, +# shallow clones without tags, FetchContent on an exported tree) it falls back +# to the supplied literal so the source tree always builds. +# +# Usage: +# include(cmake/ProjectVersion.cmake) +# egiamp_version_from_git(EGIAMP_VERSION EGIAMP_VERSION_FULL FALLBACK "3.0.0") +# project(EGIAmpServer VERSION ${EGIAMP_VERSION} ...) +# +# A version can be forced (e.g. from CI) by passing -DEGIAMP_VERSION_OVERRIDE=3.0.0b1. + +function(egiamp_version_from_git out_numeric out_full) + cmake_parse_arguments(ARG "" "FALLBACK" "" ${ARGN}) + + set(_ver "") + if(EGIAMP_VERSION_OVERRIDE) + string(REGEX REPLACE "^v" "" _ver "${EGIAMP_VERSION_OVERRIDE}") + message(STATUS "EGIAmpServer: using EGIAMP_VERSION_OVERRIDE=${_ver}") + else() + # Do not accidentally use a parent repository when building an extracted archive. + find_package(Git QUIET) + if(Git_FOUND AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/.git") + execute_process( + COMMAND ${GIT_EXECUTABLE} describe --tags --abbrev=0 --match "v[0-9]*" --match "[0-9]*" + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + OUTPUT_VARIABLE _tag + OUTPUT_STRIP_TRAILING_WHITESPACE + ERROR_QUIET + RESULT_VARIABLE _res + ) + if(_res EQUAL 0 AND _tag) + string(REGEX REPLACE "^v" "" _ver "${_tag}") + endif() + endif() + endif() + + if(NOT _ver) + set(_ver "${ARG_FALLBACK}") + message(STATUS "EGIAmpServer: no git tag found; using fallback version ${_ver}") + endif() + + # Strict numeric MAJOR.MINOR.PATCH for project(VERSION); ignore any suffix. + if(_ver MATCHES "^([0-9]+)\\.([0-9]+)\\.([0-9]+)") + set(${out_numeric} "${CMAKE_MATCH_1}.${CMAKE_MATCH_2}.${CMAKE_MATCH_3}" PARENT_SCOPE) + set(${out_full} "${_ver}" PARENT_SCOPE) + message(STATUS "EGIAmpServer version: ${_ver}") + else() + message(WARNING "EGIAmpServer: version '${_ver}' is not MAJOR.MINOR.PATCH; using ${ARG_FALLBACK}") + set(${out_numeric} "${ARG_FALLBACK}" PARENT_SCOPE) + set(${out_full} "${ARG_FALLBACK}" PARENT_SCOPE) + endif() +endfunction()