fix: conform CFBundleVersion to documentation (#167)

ethanndickson · web-flow · commit 7af0cdc24934 · 2025-05-28T15:25:02.000+10:00
Second PR for #47. Previously, we were setting [`CFBundleVersion`](https://developer.apple.com/documentation/bundleresources/information-property-list/cfbundleversion) to the output of `git describe --tags` (`vX.Y.Z` or `vX.Y.Z-N-gHASH` for preview builds). To support Sparkle, and potentially to avoid a breakage with macOS failing to update an installed `LaunchDaemon` when it can't parse `CFBundleVersion`, we'll conform the string to the specification. Given that: > You can include more integers but the system ignores them. We set `CFBundleVersion` to a value of the form `X.Y.Z[.N]` where N is the number of commits since the `X.Y.Z` tag (omitted if 0) Sparkle did previously allow you to supply a manual version comparator, but it was deprecated to help require `CFBundleVersion` start with `X.Y.Z` sparkle-project/Sparkle#2585 That issue recommends instead putting marketing version information in `CFBundleShortVersionString`, but that actually has even stricter requirements: https://developer.apple.com/documentation/bundleresources/information-property-list/cfbundleshortversionstring Though not documented, from testing & reading the [Sparkle source](https://github.com/sparkle-project/Sparkle/blob/2.x/Sparkle/SUStandardVersionComparator.m), I discovered that `X.Y.Z.N+1` will be deemed a later version than `X.Y.Z.N`, which is what we'll do for the preview stream of auto-updates. For non-preview builds (i.e. builds on a tag), both version strings will be `X.Y.Z`. Since we're no longer including the commit hash in a version string, we instead embed it separately in the `Info.plist` so we can continue to display it in the UI: <img width="284" alt="image" src="https://github.com/user-attachments/assets/a9b2359d-6e2f-4f7d-979c-ba69ee01e69c" />
diff --git a/Coder-Desktop/Coder-Desktop/About.swift b/Coder-Desktop/Coder-Desktop/About.swift
@@ -31,11 +31,18 @@ enum About {
         return coder
     }
 
+    private static var version: NSString {
+        let version = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? "Unknown"
+        let commitHash = Bundle.main.infoDictionary?["CommitHash"] as? String ?? "Unknown"
+        return "Version \(version) - \(commitHash)" as NSString
+    }
+
     @MainActor
     static func open() {
         appActivate()
         NSApp.orderFrontStandardAboutPanel(options: [
             .credits: credits,
+            .applicationVersion: version,
         ])
     }
 }
diff --git a/Coder-Desktop/Coder-Desktop/Info.plist b/Coder-Desktop/Coder-Desktop/Info.plist
@@ -32,6 +32,8 @@
 		<string>$(TeamIdentifierPrefix)com.coder.Coder-Desktop.VPN</string>
 	</dict>
 	<key>SUPublicEDKey</key>
-    <string>Ae2oQLTcx89/a73XrpOt+IVvqdo+fMTjo3UKEm77VdA=</string>
+	<string>Ae2oQLTcx89/a73XrpOt+IVvqdo+fMTjo3UKEm77VdA=</string>
+	<key>CommitHash</key>
+	<string>$(GIT_COMMIT_HASH)</string>
 </dict>
 </plist>
diff --git a/Coder-Desktop/project.yml b/Coder-Desktop/project.yml
@@ -13,6 +13,7 @@ settings:
   base:
     MARKETING_VERSION: ${MARKETING_VERSION} # Sets the version number.
     CURRENT_PROJECT_VERSION: ${CURRENT_PROJECT_VERSION} # Sets the build number.
+    GIT_COMMIT_HASH: ${GIT_COMMIT_HASH}
 
     ALWAYS_SEARCH_USER_PATHS: NO
     ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS: YES
diff --git a/Makefile b/Makefile
@@ -32,19 +32,29 @@ $(error MUTAGEN_VERSION must be a valid version)
 endif
 
 ifndef CURRENT_PROJECT_VERSION
-CURRENT_PROJECT_VERSION:=$(shell git describe --match 'v[0-9]*' --dirty='.devel' --always --tags)
+# Must be X.Y.Z[.N]
+CURRENT_PROJECT_VERSION:=$(shell ./scripts/version.sh)
 endif
 ifeq ($(strip $(CURRENT_PROJECT_VERSION)),)
 $(error CURRENT_PROJECT_VERSION cannot be empty)
 endif
 
 ifndef MARKETING_VERSION
