Extend check template script to be aware of multiple cmake-init branches

Author: scheibel

CMakeLists.txt

@@ -57,6 +57,7 @@ set(META_VERSION_REVISION    "${GIT_REV}")
 set(META_VERSION             "${META_VERSION_MAJOR}.${META_VERSION_MINOR}.${META_VERSION_PATCH}")
 set(META_NAME_VERSION        "${META_PROJECT_NAME} v${META_VERSION} (${META_VERSION_REVISION})")
 set(META_CMAKE_INIT_SHA      "${GIT_REV}")
+set(META_CMAKE_INIT_BRANCH   "cmake-3.20")
 
 string(MAKE_C_IDENTIFIER ${META_PROJECT_NAME} META_PROJECT_ID)
 string(TOUPPER ${META_PROJECT_ID} META_PROJECT_ID)
@@ -100,7 +101,7 @@ file(WRITE "${PROJECT_BINARY_DIR}/VERSION" "${META_NAME_VERSION}")
 #
 
 # Add cmake-init template check cmake targets
-add_check_template_target(${META_CMAKE_INIT_SHA})
+add_check_template_target(${META_CMAKE_INIT_SHA} ${META_CMAKE_INIT_BRANCH})
 
 # Configure health check tools
 enable_cppcheck(ON)

README.md

@@ -210,7 +210,7 @@ This module is usable when the following is integrated into the `CMakeLists.txt`
 
 ```cmake
 # Add cmake-init template check cmake targets
-add_check_template_target(<CMAKE_INIT_SHA>)
+add_check_template_target(<CMAKE_INIT_SHA> <CMAKE_INIT_BRANCH>)
 ```
 
 Here, the `<CMAKE_INIT_SHA>` contains the git hash of the used cmake-init template.
@@ -221,9 +221,10 @@ The hash is usually configured using
 ```cmake
 # Meta information about the project
 set(META_CMAKE_INIT_SHA      "<CMAKE_INIT_SHA>")
+set(META_CMAKE_INIT_BRANCH   "<CMAKE_INIT_BRANCH>")
 
 # Add cmake-init template check cmake targets
-add_check_template_target(<CMAKE_INIT_SHA>)
+add_check_template_target(<CMAKE_INIT_SHA> <CMAKE_INIT_BRANCH>)
 ```
 
 Correctly configures, this module adds a cmake build target named `check-template` that compares the passed `<CMAKE_INIT_SHA>` with the current master commit hash of this repository and provides a link for a diff view.

cmake/CheckTemplate.cmake

@@ -3,8 +3,12 @@
 # Get cmake-init latest commit SHA on master
 #
 
+if(NOT APPLIED_CMAKE_INIT_BRANCH)
+    set(APPLIED_CMAKE_INIT_BRANCH "master")
+endif ()
+
 file(DOWNLOAD
-    "https://api.github.com/repos/cginternals/cmake-init/commits/master"
+    "https://api.github.com/repos/cginternals/cmake-init/commits/${APPLIED_CMAKE_INIT_BRANCH}"
     "${PROJECT_BINARY_DIR}/cmake-init.github.data"
 )
 file(READ
@@ -45,5 +49,5 @@ endif()
 if(${APPLIED_CMAKE_INIT_SHA} STREQUAL ${CMAKE_INIT_SHA})
     message(STATUS "cmake-init template is up-to-date (${CMAKE_INIT_SHA})")
 else()
-    message(STATUS "cmake-init template needs an update https://github.com/cginternals/cmake-init/compare/${APPLIED_CMAKE_INIT_SHA}...master")
+    message(STATUS "cmake-init template needs an update https://github.com/cginternals/cmake-init/compare/${APPLIED_CMAKE_INIT_SHA}...${APPLIED_CMAKE_INIT_BRANCH}")
 endif()

cmake/HealthCheck.cmake

@@ -85,13 +85,14 @@ function(enable_clang_tidy status)
 endfunction()
 
 # Configure cmake target to check for cmake-init template
-function(add_check_template_target current_template_sha)
+function(add_check_template_target current_template_sha current_template_branch)
     add_custom_target(
         check-template
         COMMAND ${CMAKE_COMMAND}
             -DPROJECT_SOURCE_DIR=${PROJECT_SOURCE_DIR}
             -DPROJECT_BINARY_DIR=${PROJECT_BINARY_DIR}
             -DAPPLIED_CMAKE_INIT_SHA=${current_template_sha}
+            -DAPPLIED_CMAKE_INIT_BRANCH=${current_template_branch}
             -P ${PROJECT_SOURCE_DIR}/cmake/CheckTemplate.cmake
         WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
     )