Merge pull request #8 from sodgeit/ci/more-cmake-versions-under-test

ci: testing more CMake versions

The CMake versions under test, are the versions available in the supported lts versions of Ubuntu, and the latest version.
Once support for a ubuntu version is dropped, the minimum cmake version of this
project will be updated.

Author: Avus-c

.github/workflows/cmake-multi-platform.yml

@@ -1,6 +1,6 @@
 # This starter workflow is for a CMake project running on multiple platforms. There is a different starter workflow if you just want a single platform.
 # See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-single-platform.yml
-name: CMake on multiple platforms
+name: test
 
 on:
   push:
@@ -16,33 +16,20 @@ jobs:
       # Set fail-fast to false to ensure that feedback is delivered for all matrix combinations. Consider changing this to true when your workflow is stable.
       fail-fast: false
 
-      # Set up a matrix to run the following 3 configurations:
-      # 1. <Windows, Release, latest MSVC compiler toolchain on the default runner image, default generator>
-      # 2. <Linux, Release, latest GCC compiler toolchain on the default runner image, default generator>
-      # 3. <Linux, Release, latest Clang compiler toolchain on the default runner image, default generator>
-      #
-      # To add more build types (Release, Debug, RelWithDebInfo, etc.) customize the build_type list.
+      # CMake versions under test are the versions available int the supported
+      # lts versions of Ubuntu, and the latest version.
+      # Once support for a ubuntu version is dropped, the minimum cmake version of this
+      # project will be updated.
       matrix:
         os: [ubuntu-latest, windows-latest]
-        build_type: [Release]
-        c_compiler: [gcc, clang, cl]
-        include:
-          - os: windows-latest
-            c_compiler: cl
-            cpp_compiler: cl
-          - os: ubuntu-latest
-            c_compiler: gcc
-            cpp_compiler: g++
-          - os: ubuntu-latest
-            c_compiler: clang
-            cpp_compiler: clang++
+        build_type: [Release, Debug]
+        cmake_version: ['3.16.3', # 20.04 LTS
+                        '3.22.1', # 22.04 LTS
+                        '3.28.3', # 24.04 LTS
+                        '3.30']
         exclude:
           - os: windows-latest
-            c_compiler: gcc
-          - os: windows-latest
-            c_compiler: clang
-          - os: ubuntu-latest
-            c_compiler: cl
+            cmake_version: '3.16.3' # there seems to be a bug with compiler detection
 
     steps:
     - uses: actions/checkout@v4
@@ -54,18 +41,24 @@ jobs:
       run: |
         echo "build-output-dir=${{ github.workspace }}/build" >> "$GITHUB_OUTPUT"
 
+    - name: Setup cmake
+      uses: jwlawson/[email protected]
+      with:
+        cmake-version: ${{ matrix.cmake_version }}
+
+    # print the cmake version
+    - name: Print CMake version
+      run: cmake --version
+
     - name: Configure CMake
-      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
-      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
       run: >
         cmake -B ${{ steps.strings.outputs.build-output-dir }}
-        -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }}
-        -DCMAKE_C_COMPILER=${{ matrix.c_compiler }}
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
         -S ${{ github.workspace }}
-
-    #- name: Build
-    #  run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }}
+      env:
+        CMAKE_VERSION: ${{ matrix.cmake_version }}
 
     - name: Install
       run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --target install
+      env:
+        CMAKE_VERSION: ${{ matrix.cmake_version }}

CMakeLists.txt

@@ -5,7 +5,7 @@
 # This file only performs a few sanity checks on the repo. No building is required to use the
 # cmake/*.cmake files.
 
-cmake_minimum_required(VERSION 3.14)
+cmake_minimum_required(VERSION 3.16)
 
 project(cmake-sbom)
 

cmake/sbom.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.16 FATAL_ERROR)
 
 # catch and stop second call to this function
 if(COMMAND sbom_generate)
@@ -599,13 +599,14 @@ function(_sbom_verify_filetype FILETYPE)
 	# https://spdx.github.io/spdx-spec/v2.3/file-information/#83-file-type-field
 	set(valid_entries "SOURCE" "BINARY" "ARCHIVE" "APPLICATION" "AUDIO" "IMAGE" "TEXT" "VIDEO" "DOCUMENTATION" "SPDX" "OTHER")
 	list(FIND valid_entries "${FILETYPE}" _index)
+
 	if(${_index} EQUAL -1)
 		message(FATAL_ERROR "Invalid FILETYPE: ${FILETYPE}")
 	endif()
 endfunction()
 
 # Append a file to the SBOM. Use this after calling sbom_generate().
-function(sbom_add_file FILENAME )
+function(sbom_add_file FILENAME)
 	set(options OPTIONAL)
 	set(oneValueArgs RELATIONSHIP SPDXID)
 	set(multiValueArgs FILETYPE)
@@ -691,11 +692,11 @@ function(sbom_add_target NAME)
 	get_target_property(_type ${NAME} TYPE)
 
 	if("${_type}" STREQUAL "EXECUTABLE")
-		sbom_add_file( ${CMAKE_INSTALL_BINDIR}/$<TARGET_FILE_NAME:${NAME}>
+		sbom_add_file(${CMAKE_INSTALL_BINDIR}/$<TARGET_FILE_NAME:${NAME}>
 			FILETYPE BINARY ${ARGN}
 		)
 	elseif("${_type}" STREQUAL "STATIC_LIBRARY")
-		sbom_add_file( ${CMAKE_INSTALL_LIBDIR}/$<TARGET_FILE_NAME:${NAME}>
+		sbom_add_file(${CMAKE_INSTALL_LIBDIR}/$<TARGET_FILE_NAME:${NAME}>
 			FILETYPE BINARY ${ARGN}
 		)
 	elseif("${_type}" STREQUAL "SHARED_LIBRARY")
@@ -719,7 +720,6 @@ function(sbom_add_target NAME)
 	endif()
 
 	set(SBOM_LAST_SPDXID "${SBOM_LAST_SPDXID}" PARENT_SCOPE)
-
 endfunction()
 
 # Append all files recursively in a directory to the SBOM. Use this after calling sbom_generate().
@@ -787,7 +787,6 @@ Relationship: ${SBOM_DIRECTORY_RELATIONSHIP}-\${_count}
 	install(SCRIPT ${CMAKE_CURRENT_BINARY_DIR}/${SBOM_DIRECTORY_SPDXID}.cmake)
 
 	set(SBOM_LAST_SPDXID "" PARENT_SCOPE)
-
 endfunction()
 
 # Append a package (without files) to the SBOM. Use this after calling sbom_generate().
@@ -900,7 +899,6 @@ Relationship: ${SBOM_PACKAGE_SPDXID} CONTAINS NOASSERTION
 	)
 
 	set(SBOM_LAST_SPDXID "${SBOM_LAST_SPDXID}" PARENT_SCOPE)
-
 endfunction()
 
 # Add a reference to a package in an external file.

example/CMakeLists.txt

@@ -5,8 +5,7 @@
 # ##################################################################################################
 # Preamble
 
-cmake_minimum_required(VERSION 3.7.1)
-cmake_policy(VERSION 3.7.1)
+cmake_minimum_required(VERSION 3.16)
 
 project(example-project)