feat: Implement Git-based versioning for all platforms

- Updated create-appimage-cli.sh, create-appimage.sh, and create-embedded.sh to retrieve version information from Git tags, enhancing version tracking.
- Modified output messages to display both the Git version and numeric version components.
- Added logic in CMakeLists.txt to extract version components from Git tags for better compatibility and fallback handling.
- Introduced metainfo.xml and resource file generation for Windows packaging, incorporating version information dynamically.

Author: tdewey-rpi

create-appimage-cli.sh

@@ -58,16 +58,27 @@ echo "Building CLI-only AppImage for architecture: $ARCH"
 SOURCE_DIR="src/"
 CMAKE_FILE="${SOURCE_DIR}CMakeLists.txt"
 
-# Extract version components
-MAJOR=$(grep -E "set\(IMAGER_VERSION_MAJOR [0-9]+" "$CMAKE_FILE" | sed 's/set(IMAGER_VERSION_MAJOR \([0-9]*\).*/\1/')
-MINOR=$(grep -E "set\(IMAGER_VERSION_MINOR [0-9]+" "$CMAKE_FILE" | sed 's/set(IMAGER_VERSION_MINOR \([0-9]*\).*/\1/')
-PATCH=$(grep -E "set\(IMAGER_VERSION_PATCH [0-9]+" "$CMAKE_FILE" | sed 's/set(IMAGER_VERSION_PATCH \([0-9]*\).*/\1/')
-PROJECT_VERSION="$MAJOR.$MINOR.$PATCH"
+# Get version from git tag (same approach as CMake)
+GIT_VERSION=$(git describe --tags --always --dirty 2>/dev/null || echo "0.0.0-unknown")
+
+# Extract numeric version components for compatibility
+if [[ $GIT_VERSION =~ ^v?([0-9]+)\.([0-9]+)\.([0-9]+) ]]; then
+    MAJOR="${BASH_REMATCH[1]}"
+    MINOR="${BASH_REMATCH[2]}"
+    PATCH="${BASH_REMATCH[3]}"
+    PROJECT_VERSION="$MAJOR.$MINOR.$PATCH"
+else
+    MAJOR="0"
+    MINOR="0"
+    PATCH="0"
+    PROJECT_VERSION="0.0.0"
+    echo "Warning: Could not parse version from git tag: $GIT_VERSION"
+fi
 
 # Extract project name (lowercase for AppImage naming convention)
 PROJECT_NAME=$(grep "project(" "$CMAKE_FILE" | head -1 | sed 's/project(\([^[:space:]]*\).*/\1/' | tr '[:upper:]' '[:lower:]')
 
-echo "Building $PROJECT_NAME version $PROJECT_VERSION for CLI-only operation"
+echo "Building $PROJECT_NAME version $GIT_VERSION (numeric: $PROJECT_VERSION) for CLI-only operation"
 
 QT_VERSION=""
 QT_DIR=""

create-appimage.sh

@@ -49,16 +49,27 @@ echo "Building for architecture: $ARCH"
 SOURCE_DIR="src/"
 CMAKE_FILE="${SOURCE_DIR}CMakeLists.txt"
 
