chore(build): Ensure GIT_TAG is never empty (#86)

Slider0007 · Oct 25, 2023 · be07db0 · be07db0
1 parent ce61169
commit be07db0
Show file tree

Hide file tree

Showing 13 changed files with 13 additions and 129 deletions.
diff --git a/code/.gitignore b/code/.gitignore
@@ -6,8 +6,6 @@
 .vscode/ipch
 version.cpp
 sdkconfig.esp32cam
-sdkconfig.esp32cam-localbuild
 sdkconfig.esp32cam-debug
-sdkconfig.esp32cam-board-rev3
 sdkconfig.esp32cam-himem
 sdkconfig.esp32cam-task-analysis
diff --git a/code/CMakeLists.txt b/code/CMakeLists.txt
@@ -2,12 +2,6 @@ cmake_minimum_required(VERSION 3.16.0)
 
 list(APPEND EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common components/tflite-micro-esp-examples/components/tflite-lib)
 
-ADD_CUSTOM_COMMAND(
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/version.cpp
-           ${CMAKE_CURRENT_BINARY_DIR}/_version.cpp
-    COMMAND ${CMAKE_COMMAND} -P
-            ${CMAKE_CURRENT_SOURCE_DIR}/version.cmake)
-
 if(EXISTS "${SDKCONFIG}.defaults")
     if(EXISTS "sdkconfig.defaults")
         set(SDKCONFIG_DEFAULTS "${SDKCONFIG}.defaults;sdkconfig.defaults")

diff --git a/code/main/CMakeLists.txt b/code/main/CMakeLists.txt
@@ -2,6 +2,7 @@
 # without default 'CMakeLists.txt' file.
 
 ##################################################################
+# Extract GIT infos and set variables in version.cpp
 ##################################################################
 execute_process(COMMAND git log --pretty=format:'%h' -n 1
                 OUTPUT_VARIABLE GIT_REV
@@ -21,26 +22,32 @@ else()
     execute_process(
         COMMAND bash -c "git diff --quiet --exit-code || echo +"
         OUTPUT_VARIABLE GIT_DIFF)
-    execute_process(
-        COMMAND git describe --exact-match --tags
-        OUTPUT_VARIABLE GIT_TAG ERROR_QUIET)
     execute_process(
         COMMAND git rev-parse --abbrev-ref HEAD
         OUTPUT_VARIABLE GIT_BRANCH)
+    execute_process(
+        COMMAND git describe --exact-match --tags
+        OUTPUT_VARIABLE GIT_TAG ERROR_QUIET)
 
     string(STRIP "${GIT_REV}" GIT_REV)
     string(SUBSTRING "${GIT_REV}" 1 7 GIT_REV)
     string(STRIP "${GIT_DIFF}" GIT_DIFF)
-    string(STRIP "${GIT_TAG}" GIT_TAG)
     string(STRIP "${GIT_BRANCH}" GIT_BRANCH)
+
+    string(COMPARE NOTEQUAL "${GIT_TAG}" "" GitTagNotEmpty)
+    if(GitTagNotEmpty)
+        string(STRIP "${GIT_TAG}" GIT_TAG)
+    else()
+        set(GIT_TAG "N/A") # Set N/A if no tag was found
+    endif()
 endif()
 
 set(VERSION "const char* GIT_REV=\"${GIT_REV}${GIT_DIFF}\";
 const char* GIT_TAG=\"${GIT_TAG}\";
 const char* GIT_BRANCH=\"${GIT_BRANCH}\";
 const char* BUILD_TIME=\"${BUILD_TIME}\";")
 
-if ("${GIT_TAG}" STREQUAL "") # Tag not set, show branch
+if ("${GIT_TAG}" STREQUAL "N/A" OR "${GIT_TAG}" STREQUAL "") # Tag not set, show branch
     set(VERSION_HTML "Develop: ${GIT_BRANCH} (Commit: ${GIT_REV}${GIT_DIFF})\n${GIT_REV}")
 else() # Tag is set, ignore branch
     set(VERSION_HTML "Release: ${GIT_TAG} (Commit: ${GIT_REV}${GIT_DIFF})\n${GIT_REV}")

diff --git a/code/main/favicon.ico b/code/main/favicon.ico
diff --git a/code/main/gitversion.cmake b/code/main/gitversion.cmake
diff --git a/code/main/version.h b/code/main/version.h
@@ -40,7 +40,7 @@ const char* libfive_git_branch(void)
 
 std::string getFwVersion(void) {
     std::string buf;
-    if (std::string(GIT_TAG) == "") { // Tag not set, show branch
+    if ((std::string(GIT_TAG) == "N/A") || (std::string(GIT_TAG) == "")) { // Tag not set, show branch
         buf = "Develop: " + std::string(GIT_BRANCH);
     }
     else { // Tag is set, ignore branch

diff --git a/docs/binary/bootloader.bin b/docs/binary/bootloader.bin
diff --git a/docs/binary/firmware.bin b/docs/binary/firmware.bin
diff --git a/docs/binary/partitions.bin b/docs/binary/partitions.bin
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/manifest.json b/docs/manifest.json
diff --git a/docs/manifest_template.json b/docs/manifest_template.json
diff --git a/firmware/README.md b/firmware/README.md