Add versioning with incremental build numbers

Author: tdecroyere

CMakeLists.txt

@@ -6,5 +6,17 @@ project(Kanso LANGUAGES C ASM)
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
+include(cmake/utils.cmake)
+
+set(VERSION_HEADER_PATH "${CMAKE_BINARY_DIR}/src/Common/Version.h")
+file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/src/Common")
+
+add_custom_target(generate_version_header ALL
+  COMMAND ${CMAKE_COMMAND} -DOUT_FILE=${VERSION_HEADER_PATH}
+                           -P "${CMAKE_SOURCE_DIR}/cmake/generate_version_header.cmake"
+  COMMENT "Regenerating version.h from Git tag"
+)
+
 add_subdirectory(src/Common)
 add_subdirectory(src/Kernel)
+

cmake/generate_version_header.cmake

@@ -0,0 +1,33 @@
+execute_process(
+  COMMAND git describe --tags --abbrev=0
+  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+  OUTPUT_VARIABLE GIT_TAG
+  OUTPUT_STRIP_TRAILING_WHITESPACE
+  ERROR_QUIET
+)
+
+if(NOT GIT_TAG)
+  set(GIT_TAG "0.0.0-DEV")
+endif()
+
+string(REGEX MATCH "^([0-9]+)\\.([0-9]+)\\.([0-9]+)-([A-Za-z0-9]+)$" _ "${GIT_TAG}")
+
+set(MAJOR ${CMAKE_MATCH_1})
+set(MINOR ${CMAKE_MATCH_2})
+math(EXPR BUILD "${CMAKE_MATCH_3} + 1")
+set(LABEL ${CMAKE_MATCH_4})
+
+set(VERSION_FULL "${MAJOR}.${MINOR}.${BUILD}-${LABEL}")
+
+file(WRITE "${OUT_FILE}" "
+// Auto-generated version.h from Git tag ${GIT_TAG}
+
+#pragma once
+
+#define KANSO_VERSION_MAJOR ${MAJOR}
+#define KANSO_VERSION_MINOR ${MINOR}
+#define KANSO_VERSION_BUILD ${BUILD}
+#define KANSO_VERSION_LABEL \"${LABEL}\"
+#define KANSO_VERSION_FULL \"${VERSION_FULL}\"
+")
+

cmake/utils.cmake

@@ -0,0 +1,26 @@
+function(get_git_version OUT_PREFIX)
+  execute_process(
+    COMMAND git describe --tags --abbrev=0
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+    OUTPUT_VARIABLE _GIT_TAG
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    ERROR_QUIET
+  )
+
+  if(NOT _GIT_TAG)
+    set(_GIT_TAG "0.0.0-UNKNOWN")
+  endif()
+
+  string(REGEX MATCH "^([0-9]+)\\.([0-9]+)\\.([0-9]+)-([A-Za-z0-9]+)$" _ "${_GIT_TAG}")
+
+  set(${OUT_PREFIX}_MAJOR "${CMAKE_MATCH_1}" PARENT_SCOPE)
+  set(${OUT_PREFIX}_MINOR "${CMAKE_MATCH_2}" PARENT_SCOPE)
+  set(${OUT_PREFIX}_BUILD "${CMAKE_MATCH_3}" PARENT_SCOPE)
+  set(${OUT_PREFIX}_LABEL "${CMAKE_MATCH_4}" PARENT_SCOPE)
+
+  set(${OUT_PREFIX}_FULL
+      "${CMAKE_MATCH_1}.${CMAKE_MATCH_2}.${CMAKE_MATCH_3}-${CMAKE_MATCH_4}"
+      PARENT_SCOPE
+  )
+endfunction()
+

src/Common/CMakeLists.txt

@@ -1,3 +1,6 @@
 add_library(Common INTERFACE)
+add_dependencies(Common generate_version_header)
+
+target_include_directories(Common INTERFACE .)
+target_include_directories(Common INTERFACE ${CMAKE_BINARY_DIR}/src/Common)
 
-target_include_directories(Common INTERFACE .)

src/Kernel/CMakeLists.txt

@@ -1,2 +1,4 @@
 # TODO: Add the correct platform
 add_subdirectory(Platforms/RiscV)
+add_dependencies(Kernel generate_version_header)
+add_dependencies(KernelTest generate_version_header)

src/Kernel/KernelMain.c

@@ -1,6 +1,7 @@
 #include "Types.h"
 #include "String.h"
 #include "Memory.h"
+#include "Version.h"
 #include "Platform.h"
 #include "KernelConsole.h"
 #include "Kernel.h"
@@ -30,7 +31,7 @@ void KernelMain()
     auto platformInformation = PlatformGetInformation();
 
     KernelConsolePrint(String("\n\n\x1b[36m%s\x1b[0m\n"), KernelLogo);
-    KernelConsolePrint(String("Kanso OS 1.0-DEV1 - GitHubActions "));
+    KernelConsolePrint(String("Kanso OS %s "), KANSO_VERSION_FULL);
     KernelConsolePrint(String("(%s %d-bit)\n\n"), platformInformation.Name.Pointer, platformInformation.ArchitectureBits);
 
     //CpuSetSupervisorTrapHandler(&KernelSupervisorTrapHandler);

src/Kernel/KernelTest.c

@@ -3,6 +3,7 @@
 #include "String.h"
 #include "KernelConsole.h"
 #include "Platform.h"
+#include "Version.h"
 
 const char* TEST_CONSOLE_RESET = "\x1b[0m";
 const char* TEST_CONSOLE_GREEN = "\x1b[32m";
@@ -44,6 +45,11 @@ void KernelTestHandler(TestRunState state, ReadOnlySpanChar message, ...)
 
 void KernelMain()
 {
+    auto platformInformation = PlatformGetInformation();
+
+    KernelConsolePrint(String("\n\nKanso OS Kernel Tests %s "), KANSO_VERSION_FULL);
+    KernelConsolePrint(String("(%s %d-bit)\n\n"), platformInformation.Name.Pointer, platformInformation.ArchitectureBits);
+
     TestRun(KernelTestHandler);
     BiosReset(BiosResetType_Shutdown, BiosResetReason_None);
 }