-# Extract version components
-MAJOR=$(grep -E "set\(IMAGER_VERSION_MAJOR [0-9]+" "$CMAKE_FILE" | sed 's/set(IMAGER_VERSION_MAJOR \([0-9]*\).*/\1/')
-MINOR=$(grep -E "set\(IMAGER_VERSION_MINOR [0-9]+" "$CMAKE_FILE" | sed 's/set(IMAGER_VERSION_MINOR \([0-9]*\).*/\1/')
-PATCH=$(grep -E "set\(IMAGER_VERSION_PATCH [0-9]+" "$CMAKE_FILE" | sed 's/set(IMAGER_VERSION_PATCH \([0-9]*\).*/\1/')
-PROJECT_VERSION="$MAJOR.$MINOR.$PATCH"
+# Get version from git tag (same approach as CMake)
+GIT_VERSION=$(git describe --tags --always --dirty 2>/dev/null || echo "0.0.0-unknown")
+
+# Extract numeric version components for compatibility
+if [[ $GIT_VERSION =~ ^v?([0-9]+)\.([0-9]+)\.([0-9]+) ]]; then
+    MAJOR="${BASH_REMATCH[1]}"
+    MINOR="${BASH_REMATCH[2]}"
+    PATCH="${BASH_REMATCH[3]}"
+    PROJECT_VERSION="$MAJOR.$MINOR.$PATCH"
+else
+    MAJOR="0"
+    MINOR="0"
+    PATCH="0"
+    PROJECT_VERSION="0.0.0"
+    echo "Warning: Could not parse version from git tag: $GIT_VERSION"
+fi
 
 # Extract project name (lowercase for AppImage naming convention)
 PROJECT_NAME=$(grep "project(" "$CMAKE_FILE" | head -1 | sed 's/project(\([^[:space:]]*\).*/\1/' | tr '[:upper:]' '[:lower:]')
 
-echo "Building $PROJECT_NAME version $PROJECT_VERSION"
+echo "Building $PROJECT_NAME version $GIT_VERSION (numeric: $PROJECT_VERSION)"
 
 # Check for Qt installation
 # Priority: 1. Command line argument, 2. Environment variable, 3. Auto-detection

create-embedded.sh

@@ -57,16 +57,27 @@ echo "Building embedded AppImage for architecture: $ARCH"
 SOURCE_DIR="src/"
 CMAKE_FILE="${SOURCE_DIR}CMakeLists.txt"
 
-# Extract version components
-MAJOR=$(grep -E "set\(IMAGER_VERSION_MAJOR [0-9]+" "$CMAKE_FILE" | sed 's/set(IMAGER_VERSION_MAJOR \([0-9]*\).*/\1/')
-MINOR=$(grep -E "set\(IMAGER_VERSION_MINOR [0-9]+" "$CMAKE_FILE" | sed 's/set(IMAGER_VERSION_MINOR \([0-9]*\).*/\1/')
-PATCH=$(grep -E "set\(IMAGER_VERSION_PATCH [0-9]+" "$CMAKE_FILE" | sed 's/set(IMAGER_VERSION_PATCH \([0-9]*\).*/\1/')
-PROJECT_VERSION="$MAJOR.$MINOR.$PATCH"
+# Get version from git tag (same approach as CMake)
+GIT_VERSION=$(git describe --tags --always --dirty 2>/dev/null || echo "0.0.0-unknown")
+
+# Extract numeric version components for compatibility
+if [[ $GIT_VERSION =~ ^v?([0-9]+)\.([0-9]+)\.([0-9]+) ]]; then
+    MAJOR="${BASH_REMATCH[1]}"
+    MINOR="${BASH_REMATCH[2]}"
+    PATCH="${BASH_REMATCH[3]}"
+    PROJECT_VERSION="$MAJOR.$MINOR.$PATCH"
+else
+    MAJOR="0"
+    MINOR="0"
+    PATCH="0"
+    PROJECT_VERSION="0.0.0"
+    echo "Warning: Could not parse version from git tag: $GIT_VERSION"
+fi
 
 # Extract project name (lowercase for AppImage naming convention)
 PROJECT_NAME=$(grep "project(" "$CMAKE_FILE" | head -1 | sed 's/project(\([^[:space:]]*\).*/\1/' | tr '[:upper:]' '[:lower:]')
 
-echo "Building $PROJECT_NAME version $PROJECT_VERSION for embedded systems"
+echo "Building $PROJECT_NAME version $GIT_VERSION (numeric: $PROJECT_VERSION) for embedded systems"
 
 QT_VERSION=""
 QT_DIR=""

debian/com.raspberrypi.rpi-imager.metainfo.xml renamed to debian/com.raspberrypi.rpi-imager.metainfo.xml.in

