【Android】GitHub Actionsでアプリのバージョン情報を更新する【株式会社ライトコード】

はじめに

現在、個人開発しているAndroidアプリでFirebase App Distributionへの自動デプロイする際に利用している、GitHub Actionsを利用したアプリバージョン情報の更新 について解説していこうと思います。

次の記事では、実際に今回の方法と組み合わせて 1クリックでバージョン更新 & Firebase App Distributionにアプリをデプロイする方法 について執筆予定です。

それでは早速見ていきましょう！

どうしてやったの？

Androidアプリを継続リリースするためには、リリースAPKをビルドする前にアプリのバージョン情報を更新する必要があります。

バージョン情報は「バージョンコード」と「バージョン名」の2つで構成されています。

プロジェクトのビルドファイルapp/build.gradle.ktsにあるversionCode/versionNameがそれぞれ「バージョンコード」/「バージョン名」に対応します。

ここを開発者が編集しリリースAPKをビルドする、というのが一般的です。

/// app/build.gradle.kts

android {

    /* ~中略~ */

    defaultConfig {

        /* ~中略~ */

        versionCode = 12

        versionName = "0.10.0"

    }

    /* ~中略~ */

}

この部分を GitHub Actionsを利用して自動化する ことで、タイムコストを削減しつつ手動更新によるヒューマンエラーを防ぐことができます。

また、GitHub上で実行するため開発者の環境に依存せず実行できるというメリットもあります。

何をやったの？

今回、この仕組みを作るにあたって行なったことは大きく分けて2つです。

バージョン情報を更新するGradleタスクの実装
1を実行するGitHub Actionsのワークフローの実装

それでは、それぞれで具体的に何をやったのか、詳しく見ていきましょう。

ちなみに、今回Gradleファイルを扱いますが、Kotlin DSLでの実装を前提としています。

1. バージョン情報を更新するGradleタスクの実装

まず、versionCodeとversionNameからバージョンコード/バージョン名を操作するクラスを実装します。

/// app/build.gradle.kts

// バージョンを取り扱うクラス

class Version(private var code: Int, version: String) {

    private var major: Int

    private var minor: Int

    private var patch: Int



    init {

        // "0.0.0"で表現されるバージョン名を、メジャー/マイナー/パッチに分割 & 整数として操作できるように管理する。

        val (major, minor, patch) = version.split(".").map { it.toInt() }

        this.major = major

        this.minor = minor

        this.patch = patch

    }



    // バージョン情報を操作するメソッドをコマンドから実行するために、各メソッド名を保持。

    val functionsByName = listOf(::bumpMajor, ::bumpMinor, ::bumpPatch).associateBy { it.name }



    @SuppressWarnings("unused")

    fun bumpMajor() {

        major += 1

        minor = 0

        patch = 0



        code += 1

    }



    @SuppressWarnings("unused")

    fun bumpMinor() {

        minor += 1

        patch = 0



        code += 1

    }



    @SuppressWarnings("unused")

    fun bumpPatch() {

        patch += 1



        code += 1

    }



    fun getName(): String = "$major.$minor.$patch"

    fun getCode(): Int = code

}

バージョン番号/バージョン情報それぞれの文字列から、メジャー/マイナー/パッチを抽出して保持し、それぞれを操作するメソッドを実装しています。

次にGradleタスクのコマンドでそれぞれのメソッドを実行するために、メソッド名のリストをfunctionsByNameで保持しておきます。

次に実際にバージョン情報を操作するGradleタスクのコマンドを実装していきます。

/// app/build.gradle.kts

tasks.addRule("Pattern: bumpVersion") {

    if (this.matches(Regex("bump(Major|Minor|Patch)Version"))) {

        task(this) {

            doLast {

                // コマンド名から実行タイプを抽出

                val type = this@addRule

                    .replace(Regex("bump"), "")

                    .replace(Regex("Version"), "")



                println("Bumping ${type.lowercase(Locale.getDefault())} version...")



                // 旧バージョンを取得

                val oldVersionCode = android.defaultConfig.versionCode ?: return@doLast

                val oldVersionName = android.defaultConfig.versionName ?: return@doLast

                val version = Version(oldVersionCode, oldVersionName)



                // メソッド名を取得しそのメソッドを実行（実行不可であればエラー）

                val methodName = "bump${type}"

                version.functionsByName[methodName]?.invoke() ?: error("Unknown method: $methodName")



                // 更新したバージョンを取得

                val newVersionCode = version.getCode()

                val newVersionName = version.getName()



                println("${oldVersionName}($oldVersionCode) -> ${newVersionName}($newVersionCode)")



                // ビルドファイルに更新したversionName・versionCodeを書き込み

                var updated = buildFile.readText()

                updated = updated.replaceFirst(

                    "versionName = \"${oldVersionName}\"",

                    "versionName = \"${newVersionName}\""

                )

                updated = updated.replaceFirst(

                    "versionCode = $oldVersionCode",

                    "versionCode = $newVersionCode"

                )

                buildFile.writeText(updated)

            }

        }

    }

}



// バージョン情報を出力するコマンド群

tasks.register("printVersionCode") {

    doLast {

        println(android.defaultConfig.versionCode)

    }

}



tasks.register("printVersionName") {

    doLast {

        println(android.defaultConfig.versionName)

    }

}