ci: Centralize SDK version (#2362)

abdulraqeeb33 · AR Abdul Azeez · web-flow · commit 8116c601b53d · 2025-09-08T09:58:56.000-05:00
* Version Bump Workflow

* renamed the file

* Update version-bump.yml

test branch

* Update version-bump.yml

Update path

* fix order

* fix typo

* Update version-bump.yml

Delete branch if it exists

* cat files

* Update version-bump.yml

branch name

* Update gradle.properties

test

* Update version-bump.yml

fix branch name

* fixed branch names

* test branch name

* cleanup

* changed it back to main

* cleanup

* ktlint check

* Cleanup

* New link
e

* Gather summaries

* Warning message when no commits present

* Cleaned up based on feedback

* trigger on branch

* test from local

* Fail to build if version number not present

* added documentation

* Added more checks

---------

Co-authored-by: AR Abdul Azeez &lt;abdul@onesignal.com&gt;
diff --git a/Examples/OneSignalDemo/app/build.gradle b/Examples/OneSignalDemo/app/build.gradle
@@ -85,12 +85,12 @@ dependencies {
     implementation 'com.github.bumptech.glide:glide:4.12.0'
 
     /** START - Google Play Builds **/
-    gmsImplementation('com.onesignal:OneSignal:5.1.37')
+    gmsImplementation("com.onesignal:OneSignal:$SDK_VERSION")
     /** END - Google Play Builds **/
 
     /** START - Huawei Builds **/
     // Omit Google / Firebase libraries for Huawei builds.
-    huaweiImplementation('com.onesignal:OneSignal:5.1.37') {
+    huaweiImplementation("com.onesignal:OneSignal:$SDK_VERSION") {
         exclude group: 'com.google.android.gms', module: 'play-services-gcm'
         exclude group: 'com.google.android.gms', module: 'play-services-analytics'
         exclude group: 'com.google.android.gms', module: 'play-services-location'
diff --git a/Examples/OneSignalDemo/build.gradle b/Examples/OneSignalDemo/build.gradle
@@ -30,6 +30,10 @@ allprojects {
     }
 }
 
+subprojects {
+    ext.SDK_VERSION = rootProject.findProperty("SDK_VERSION") ?: "x.x.x"
+}
+
 task clean(type: Delete) {
     delete rootProject.buildDir
 }
diff --git a/Examples/OneSignalDemo/gradle.properties b/Examples/OneSignalDemo/gradle.properties
@@ -14,3 +14,7 @@
 org.gradle.jvmargs=-Xmx1536m
 android.useAndroidX=true
 android.enableJetifier=false
+
+# This is the name of the SDK to use when building your project.
+# This will be fed from the GitHub Actions workflow.
+SDK_VERSION=5.1.37
diff --git a/OneSignalSDK/gradle.properties b/OneSignalSDK/gradle.properties
@@ -30,3 +30,7 @@ android.enableD8 = true
 
 # Android X settings
 android.useAndroidX = true
+
+# This is the name of the SDK to use when building your project.
+# This will be fed from the GitHub Actions workflow.
+SDK_VERSION=5.1.37
diff --git a/OneSignalSDK/onesignal/core/build.gradle b/OneSignalSDK/onesignal/core/build.gradle
@@ -11,6 +11,11 @@ android {
         minSdkVersion rootProject.buildVersions.minSdkVersion
         consumerProguardFiles "consumer-rules.pro"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        buildConfigField "String", "SDK_VERSION", "\"${rootProject.version}\""
+    }
+
+    buildFeatures {
+        buildConfig = true
     }
 
     buildTypes {
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/OneSignalUtils.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/OneSignalUtils.kt
@@ -1,12 +1,32 @@
 package com.onesignal.common
 
+import com.onesignal.core.BuildConfig
 import java.util.regex.Pattern
 
 object OneSignalUtils {
     /**
-     * The version of this SDK.
+     * The version of this SDK. This is being formatted to ensure proper sorting when used in
+     * User-Agent strings and other uses where lexicographical order matters.
+     * Its being picked up from the Gradle build config field `SDK_VERSION`.
+     * Also its calculated lazily once when first accessed and then cached after that.
      */
-    const val SDK_VERSION: String = "050137"
+    val sdkVersion: String by lazy {
+        formatVersion(BuildConfig.SDK_VERSION)
+    }
+
+    /**
+     * Formats a version string to ensure proper lexicographical sorting.
+     * For example, "1.2.3-beta" becomes "010203-beta", "1.20.3" becomes "010203".
+     */
+    internal fun formatVersion(version: String): String {
+        val parts = version.split("-", limit = 2)
+        val base = parts[0].split(".")
+        val major = base.getOrNull(0)?.padStart(2, '0') ?: "00"
+        val minor = base.getOrNull(1)?.padStart(2, '0') ?: "00"
+        val patch = base.getOrNull(2)?.padStart(2, '0') ?: "00"
+        val formatted = "$major$minor$patch"
+        return if (parts.size > 1) formatted + "-" + parts[1] else formatted
+    }
 
     fun isValidEmail(email: String): Boolean {
         if (email.isEmpty()) {
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/http/impl/HttpClient.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/http/impl/HttpClient.kt
@@ -135,7 +135,7 @@ internal class HttpClient(
                     con.useCaches = false
                     con.connectTimeout = timeout
                     con.readTimeout = timeout
-                    con.setRequestProperty("SDK-Version", "onesignal/android/" + OneSignalUtils.SDK_VERSION)
+                    con.setRequestProperty("SDK-Version", "onesignal/android/" + OneSignalUtils.sdkVersion)
 
                     if (OneSignalWrapper.sdkType != null && OneSignalWrapper.sdkVersion != null) {
                         con.setRequestProperty("SDK-Wrapper", "onesignal/${OneSignalWrapper.sdkType}/${OneSignalWrapper.sdkVersion}")
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/internal/OneSignalImp.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/internal/OneSignalImp.kt
@@ -53,7 +53,7 @@ import com.onesignal.user.internal.subscriptions.SubscriptionType
 import org.json.JSONObject
 
 internal class OneSignalImp : IOneSignal, IServiceProvider {
-    override val sdkVersion: String = OneSignalUtils.SDK_VERSION
+    override val sdkVersion: String = OneSignalUtils.sdkVersion
     override var isInitialized: Boolean = false
 
     override var consentRequired: Boolean
@@ -300,7 +300,7 @@ internal class OneSignalImp : IOneSignal, IServiceProvider {
                             pushSubscriptionModel.status = SubscriptionStatus.SUBSCRIBED
                         }
 
-                        pushSubscriptionModel.sdk = OneSignalUtils.SDK_VERSION
+                        pushSubscriptionModel.sdk = OneSignalUtils.sdkVersion
                         pushSubscriptionModel.deviceOS = Build.VERSION.RELEASE
                         pushSubscriptionModel.carrier = DeviceUtils.getCarrierName(
                             services.getService<IApplicationService>().appContext,
@@ -472,7 +472,7 @@ internal class OneSignalImp : IOneSignal, IServiceProvider {
         newPushSubscription.optedIn = currentPushSubscription?.optedIn ?: true
         newPushSubscription.address = currentPushSubscription?.address ?: ""
         newPushSubscription.status = currentPushSubscription?.status ?: SubscriptionStatus.NO_PERMISSION
-        newPushSubscription.sdk = OneSignalUtils.SDK_VERSION
+        newPushSubscription.sdk = OneSignalUtils.sdkVersion
         newPushSubscription.deviceOS = Build.VERSION.RELEASE
         newPushSubscription.carrier = DeviceUtils.getCarrierName(services.getService<IApplicationService>().appContext) ?: ""
         newPushSubscription.appVersion = AndroidUtils.getAppVersion(services.getService<IApplicationService>().appContext) ?: ""
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/operations/impl/executors/LoginUserOperationExecutor.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/operations/impl/executors/LoginUserOperationExecutor.kt
@@ -296,7 +296,7 @@ internal class LoginUserOperationExecutor(
                 operation.address,
                 operation.enabled,
                 operation.status.value,
-                OneSignalUtils.SDK_VERSION,
+                OneSignalUtils.sdkVersion,
                 Build.MODEL,
                 Build.VERSION.RELEASE,
                 RootToolsInternalMethods.isRooted,
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/operations/impl/executors/SubscriptionOperationExecutor.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/operations/impl/executors/SubscriptionOperationExecutor.kt
@@ -98,7 +98,7 @@ internal class SubscriptionOperationExecutor(
                     address,
                     enabled,
                     status.value,
-                    OneSignalUtils.SDK_VERSION,
+                    OneSignalUtils.sdkVersion,
                     Build.MODEL,
                     Build.VERSION.RELEASE,
                     RootToolsInternalMethods.isRooted,
@@ -181,7 +181,7 @@ internal class SubscriptionOperationExecutor(
                     lastOperation.address,
                     lastOperation.enabled,
                     lastOperation.status.value,
-                    OneSignalUtils.SDK_VERSION,
+                    OneSignalUtils.sdkVersion,
                     Build.MODEL,
                     Build.VERSION.RELEASE,
                     RootToolsInternalMethods.isRooted,
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/subscriptions/impl/SubscriptionManager.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/subscriptions/impl/SubscriptionManager.kt
@@ -256,7 +256,7 @@ internal class SubscriptionManager(
         }
         val pushSubModel = (pushSub as Subscription).model
 
-        pushSubModel.sdk = OneSignalUtils.SDK_VERSION
+        pushSubModel.sdk = OneSignalUtils.sdkVersion
         pushSubModel.deviceOS = Build.VERSION.RELEASE
 
         val carrier = DeviceUtils.getCarrierName(_applicationService.appContext)
diff --git a/OneSignalSDK/onesignal/core/src/test/java/com/onesignal/common/OneSignalUtilsTest.kt b/OneSignalSDK/onesignal/core/src/test/java/com/onesignal/common/OneSignalUtilsTest.kt
@@ -0,0 +1,123 @@
+package com.onesignal.common
+
+import com.onesignal.core.BuildConfig
+import io.kotest.core.spec.style.FunSpec
+import io.kotest.matchers.shouldBe
+
+class OneSignalUtilsTest : FunSpec({
+
+    context("formatVersion standard cases") {
+        test("should format '5.2.1' correctly") {
+            OneSignalUtils.formatVersion("5.2.1") shouldBe "050201"
+        }
+
+        test("should format '05.02.01' correctly") {
+            OneSignalUtils.formatVersion("05.02.01") shouldBe "050201"
+        }
+
+        test("should format '4.10.0' correctly") {
+            OneSignalUtils.formatVersion("4.10.0") shouldBe "041000"
+        }
+
+        test("should format '12.1.3' correctly") {
+            OneSignalUtils.formatVersion("12.1.3") shouldBe "120103"
+        }
+
+        test("should format '1.2.3' correctly") { // This was also a separate test later, combined here
+            OneSignalUtils.formatVersion("1.2.3") shouldBe "010203"
+        }
+
+        test("should format '10.20.30' correctly") { // This was also a separate test later, combined here
+            OneSignalUtils.formatVersion("10.20.30") shouldBe "102030"
+        }
+    }
+
+    context("formatVersion edge cases and malformed inputs") {
+        test("should format major only '5' correctly") {
+            OneSignalUtils.formatVersion("5") shouldBe "050000"
+        }
+
+        test("should format major with trailing dot '5.' correctly") {
+            OneSignalUtils.formatVersion("5.") shouldBe "050000"
+        }
+
+        test("should format major and minor '5.2' correctly") {
+            OneSignalUtils.formatVersion("5.2") shouldBe "050200"
+        }
+
+        test("should format major and minor with trailing dot '5.2.' correctly") {
+            OneSignalUtils.formatVersion("5.2.") shouldBe "050200"
+        }
+
+        test("should format empty string correctly") {
+            OneSignalUtils.formatVersion("") shouldBe "000000"
+        }
+
+        test("should format single dot '.' correctly") {
+            OneSignalUtils.formatVersion(".") shouldBe "000000"
+        }
+
+        test("should format multiple dots '..' correctly") {
+            OneSignalUtils.formatVersion("..") shouldBe "000000"
+        }
+
+        test("should format non-numeric 'a.b.c' correctly") {
+            OneSignalUtils.formatVersion("a.b.c") shouldBe "0a0b0c"
+        }
+
+        test("should format version with extra segments '1.2.3.4' correctly") {
+            OneSignalUtils.formatVersion("1.2.3.4") shouldBe "010203"
+        }
+
+        test("should format version with large components '100.200.300' correctly") {
+            OneSignalUtils.formatVersion("100.200.300") shouldBe "100200300"
+        }
+
+        test("should format '0.0.0' as '000000'") {
+            OneSignalUtils.formatVersion("0.0.0") shouldBe "000000"
+        }
+
+        test("should format '0.0.1' as '1'") { // "000001" then trimmed
+            OneSignalUtils.formatVersion("0.0.1") shouldBe "000001"
+        }
+    }
+
+    context("formatVersion trims leading zeros correctly") {
+        test("should format '05.02.01' (no leading zero in result) as '050201'") {
+            OneSignalUtils.formatVersion("05.02.01") shouldBe "050201"
+        }
+
+        test("should format '0.2.1' (becomes '000201') and trim to '0201'") {
+            OneSignalUtils.formatVersion("0.2.1") shouldBe "000201"
+        }
+
+        // test for "0.0.0" is already covered in edge cases
+        // test for "0.0.1" is already covered in edge cases
+    }
+
+    test("should format '5.2.1' with patch") {
+        OneSignalUtils.formatVersion("5.2.1") shouldBe "050201"
+    }
+
+    test("should format '5.2' without patch") {
+        OneSignalUtils.formatVersion("5.2") shouldBe "050200"
+    }
+
+    test("should format '5.2.0-beta-06' with patch and suffix") {
+        OneSignalUtils.formatVersion("5.2.0-beta-06") shouldBe "050200-beta-06"
+    }
+
+    test("should format '5.2-beta' without patch, with suffix") {
+        OneSignalUtils.formatVersion("5.2-beta") shouldBe "050200-beta"
+    }
+
+    test("should format '5' without patch or minor") {
+        OneSignalUtils.formatVersion("5") shouldBe "050000"
+    }
+
+    test("sdkVersion should return the formatted version from BuildConfig.SDK_VERSION") {
+        // Calculate expected based on the real BuildConfig.SDK_VERSION
+        val expectedDirectlyFromFormatVersion = OneSignalUtils.formatVersion(BuildConfig.SDK_VERSION)
+        OneSignalUtils.sdkVersion shouldBe expectedDirectlyFromFormatVersion
+    }
+})
diff --git a/OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/http/HttpClientTests.kt b/OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/http/HttpClientTests.kt
@@ -67,7 +67,7 @@ class HttpClientTests : FunSpec({
 
         // Then
         for (connection in mocks.factory.connections) {
-            connection.getRequestProperty("SDK-Version") shouldBe "onesignal/android/${OneSignalUtils.SDK_VERSION}"
+            connection.getRequestProperty("SDK-Version") shouldBe "onesignal/android/${OneSignalUtils.sdkVersion}"
             connection.getRequestProperty("OneSignal-Install-Id") shouldBe mocks.installIdService.getId().toString()
         }
     }
diff --git a/OneSignalSDK/settings.gradle b/OneSignalSDK/settings.gradle
@@ -3,7 +3,11 @@
 gradle.rootProject {
     allprojects {
         group = 'com.onesignal'
-        version = '5.1.37'
+        if (!gradle.rootProject.hasProperty("SDK_VERSION") ||
+                gradle.rootProject.getProperty("SDK_VERSION").toString().trim().isEmpty()) {
+            throw new RuntimeException("SDK_VERSION is not defined. Please pass -PSDK_VERSION=X.Y.Z to the build or update gradle.properties.")
+        }
+        version = gradle.rootProject.getProperty("SDK_VERSION")
         configurations.all {
             resolutionStrategy.dependencySubstitution {
                 substitute(module('com.onesignal:OneSignal')).using(project(':OneSignal'))

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,10 @@ allprojects {`
`30`	`30`	`}`
`31`	`31`	`}`
`32`	`32`
	`33`	`+subprojects {`
	`34`	`+ ext.SDK_VERSION = rootProject.findProperty("SDK_VERSION") ?: "x.x.x"`
	`35`	`+}`
	`36`	`+`
`33`	`37`	`task clean(type: Delete) {`
`34`	`38`	`delete rootProject.buildDir`
`35`	`39`	`}`