Merge pull request #616 from lukaszstolarczuk/update-versioning

ldorau · web-flow · commit ac26c57def98 · 2024-07-18T11:45:15.000+02:00
[CMake] Update versioning
diff --git a/.github/workflows/bandit.yml b/.github/workflows/bandit.yml
@@ -24,6 +24,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Install Bandit
       run: python3 -m pip install bandit
diff --git a/.github/workflows/basic.yml b/.github/workflows/basic.yml
@@ -74,6 +74,8 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Install apt packages
       run: |
@@ -180,6 +182,8 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Initialize vcpkg
       uses: lukka/run-vcpkg@5e0cab206a5ea620130caf672fce3e4a6b5666a1 # v11.5
@@ -250,6 +254,8 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Configure build
       run: >
@@ -290,6 +296,8 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Configure build
       run: >
@@ -325,6 +333,8 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Install Python requirements
       run: python3 -m pip install -r third_party/requirements.txt
diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml
@@ -27,6 +27,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          fetch-depth: 0
 
       - name: Install apt packages
         if: matrix.os == 'ubuntu-latest'
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -43,6 +43,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Initialize CodeQL
       uses: github/codeql-action/init@b7bf0a3ed3ecfa44160715d7c442788f65f0f923 # v3.23.2
diff --git a/.github/workflows/coverity.yml b/.github/workflows/coverity.yml
@@ -24,6 +24,7 @@ jobs:
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
       with: 
         ref: ${{ github.ref }}
+        fetch-depth: 0
 
     - name: Install apt packages
       run: |
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -21,6 +21,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Install doxygen
       run: |
diff --git a/.github/workflows/fast.yml b/.github/workflows/fast.yml
@@ -59,6 +59,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Initialize vcpkg
       if: matrix.os == 'windows-latest'
@@ -139,3 +141,11 @@ jobs:
       if: matrix.os == 'windows-latest'
       run: ${{github.workspace}}/.github/scripts/check_dll_flags.ps1 ${{env.BUILD_DIR}}/src/proxy_lib/Release/umf_proxy.dll
       shell: pwsh
+
+    # TODO: We could add some script to verify metadata of dll's (selected fields, perhaps)
+    # ref. https://superuser.com/questions/381276/what-are-some-nice-command-line-ways-to-inspect-dll-exe-details
+    - name: Print metadata of our dll's
+      if: matrix.os == 'windows-latest'
+      run: |
+        get-command ${{github.workspace}}/build/bin/Release/umf.dll | format-list
+        get-command ${{github.workspace}}/build/src/proxy_lib/Release/umf_proxy.dll | format-list
diff --git a/.github/workflows/gpu.yml b/.github/workflows/gpu.yml
@@ -36,6 +36,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          fetch-depth: 0
 
       - name: Get information about platform
         if: matrix.os == 'Ubuntu'
diff --git a/.github/workflows/multi_numa.yml b/.github/workflows/multi_numa.yml
@@ -20,6 +20,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          fetch-depth: 0
 
       - name: Get information about platform
         run: .github/scripts/get_system_info.sh
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
@@ -24,6 +24,8 @@ jobs:
       steps:
       - name: Checkout repository
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          fetch-depth: 0
 
       - name: Install apt packages
         run: |
@@ -59,6 +61,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Install apt packages
       run: |
diff --git a/.github/workflows/pr_push.yml b/.github/workflows/pr_push.yml
@@ -22,6 +22,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Install apt packages
       run: |
@@ -55,6 +57,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Install doxygen
       run: |
diff --git a/.github/workflows/proxy_lib.yml b/.github/workflows/proxy_lib.yml
@@ -25,6 +25,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          fetch-depth: 0
 
       - name: Install apt packages
         run: |
diff --git a/.github/workflows/qemu.yml b/.github/workflows/qemu.yml
@@ -17,6 +17,9 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
+
     - name: Enable KVM
       run: |
         echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
diff --git a/.github/workflows/sanitizers.yml b/.github/workflows/sanitizers.yml
@@ -23,6 +23,8 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Install apt packages
       run: |
@@ -88,6 +90,8 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     # Use the latest MSVC toolset available, when compiling UMF with ASan.
     # Running binaries compiled with older toolsets results in a
diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
@@ -27,6 +27,8 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Run analysis
       uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1
diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml
@@ -14,6 +14,8 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Run a spell check
       uses: crate-ci/typos@b63f421581dce830bda2f597a678cb7776b41877 # v1.18.2
diff --git a/.github/workflows/trivy.yml b/.github/workflows/trivy.yml
@@ -31,6 +31,8 @@ jobs:
     steps:
       - name: Clone the git repo
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          fetch-depth: 0
 
       - name: Run Trivy
         uses: aquasecurity/trivy-action@84384bd6e777ef152729993b8145ea352e9dd3ef # v0.17.0
diff --git a/.github/workflows/valgrind.yml b/.github/workflows/valgrind.yml
@@ -17,6 +17,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        fetch-depth: 0
 
     - name: Install apt packages
       run: |
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -3,32 +3,35 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
 cmake_minimum_required(VERSION 3.14.0 FATAL_ERROR)
-project(
-    umf
-    VERSION 0.1.0
-    LANGUAGES C)
-
 # needed when UMF is used as an external project
 set(UMF_CMAKE_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 
 list(APPEND CMAKE_MODULE_PATH "${UMF_CMAKE_SOURCE_DIR}/cmake")
-include(${UMF_CMAKE_SOURCE_DIR}/cmake/helpers.cmake)
+include(helpers)
+
+# We use semver aligned version, set via git tags. We parse git output to
+# establih the version of UMF to be used in CMake, Win dll's, and within the
+# code (e.g. in logger). We have 3-component releases (e.g. 1.5.1) plus release
+# candidates and git info. Function below sets all variables related to version.
+set_version_variables()
+message(STATUS "UMF version: ${UMF_VERSION}")
+
+# version we set in CMake is abbreviated just to major.minor.patch
+project(
+    umf
+    VERSION ${UMF_CMAKE_VERSION}
+    LANGUAGES C)
+
+if(CMAKE_PROJECT_VERSION_PATCH GREATER 0)
+    # set extra variable for Windows dll metadata
+    set(UMF_VERSION_BUGFIX 1)
+endif()
 
 include(CTest)
 include(CMakePackageConfigHelpers)
 include(GNUInstallDirs)
 find_package(PkgConfig)
 
-# CMAKE_PROJECT_VERSION[_MAJOR|_MINOR|_PATCH] variables are set via 'project'
-# command. They cannot contain any "pre-release" part, though. We use custom
-# "UMF_SRC_VERSION" to store more accurate (source) version - this var should be
-# used, e.g., for creating packages.
-set_source_version()
-message(
-    STATUS
-        "UMF version: ${CMAKE_PROJECT_VERSION} (source version: ${UMF_SRC_VERSION})"
-)
-
 # Build Options
 option(UMF_BUILD_SHARED_LIBRARY "Build UMF as shared library" OFF)
 option(UMF_BUILD_LEVEL_ZERO_PROVIDER "Build Level Zero memory provider" ON)
diff --git a/RELEASE_STEPS.md b/RELEASE_STEPS.md
@@ -40,7 +40,7 @@ Do changes for a release:
 - Add an entry to ChangeLog, remember to change the day of the week in the release date
   - For major releases mention API and ABI compatibility with the previous release
 - Update project's version in a few places:
-  - Set the new $VERSION in `project` function in the top-level `CMakeLists.txt`
+  - For major and minor releases: `UMF_VERSION_CURRENT` in `include/umf/base.h` (the API version)
   - `release` variable in `scripts/docs_config/conf.py` (for docs)
   - `UMF_VERSION` variable in `.github/workflows/basic.yml` (for installation test)
 - For major releases update ABI version in `.map` and `.def` files
diff --git a/cmake/helpers.cmake b/cmake/helpers.cmake
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
diff --git a/src/libumf.rc.in b/src/libumf.rc.in
diff --git a/src/pool/CMakeLists.txt b/src/pool/CMakeLists.txt
diff --git a/src/proxy_lib/CMakeLists.txt b/src/proxy_lib/CMakeLists.txt
diff --git a/src/proxy_lib/proxy_lib.rc.in b/src/proxy_lib/proxy_lib.rc.in
diff --git a/src/utils/CMakeLists.txt b/src/utils/CMakeLists.txt
diff --git a/src/utils/utils_log.c b/src/utils/utils_log.c
diff --git a/test/utils/utils_log.cpp b/test/utils/utils_log.cpp