@@ -12,7 +12,7 @@
       always installing the most up-to-date version.
     </p>
     <p>
-      Once you’ve selected an operating system from the available options,
+      Once you've selected an operating system from the available options,
       the utility reads the relevant file directly from the Raspberry Pi
       website and writes it straight to the SD card. This speeds up the
       process quite considerably compared to the standard process of reading
@@ -55,9 +55,10 @@
     <binary>rpi-imager</binary>
   </provides>
   <releases>
-    <release version="1.9.6" />
+    <release version="@IMAGER_VERSION_STR@" />
   </releases>
   <content_rating type="oars-1.1">
     <content_attribute id="social-info">moderate</content_attribute>
   </content_rating>
 </component>
+

src/CMakeLists.txt

@@ -27,11 +27,8 @@ endif()
 set(CMAKE_OSX_ARCHITECTURES "arm64;x86_64" CACHE STRING "Which macOS architectures to build for")
 
 project(rpi-imager LANGUAGES CXX C)
-set(IMAGER_VERSION_MAJOR 2)
-set(IMAGER_VERSION_MINOR 0)
-set(IMAGER_VERSION_PATCH 0)
 
-# Get git description for version string
+# Get version from git tag
 find_package(Git QUIET)
 if(GIT_FOUND)
     execute_process(
@@ -43,16 +40,37 @@ if(GIT_FOUND)
     )
 endif()
 
-# Build version string with git description if available
-set(IMAGER_VERSION_STR "${IMAGER_VERSION_MAJOR}.${IMAGER_VERSION_MINOR}.${IMAGER_VERSION_PATCH}")
+# Use git-derived version as the canonical version string
 if(GIT_DESCRIBE)
-    set(IMAGER_VERSION_STR "${IMAGER_VERSION_STR}-${GIT_DESCRIBE}")
-    message(STATUS "Git description: ${GIT_DESCRIBE}")
+    set(IMAGER_VERSION_STR "${GIT_DESCRIBE}")
+    message(STATUS "Version from git: ${IMAGER_VERSION_STR}")
+    
+    # Extract numeric version components from git tag for Windows metadata
+    # Expected format: v2.0.0 or v2.0.0-rc4-60-geac7c2f0
+    string(REGEX MATCH "^v?([0-9]+)\\.([0-9]+)\\.([0-9]+)" VERSION_MATCH "${GIT_DESCRIBE}")
+    if(VERSION_MATCH)
+        set(IMAGER_VERSION_MAJOR ${CMAKE_MATCH_1})
+        set(IMAGER_VERSION_MINOR ${CMAKE_MATCH_2})
+        set(IMAGER_VERSION_PATCH ${CMAKE_MATCH_3})
+    else()
+        # Fallback if tag doesn't match expected format
+        set(IMAGER_VERSION_MAJOR 0)
+        set(IMAGER_VERSION_MINOR 0)
+        set(IMAGER_VERSION_PATCH 0)
+        message(WARNING "Could not parse version from git tag: ${GIT_DESCRIBE}")
+    endif()
+else()
+    # Fallback when git is not available or no tags exist
+    set(IMAGER_VERSION_MAJOR 0)
+    set(IMAGER_VERSION_MINOR 0)
+    set(IMAGER_VERSION_PATCH 0)
+    set(IMAGER_VERSION_STR "0.0.0-unknown")
+    message(WARNING "Git not found or no tags available, using fallback version: ${IMAGER_VERSION_STR}")
 endif()
 
-set(IMAGER_VERSION_CSV "${IMAGER_VERSION_MAJOR},${IMAGER_VERSION_MINOR},${IMAGER_VERSION_PATCH},0")
+# Version variables for template substitution (Windows .rc, .manifest, etc.)
+# Note: IMAGER_VERSION_STR is used in C++ code, so it needs to be a compile definition
 add_definitions(-DIMAGER_VERSION_STR="${IMAGER_VERSION_STR}")
