Now set project version in cmake automatically using git tag (#153)

* new version.h.in template, which gets set by new function in CMakeLists

* do a full checkout for all workflows

Author: ewanwm

.github/workflows/CI-Python.yaml

@@ -19,6 +19,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
 
     - uses: actions/setup-python@v5
       with:

.github/workflows/CI-cpp.yml

@@ -46,6 +46,8 @@ jobs:
     steps:
     # this Action should follow steps to set up Python build environment
     - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
 
     - name: Install Protoc Windows
       if: ${{ startsWith(matrix.OS, 'windows') }}

.github/workflows/Lint-cpp-main.yaml

@@ -10,6 +10,8 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
 
       - name: Set Flags
         run: export USE_CUDA=0

.github/workflows/Lint-cpp.yaml

@@ -12,6 +12,8 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
 
       - name: Set Flags
         run: export USE_CUDA=0

.github/workflows/benchmarking-track-main.yaml

@@ -16,6 +16,9 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          
       - uses: bencherdev/bencher@main
 
       - name: Set Flags

.github/workflows/benchmarking.yaml

@@ -26,6 +26,9 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          
       - uses: bencherdev/bencher@main
 
       - name: Set Flags

.github/workflows/deployment-docs.yml

@@ -25,6 +25,8 @@ jobs:
 
       # Checks-out repository
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Install dependencies
         run: |

.github/workflows/pypi-distribution-reusable.yaml

@@ -16,6 +16,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
 
     ## runner will run out of space if we don't clear some up by removing some unused tools
     - name: Clear space

CMakeLists.txt

@@ -7,8 +7,64 @@ if(NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
   set(CMAKE_CUDA_ARCHITECTURES 75)
 endif()
 
+# function to get the project version from the most recent git tag
+function(get_version_from_git)
+    find_package(Git QUIET)
+    if(NOT Git_FOUND)
+        message(WARNING "Git not found")
+        return()
+    endif()
+
+    execute_process(
+        COMMAND ${GIT_EXECUTABLE} describe --tags --always
+        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+        OUTPUT_VARIABLE GIT_TAG
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+        RESULT_VARIABLE GIT_RESULT
+    )
+
+    if(NOT GIT_RESULT EQUAL 0)
+        message(WARNING "Failed to get git tag")
+        return()
+    endif()
+
+    execute_process(
+        COMMAND ${GIT_EXECUTABLE} rev-parse --short=7 HEAD
+        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+        OUTPUT_VARIABLE GIT_COMMIT_SHORT_HASH
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+    )
+
+    string(REGEX REPLACE "^v" "" CLEAN_TAG "${GIT_TAG}")
+    if(CLEAN_TAG MATCHES "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(-.*)?$")
+
+        set(PROJECT_VERSION_MAJOR ${CMAKE_MATCH_1})
+        set(PROJECT_VERSION_MAJOR ${CMAKE_MATCH_1} PARENT_SCOPE)
+        set(PROJECT_VERSION_MINOR ${CMAKE_MATCH_2})
+        set(PROJECT_VERSION_MINOR ${CMAKE_MATCH_2} PARENT_SCOPE)
+        set(PROJECT_VERSION_PATCH ${CMAKE_MATCH_3})
+        set(PROJECT_VERSION_PATCH ${CMAKE_MATCH_3} PARENT_SCOPE)
+
+        set(FULL_VERSION "${CMAKE_MATCH_1}.${CMAKE_MATCH_2}.${CMAKE_MATCH_3}+${GIT_COMMIT_SHORT_HASH}")
+        set(FULL_VERSION "${CMAKE_MATCH_1}.${CMAKE_MATCH_2}.${CMAKE_MATCH_3}+${GIT_COMMIT_SHORT_HASH}" PARENT_SCOPE)
+        set(PROJECT_VERSION "${CMAKE_MATCH_1}.${CMAKE_MATCH_2}.${CMAKE_MATCH_3}") 
+        set(PROJECT_VERSION "${CMAKE_MATCH_1}.${CMAKE_MATCH_2}.${CMAKE_MATCH_3}" PARENT_SCOPE)
+    else()
+        message(WARNING "Tag '${CLEAN_TAG}' does not match semver format")
+    endif()
+endfunction()
+
 # set the project name and version
-project(nuTens VERSION 0.4.0)
+get_version_from_git()
+message(INFO "nuTens PROJECT_VERSION: ${PROJECT_VERSION}")
+project(nuTens VERSION ${PROJECT_VERSION})
+
+# configure the version.h file with all above version info
+configure_file(
+    ${PROJECT_SOURCE_DIR}/cmake/templates/version.h.in
+    ${PROJECT_BINARY_DIR}/include/version.h
+)
+
 
 # Changes default install path to be a subdirectory of the build dir.
 # Can set build dir at configure time with -DCMAKE_INSTALL_PREFIX=/install/path

cmake/templates/version.h.in

@@ -0,0 +1,7 @@
+#pragma once
+
+#define PROJECT_VERSION_MAJOR @PROJECT_VERSION_MAJOR@
+#define PROJECT_VERSION_MINOR @PROJECT_VERSION_MINOR@
+#define PROJECT_VERSION_PATCH @PROJECT_VERSION_PATCH@
+#define PROJECT_VERSION "@PROJECT_VERSION@"
+#define FULL_VERSION "@FULL_VERSION@"