Add release scripts

Author: tuancoltech

.github/workflows/gradle-release.yml

@@ -0,0 +1,27 @@
+name: Gradle Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: gradle
+
+      - run: git config user.name 'tuancoltech'
+      - run: git config user.email 'tuancoltech@gmail.com'
+
+      - run: ./gradlew utils:releaseClean
+      - run: ./gradlew utils:releasePrepare -PbumpType=patch
+      - run: ./gradlew utils:releasePerform
+        env:
+          GITHUB_TOKEN: ${{ github.token }}

build.gradle

@@ -17,6 +17,7 @@ buildscript {
         classpath libs.kotlin.gradle.plugin
         classpath libs.hilt.gradle.plugin
         classpath libs.hilt.gradle.plugin
+        classpath libs.grgit
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }

gradle/libs.versions.toml

@@ -9,6 +9,7 @@ appcompat = "1.7.0"
 material = "1.12.0"
 hilt = "2.55"
 kotlinAndroidPlugin = "1.9.24"
+grgit = "5.0.0"
 
 [libraries]
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
@@ -24,5 +25,6 @@ hilt-gradle-plugin = { group = "com.google.dagger", name = "hilt-android-gradle-
 kotlin-gradle-plugin = { group = "org.jetbrains.kotlin", name = "kotlin-gradle-plugin", version.ref = "kotlinAndroidPlugin" }
 android-gradle-plugin = { group = "com.android.tools.build", name = "gradle", version.ref = "agp" }
 material = { group = "com.google.android.material", name = "material", version.ref = "material" }
+grgit = { group = "org.ajoberstar.grgit", name = "grgit-gradle", version.ref = "grgit" }
 
 [plugins]

utils/build.gradle

@@ -4,6 +4,7 @@ plugins {
     id 'kotlin-kapt'
     id 'dagger.hilt.android.plugin'
     id 'maven-publish'
+    id 'org.ajoberstar.grgit'
 }
 
 android {
@@ -74,4 +75,135 @@ publishing {
             credentials(PasswordCredentials)
         }
     }
+}
+
+tasks.register('ensureCleanRepo') {
+    doLast {
+        if (!grgit.repository.jgit.status().call().clean) {
+            throw new GradleException('Git status is not clean, please stash your changes!')
+        }
+    }
+}
+
+tasks.register('releaseClean') {
+    dependsOn ensureCleanRepo
+    doLast {
+        def clean = true
+        def applicationId = android.defaultConfig.applicationId
+
+        String headCommitMessage = grgit.head().shortMessage
+        while (headCommitMessage.contains("[gradle-release-task]")) {
+            clean = false
+            println "Found git commit: $headCommitMessage"
+            if (headCommitMessage.indexOf("$applicationId-") > -1) {
+                def tagName = headCommitMessage.split("$applicationId-")[1]
+                println "Removing the git tag: $tagName"
+                try {
+                    grgit.tag.remove {
+                        names = [tagName]
+                    }
+                } catch (Exception e) {
+                    println "Error while removing git tag:\n $e"
+                }
+            }
+            println "Resetting the git commit permanently!"
+            grgit.reset(commit: "HEAD~1", mode: "hard")
+            headCommitMessage = grgit.head().shortMessage
+
+        }
+        if (clean) {
+            println "Repository is already clean"
+        }
+        println "Done!"
+    }
+}
+
+// Task parameters:
+//    bumpVersion -> if available will specify new versionName directly and ignores the `bumpType` parameter.
+//    bumpType[major|minor|patch] -> will specify how the version bumping occurs.
+tasks.register('releasePrepare') {
+    dependsOn ensureCleanRepo
+    doLast {
+        def applicationId = android.defaultConfig.applicationId
+        def versionName = android.defaultConfig.versionName
+
+        if (versionName.indexOf("-") > -1) {
+            versionName = versionName.split("-")[0]
+        }
+
+        // Prepare the release commit with the specific tag.
+        String buildText = buildFile.getText()
+        buildText = buildText.replaceFirst(/versionName(\s+.*)/, "versionName '$versionName'")
+        buildFile.setText(buildText) //replace the build file's text
+        grgit.add(patterns: ['utils/build.gradle'])
+        try {
+            grgit.commit(message: "[gradle-release-task] prepare release $applicationId-$versionName")
+        } catch (Exception e) {
+            throw new GradleException("Failed to commit, error:\n $e")
+        }
+        try {
+            grgit.tag.add {
+                name = versionName
+                message = "Release of $versionName"
+            }
+        } catch (Exception e) {
+            throw new GradleException("Failed to tag the repo, error:\n $e")
+        }
+
+        // Set new version name from input parameters.
+        def newVersionName
+        if (project.properties.containsKey("bumpVersion")) {
+            newVersionName = project.properties["bumpVersion"]
+            println "Bumping the version directly (bumpVersion=$newVersionName)"
+        } else if (project.properties.containsKey("bumpType")) {
+            def (major, minor, patch) = versionName.tokenize('.')
+            switch (bumpType) {
+                case "major":
+                    major = major.toInteger() + 1
+                    minor = 0
+                    patch = 0
+                    break
+                case "minor":
+                    minor = minor.toInteger() + 1
+                    break
+                case "patch":
+                    patch = patch.toInteger() + 1
+                    break
+            }
+            newVersionName = "$major.$minor.$patch"
+        } else {
+            throw new GradleException('Either bumpType or bumpVersion parameters should be provided')
+        }
+
+        // Prepare for next development iteration.
+        def versionCode = android.defaultConfig.versionCode
+        def newVersionCode = versionCode + 1
+        println "Bumping versionName from $versionName to $newVersionName"
+        println "Bumping versionCode from $versionCode to $newVersionCode"
+        buildText = buildFile.getText()
+        buildText = buildText.replaceFirst(/versionName(\s+.*)/, "versionName '$newVersionName-SNAPSHOT'")
+        buildText = buildText.replaceFirst(/versionCode(\s+.*)/, "versionCode $newVersionCode")
+        buildFile.setText(buildText) //replace the build file's text
+        grgit.add(patterns: ['utils/build.gradle'])
+        grgit.commit(message: "[gradle-release-task] prepare for next development iteration")
+        println "Done!"
+    }
+}
+
+tasks.register('releasePerform') {
+    dependsOn ensureCleanRepo
+    doLast {
+        boolean force = false
+        if (project.properties.containsKey("force")) {
+            force = project.properties["force"]
+        }
+        println "Pushing the newest commits to the remote repository (force: $force)"
+        try {
+            grgit.push(force: force, tags: true)
+        } catch (Exception e) {
+            throw new GradleException("Failed to push to the repo,\n" +
+                    " you can try using -Pforce=true parameter to force the push, error: \n$e")
+        }
+        println "Done!"
+    }
 }