-add_definitions(-DIMAGER_VERSION_CSV=${IMAGER_VERSION_CSV})
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 
 set(CMAKE_CXX_STANDARD 20)

src/linux/PlatformPackaging.cmake

@@ -12,6 +12,12 @@ if (NOT CMAKE_CROSSCOMPILING)
     endif()
 endif()
 
+# Generate metainfo.xml with current version
+configure_file(
+    "${CMAKE_CURRENT_LIST_DIR}/../../debian/com.raspberrypi.rpi-imager.metainfo.xml.in"
+    "${CMAKE_CURRENT_BINARY_DIR}/com.raspberrypi.rpi-imager.metainfo.xml"
+    @ONLY)
+
 install(TARGETS ${PROJECT_NAME} DESTINATION bin)
 
 if(BUILD_CLI_ONLY)
@@ -22,7 +28,7 @@ else()
     # GUI build: install full desktop integration
     install(FILES "${CMAKE_CURRENT_LIST_DIR}/../../debian/rpi-imager.png" DESTINATION share/icons/hicolor/128x128/apps)
     install(FILES "${CMAKE_CURRENT_LIST_DIR}/../../debian/com.raspberrypi.rpi-imager.desktop" DESTINATION share/applications)
-    install(FILES "${CMAKE_CURRENT_LIST_DIR}/../../debian/com.raspberrypi.rpi-imager.metainfo.xml" DESTINATION share/metainfo)
+    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/com.raspberrypi.rpi-imager.metainfo.xml" DESTINATION share/metainfo)
 endif()
 
 

src/windows/Platform.cmake

@@ -52,7 +52,7 @@ else()
 endif()
 
 set(DEPENDENCIES
-    windows/rpi-imager.rc
+    ${CMAKE_BINARY_DIR}/rpi-imager.rc
     wlanapi_delayed.lib
 )
 set(EXTRALIBS setupapi ${CMAKE_BINARY_DIR}/wlanapi_delayed.lib Bcrypt.dll ole32 oleaut32 wbemuuid)

src/windows/PlatformPackaging.cmake

@@ -121,6 +121,12 @@ else()
     endif()
 endif()
 
+# Resource file generation (contains version info)
+configure_file(
+    "${CMAKE_CURRENT_SOURCE_DIR}/windows/rpi-imager.rc.in"
+    "${CMAKE_CURRENT_BINARY_DIR}/rpi-imager.rc"
+    @ONLY)
+
 # Manifest generation and copying
 configure_file(
     "${CMAKE_CURRENT_SOURCE_DIR}/windows/rpi-imager.manifest.in"

src/windows/rpi-imager.rc renamed to src/windows/rpi-imager.rc.in

@@ -4,19 +4,22 @@ IDI_ICON1 ICON DISCARDABLE "../icons/rpi-imager.ico"
 CREATEPROCESS_MANIFEST_RESOURCE_ID RT_MANIFEST "rpi-imager.manifest"
 
 1 VERSIONINFO
-FILEVERSION IMAGER_VERSION_CSV
-PRODUCTVERSION IMAGER_VERSION_CSV
+FILEVERSION @IMAGER_VERSION_MAJOR@,@IMAGER_VERSION_MINOR@,@IMAGER_VERSION_PATCH@,0
+PRODUCTVERSION @IMAGER_VERSION_MAJOR@,@IMAGER_VERSION_MINOR@,@IMAGER_VERSION_PATCH@,0
 {
     BLOCK "StringFileInfo"
     {
         BLOCK "040904b0"
         {
             VALUE "CompanyName",     "Raspberry Pi Ltd"
             VALUE "FileDescription", "Raspberry Pi Imager"
+            VALUE "FileVersion",     "@IMAGER_VERSION_STR@"
+            VALUE "ProductVersion",  "@IMAGER_VERSION_STR@"
         }
     }
     BLOCK "VarFileInfo"
     {
         VALUE "Translation", 0x409, 1252
     }
 }
+