-MARKETING_VERSION:=$(shell git describe --match 'v[0-9]*' --tags --abbrev=0 | sed 's/^v//' | sed 's/-.*$$//')
+# Must be X.Y.Z
+MARKETING_VERSION:=$(shell ./scripts/version.sh --short)
 endif
 ifeq ($(strip $(MARKETING_VERSION)),)
 $(error MARKETING_VERSION cannot be empty)
 endif
 
+ifndef GIT_COMMIT_HASH
+# Must be a valid git commit hash
+GIT_COMMIT_HASH := $(shell ./scripts/version.sh --hash)
+endif
+ifeq ($(strip $(GIT_COMMIT_HASH)),)
+$(error GIT_COMMIT_HASH cannot be empty)
+endif
+
 # Define the keychain file name first
 KEYCHAIN_FILE := app-signing.keychain-db
 # Use shell to get the absolute path only if the file exists
@@ -70,6 +80,7 @@ $(XCPROJECT): $(PROJECT)/project.yml
 		EXT_PROVISIONING_PROFILE_ID=${EXT_PROVISIONING_PROFILE_ID} \
 		CURRENT_PROJECT_VERSION=$(CURRENT_PROJECT_VERSION) \
 		MARKETING_VERSION=$(MARKETING_VERSION) \
+		GIT_COMMIT_HASH=$(GIT_COMMIT_HASH) \
 		xcodegen
 
 $(PROJECT)/VPNLib/vpn.pb.swift: $(PROJECT)/VPNLib/vpn.proto
diff --git a/scripts/version.sh b/scripts/version.sh
@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+usage() {
+    echo "Usage: $0 [--short] [--hash]"
+    echo "  --short     Output a CFBundleShortVersionString compatible version (X.Y.Z)"
+    echo "  --hash      Output only the commit hash"
+    echo "  -h, --help  Display this help message"
+    echo ""
+    echo "With no flags, outputs: X.Y.Z[.N]"
+}
+
+SHORT=false
+HASH_ONLY=false
+
+while [[ "$#" -gt 0 ]]; do
+    case $1 in
+        --short)
+            SHORT=true
+            shift
+            ;;
+        --hash)
+            HASH_ONLY=true
+            shift
+            ;;
+        -h | --help)
+            usage
+            exit 0
+            ;;
+        *)
+            echo "Unknown parameter passed: $1"
+            usage
+            exit 1
+            ;;
+    esac
+done
+
+if [[ "$HASH_ONLY" == true ]]; then
+    current_hash=$(git rev-parse --short=7 HEAD)
+    echo "$current_hash"
+    exit 0
+fi
+
+describe_output=$(git describe --tags)
+
+# Of the form `vX.Y.Z-N-gHASH`
+if [[ $describe_output =~ ^v([0-9]+\.[0-9]+\.[0-9]+)(-([0-9]+)-g[a-f0-9]+)?$ ]]; then
+    version=${BASH_REMATCH[1]}  # X.Y.Z
+    commits=${BASH_REMATCH[3]}  # number of commits since tag
+
+    if [[ "$SHORT" == true ]]; then
+        echo "$version"
+        exit 0
+    fi
+
+    echo "${version}.${commits}"
+else
+    echo "Error: Could not parse git describe output: $describe_output" >&2
+    exit 1
+fi

Original file line number	Diff line number	Diff line change
`@@ -31,11 +31,18 @@ enum About {`
`31`	`31`	`return coder`
`32`	`32`	`}`
`33`	`33`
	`34`	`+ private static var version: NSString {`
	`35`	`+ let version = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? "Unknown"`
	`36`	`+ let commitHash = Bundle.main.infoDictionary?["CommitHash"] as? String ?? "Unknown"`
	`37`	`+ return "Version \(version) - \(commitHash)" as NSString`
	`38`	`+ }`
	`39`	`+`
`34`	`40`	`@MainActor`
`35`	`41`	`static func open() {`
`36`	`42`	`appActivate()`
`37`	`43`	`NSApp.orderFrontStandardAboutPanel(options: [`
`38`	`44`	`.credits: credits,`
	`45`	`+ .applicationVersion: version,`
`39`	`46`	`])`
`40`	`47`	`}`
`41`	`48`	`}`