If you need automatic incremental Gradle versioning, this plugin helps you to generate the Android version code and version name automatically based on git commits number, date and Semantic Versioning.
Add the advanced-build-version plugin to your build script and use the property advancedVersioning.versionName
and
advancedVersioning.versionCode
where you need:
Gradle Advanced Build Version | Minumum AGP Version |
---|---|
3.0.0 | 8.1.0 |
2.0.2 | 8.0.0 |
2.0.0 | 7.0.0 |
1.7.3 | 3.0.0 |
Using the plugins DSL:
plugins {
id "me.moallemi.advanced-build-version" version "3.0.0"
}
Using legacy plugin application:
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'me.moallemi.gradle:advanced-build-version:3.0.0'
}
}
apply plugin: 'me.moallemi.advanced-build-version'
advancedVersioning {
nameOptions { }
codeOptions { }
outputOptions { }
}
def appVersionName = advancedVersioning.versionName
def appVersionCode = advancedVersioning.versionCode
You can customize version name in your build.gradle
file as follows:
advancedVersioning {
nameOptions {
versionMajor 1
versionMinor 3
versionPatch 6
versionBuild 8
}
}
the above configuration will output 1.3.6.8
there is no need to specify all params because they will be handled automatically. for example:
advancedVersioning {
nameOptions {
versionMajor 1
versionBuild 8
}
}
will output 1.0.0.8
and
advancedVersioning {
nameOptions {
versionMajor 1
versionMinor 3
}
}
will output 1.3
To customize version code in your build.gradle
file write:
Groovy:
advancedVersioning {
codeOptions {
versionCodeType 'GIT_COMMIT_COUNT'
}
}
Kotlin:
import me.moallemi.gradle.advancedbuildversion.gradleextensions.VersionCodeType.*
advancedVersioning {
codeOptions {
versionCodeType(GIT_COMMIT_COUNT)
}
}
versionCodeType
can be one of following params:
GIT_COMMIT_COUNT
will output total commits number in current branchAUTO_INCREMENT_STEP
will output e.g: 26
If you are using CIs like Jenkins, CircleCI or GitHub Actions, and you want to use GIT_COMMIT_COUNT
, consider checking out repositories with --depth=1
parameter. You should clone your repository with full history or unshallow an already existing one.
For GitHub Actions consider fetch-depth: 0
:
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
AUTO_INCREMENT_STEP
store AI_VERSION_CODE in version.properties
file in build.gradle
directory, you may also change dependsOnTasks
property to specify that on witch tasks should increase version code
(default is every task that contains 'release' in its name)
AUTO_INCREMENT_STEP
allows you to set a step different from 1:
advancedVersioning {
codeOptions {
versionCodeType 'AUTO_INCREMENT_STEP'
versionCodeStep 2 //default to 1
}
}
You can also rename the output generated apk file with this plugin. it can be done just by enabling
the renameOutput
option:
advancedVersioning {
outputOptions {
renameOutput true
}
}
If your app name is MyApp with 2.7 version name, and you are in debug mode, the output apk file name
will be: MyApp-2.7-debug.apk
NOTE for v 2.x.x Only: Android Gradle Plugin 4.1.0 drops support for renaming apk. We are using a workaround to keep renaming option for gradle-advanced-build-version library.
So if you are using AGP 4.1.0+, you have to add advancedVersioning.renameOutputApk()
after android configuration. The order is important:
advancedVersioning {
outputOptions {
renameOutput true
}
}
android {
...
}
advancedVersioning.renameOutputApk()
You can customize the output name by using this params:
${appName}
: name of main module${projectName}
: name of root project${flavorName}
: flavor name${buildType}
: build type${versionName}
: version name${versionCode}
: version code
Groovy:
advancedVersioning {
outputOptions {
renameOutput true
nameFormat '${appName}-${buildType}-${versionName}'
}
}
Kotlin:
advancedVersioning {
outputOptions {
renameOutput(true)
nameFormat("\${appName}-\${buildType}-\${versionName}-\${versionCode}")
}
}
And you can also use custom string in nameFormat
like:
Groovy:
advancedVersioning {
outputOptions {
renameOutput true
nameFormat '${appName}-google-play-${versionName}'
}
}
Kotlin:
advancedVersioning {
outputOptions {
renameOutput(true)
nameFormat("\${appName}-google-play-\${versionName}")
}
}
If your app name is MyApp with 4.6.1 version name the output apk file name will be:
MyApp-google-play-4.6.1.apk
Copyright 2024 Reza Moallemi.
Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements. See the NOTICE file distributed with this work for
additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.