Changed!: Move to semantic versioning for app version and add commit hash and github to APK file names

The `versionName` will now follow semantic version `2.0.0` spec in the format `major.minor.patch(-prerelease)(+buildmetadata)`. This will make versioning the prerelease and github debug builds versions easier and follow as spec. The @termux devs should make sure that when bumping `versionName` in `build.gradle` file and when creating a tag for new releases on github that they include the patch number as well, like `v0.1.0` instead of just `v0.1`. The `build.gradle` file and `attach_debug_apks_to_release` workflow will now validate the version as well and the build/attachment will fail if `versionName` does not follow the spec. https://semver.org/spec/v2.0.0.html

APKs released on github for debug build workflows and releases are now referred as `Github` releases as per termux/termux-app@7b10a35f and termux/termux-app@94e01d68, so APK filenames have been modified to include `github` in the filename. The APKs are still debuggable, so that tag remains too.

For github workflows the apk filename format will be `termux-widget_<current_version>+<last_commit_hash>-github-debug_<arch>.apk`, like `termux-widget_v0.1.0+xxxxxxxx-github-debug_arm64-v8a.apk` and for github releases it will be `termux-widget_<release_version>-github-debug_<arch>.apk`, like `termux-widget_v0.1-github-debug_arm64-v8a.apk`. The `last_commit_hash` will be the first `8` characters of the commit hash. The `<last_commit_hash>-github-debug` will act as `buildmetadata` and will not affect versioning precedence.

For github workflows triggered by `push` and `pull_request` triggers, `<current_version>+<last_commit_hash>` will be used as new `versionName`, like `v0.1.0+xxxxxxxx`. This will make tracking which build a user is using easier and help in resolving issues as well.

The `app/build.gradle` now also supports following `TERMUX_WIDGET_` scoped environmental variables and `RELEASE_TAG` variable will not be used anymore since it may conflict with possibly other variables used by users.

- `TERMUX_WIDGET_APP_VERSION_NAME` will be used as `versionName` if its set.
- `TERMUX_WIDGET_APK_VERSION_TAG` will be used as `termux-widget_<TERMUX_WIDGET_APK_VERSION_TAG>.apk` if its set.

Author: agnostic-apollo

.github/workflows/attach_debug_apks_to_release.yml

@@ -6,27 +6,31 @@ on:
       - published
 
 jobs:
