Elias Lecomte

<h2>Version number and code?</h2>
While building Android apps, there are 2 very important characteristics; the version number and version code.
You define them in your <code>app/build.gradle</code>:
<pre class="language-groovy"><code class="language-groovy">android { defaultConfig { versionName 1.2.3 versionCode 123</code></pre>
We typically want to change this version code so that it's clear that it's built by CI and by which pipeline.
Also, the version code has to be higher then the previous release when uploading an app to the Play Store.
<h3>Via gradle.properties</h3>
We've been making Android apps for many years now, and typically defined the version code and name in the <code>gradle.properties</code>.
This makes it easy to find and update manually or with a script.
<pre class="language-groovy"><code class="language-groovy">projectVersionName=1.2.3 projectVersionCode=1230</code></pre>
In your <code>app/build.gradle</code> you can then use these properties:
<pre class="language-groovy"><code class="language-groovy">android { defaultConfig { versionName projectVersionName versionCode projectVersionCode</code></pre>
<h3>Gradle property</h3>
The next iteration, fueled by Fastlane documentation was to pass a gradle property when building your app.
So you build your app with:
<pre class="language-shell"><code class="language-shell">./gradlew assembleRelease -PciVersionCode=1004 -PciVersionName="1.0.0.4"</code></pre>
Or if you use Fastlane:
<pre class="language-groovy"><code class="language-groovy">gradle( task: "assemble", build_type: "release", properties: { "ciVersionCode" => 1001, "ciVersionName" => "1.0.0.4", }</code></pre>
In your <code>app/build.gradle</code> you then need to add some code to check if the property is present or not and use them accordingly:
<pre class="language-groovy"><code class="language-groovy">def newVersionName if (project.hasProperty('ciVersionName') &amp;&amp; project.ciVersionName) { newVersionName = project.ciVersionName } else { newVersionName = projectVersion } def actualVersionCode android { defaultConfig { versionName newVersionName versionCode newVersionCode</code></pre>
<h3>With a fastlane plugin</h3>
There is also a Fastlane plugin <a href="https://github.com/beplus/fastlane-plugin-versioning_android">fastlane-plugin-versioning-android</a> that actually rewrites your <code>app/build.gradle</code> file.
I do think this is a cool approach, but I'm always careful not to use yet another dependency that isn't activily maintained.
<h2>Or, you can change it without writing code in your app/build.gradle!</h2>
While all of these previous solutions are nice, they require you to add code. And while I was reading through the Fastlane documentation I actually discovered that there is a baked-in gradle metbod that isn't very known at all.
After reading the <a href="https://docs.fastlane.tools/actions/gradle/">fastlane gradle documentation</a>, going through this never resolved <a href="https://github.com/fastlane/fastlane/issues/15633">issue</a>, I then discovered this <a href="https://stackoverflow.com/questions/36213977/is-it-possible-to-set-android-version-code-and-name-via-a-gradle-task/36221899#">this stackoverflow thread</a>.
Somewhere at the bottom of it there is a small reply that you can actually use <code>android.injected.version.code</code> and <code>android.injected.version.name</code> to edit this without further configuration!
All the constants that you can use this way look to be listed in <a href="https://www.javadoc.io/static/com.android.tools.build/builder-model/2.5.0-alpha-preview-02/constant-values.html">this javadoc</a>. Not the best reference, but after some testing I can conclude that this works wonderfully!
To summarize, if you want to change your android version code and name, you can now simply use these gradle properties and no longer have to write code in your <code>app/build.gradle</code>!
I've also made a PR on the Fastlane documentation to make this clearer in their docs: https://github.com/fastlane/fastlane/pull/19370#issuecomment-923986665 (which has been merged :sparkles:).
<h3>Gradle property</h3>
<pre class="language-shell"><code class="language-shell">./gradlew assembleRelease -Pandroid.injected.version.code=123145 -Pandroid.injected.version.name="1.2.3.145"</code></pre>
<h3>Fastlane</h3>
<pre class="language-groovy"><code class="language-groovy">gradle( task: "assemble", build_type: "release", properties: { "android.injected.version.code" => "1.2.3.145", "android.injected.version.name"=> 123456, } )</code></pre>

Changing Android version number and code while building on CI

Remain up to date in the continuously evolving technology landscape. The ITP Tech Radar reflects our current view on software engineering technologies.

Android

Why do we adopt this technology?

Articles

Changing Android version number and code while building on CI