-  build:
+  attach-apks:
     runs-on: ubuntu-latest
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
-      - name: Set tag
-        id: vars
-        run: echo ::set-output name=tag::${GITHUB_REF/refs\/tags\//}
       - name: Clone repository
         uses: actions/checkout@v2
         with:
           ref: ${{ env.GITHUB_REF }}
+      - name: Set vars
+        run: |
+          RELEASE_VERSION_NAME="${GITHUB_REF/refs\/tags\//}"
+          if ! printf "%s" "${RELEASE_VERSION_NAME/v/}" | grep -qP '^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$'; then
+            echo "The versionName '${RELEASE_VERSION_NAME/v/}' is not a valid version as per semantic version '2.0.0' spec in the format 'major.minor.patch(-prerelease)(+buildmetadata)'. https://semver.org/spec/v2.0.0.html."
+            exit 1
+          fi
+          echo "TERMUX_WIDGET_RELEASE_TAG=$RELEASE_VERSION_NAME" >> $GITHUB_ENV
+          echo "TERMUX_WIDGET_APK_VERSION_TAG=$RELEASE_VERSION_NAME+github-debug" >> $GITHUB_ENV # Used by app/build.gradle
+      - name: Echo release
+        run: echo "Attaching debug APK to '${{ env.TERMUX_WIDGET_RELEASE_TAG }}' release"
       - name: Build
-        env:
-          RELEASE_TAG: ${{ steps.vars.outputs.tag }}
         run: ./gradlew assembleDebug
-      - name: Attach debug APKs to release
-        env:
-          RELEASE_TAG: ${{ steps.vars.outputs.tag }}
+      - name: Attach APKs to release
         run: >-
           hub release edit
           -m ""
-          -a ./app/build/outputs/apk/debug/termux-widget-$RELEASE_TAG-debug.apk
-          $RELEASE_TAG
+          -a "./app/build/outputs/apk/debug/termux-widget_${{ env.TERMUX_WIDGET_APK_VERSION_TAG }}.apk"
+          "${{ env.TERMUX_WIDGET_RELEASE_TAG }}"

.github/workflows/debug_build.yml

@@ -6,15 +6,24 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - name: Clone repository
-      uses: actions/checkout@v2
-    - name: Build
-      run: |
-        ./gradlew assembleDebug
-    - name: Store generated APK file
-      uses: actions/upload-artifact@v2
-      with:
-        name: termux-widget
-        path: |
-          ./app/build/outputs/apk/debug/termux-widget-debug.apk
-          ./app/build/outputs/apk/debug/output-metadata.json
+      - name: Clone repository
+        uses: actions/checkout@v2
+      - name: Set vars
+        run: |
+          # Set NEW_VERSION_NAME to "<CURRENT_VERSION_NAME>+<last_commit_hash>"
+          CURRENT_VERSION_NAME_REGEX='\s+versionName "([^"]+)"$'
+          CURRENT_VERSION_NAME="$(grep -m 1 -E "$CURRENT_VERSION_NAME_REGEX" ./app/build.gradle | sed -r "s/$CURRENT_VERSION_NAME_REGEX/\1/")"
+          NEW_VERSION_NAME="$CURRENT_VERSION_NAME+${GITHUB_SHA:0:7}"
+          echo "TERMUX_WIDGET_APP_VERSION_NAME=$NEW_VERSION_NAME" >> $GITHUB_ENV # Used by app/build.gradle
+          echo "TERMUX_WIDGET_APK_VERSION_TAG=v$NEW_VERSION_NAME-github-debug" >> $GITHUB_ENV # Used by app/build.gradle
+      - name: Echo version
+        run: echo "Building APK for '$TERMUX_WIDGET_APP_VERSION_NAME'"
+      - name: Build
+        run: ./gradlew assembleDebug
+      - name: Store generated APK file
+        uses: actions/upload-artifact@v2
+        with:
+          name: termux-widget
+          path: |
+            ./app/build/outputs/apk/debug/termux-widget_${{ env.TERMUX_WIDGET_APK_VERSION_TAG }}.apk
+            ./app/build/outputs/apk/debug/output-metadata.json

app/build.gradle

@@ -2,12 +2,18 @@ apply plugin: 'com.android.application'
 
 android {
     compileSdkVersion project.properties.compileSdkVersion.toInteger()
+    def appVersionName = System.getenv("TERMUX_WIDGET_APP_VERSION_NAME") ?: ""
+    def apkVersionTag = System.getenv("TERMUX_WIDGET_APK_VERSION_TAG") ?: ""
+
     defaultConfig {
         applicationId "com.termux.widget"
         minSdkVersion project.properties.minSdkVersion.toInteger()
         targetSdkVersion project.properties.targetSdkVersion.toInteger()
         versionCode 12
-        versionName "0.12"
+        versionName "0.12.0"
+
+        if (appVersionName) versionName = appVersionName
+        validateVersionName(versionName)
 
         manifestPlaceholders.TERMUX_PACKAGE_NAME = "com.termux"
         manifestPlaceholders.TERMUX_APP_NAME = "Termux"
@@ -44,19 +50,14 @@ android {
     applicationVariants.all { variant ->
         variant.outputs.all { output ->
             if (variant.buildType.name == "debug") {
-                def releaseTag = System.getenv("RELEASE_TAG")
-                outputFileName = new File("termux-widget" + (releaseTag ? "-" + releaseTag : "") + "-debug.apk")
+                outputFileName = new File("termux-widget_" + (apkVersionTag ? apkVersionTag : "debug") + ".apk")
+            } else if (variant.buildType.name == "release") {
+                outputFileName = new File("termux-widget_" + (apkVersionTag ? apkVersionTag : "release") + ".apk")
             }
         }
     }
 }
 
-task versionName {
-  doLast {
-    print android.defaultConfig.versionName
-  }
-}
-
 dependencies {
     // required for TermuxWidgetControlsProviderService
     implementation "org.reactivestreams:reactive-streams:1.0.3"
@@ -68,3 +69,16 @@ dependencies {
     // If updates are done, republish there and sync project with gradle files here
     //implementation 'com.termux:termux-shared:0.117'
 }
+
+task versionName {
+    doLast {
+        print android.defaultConfig.versionName
+    }
+}
+
+def validateVersionName(String versionName) {
+    // https://semver.org/spec/v2.0.0.html#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+    // ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
+    if (!java.util.regex.Pattern.matches("^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?\$", versionName))
+        throw new GradleException("The versionName '"  + versionName + "' is not a valid version as per semantic version '2.0.0' spec in the format 'major.minor.patch(-prerelease)(+buildmetadata)'. https://semver.org/spec/v2.0.0.html.")
+}