Skip to content

Latest commit

 

History

History
50 lines (41 loc) · 2.43 KB

README.md

File metadata and controls

50 lines (41 loc) · 2.43 KB
Raw

android-release-gradle-plugin

Maven Central

A Gradle plugin to automate scm-releases of Android apps

Note: This plugin was created together with certain Android app projects. Hence, it is tailored exactly for their way of releasing and versioning and offers only little configuration options at the moment. However, if it does not fit your needs, you're welcome to open a feature request.

Usage

Creating a new release of your Android app is performed in two steps performed on the master-branch. The plugin adds two Gradle tasks to your project, one for each of these steps:

gradle performRelease expects a semantic SNAPSHOT-version of the form "major.minor.fix-SNAPSHOT". It will remove the "-SNAPSHOT" suffix from the version, commit this change and tag that commit with "major.minor.fix".

Afterwards gradle prepareNextDevelopmentVersion prepares the next SNAPSHOT-version by incrementing the minor-, resetting the fix-version and appending the "-SNAPSHOT" suffix. It also increments the versionCode of the app-module. Furthermore, it clears the changelog in 'app-module/src/main/play/release-notes/de-DE/default.txt' as specified by the Gradle Play Publisher plugin. These changes are committed again.

Applying the plugin in your Android project

Make sure to add Maven Central to pull the plugin from in your 'settings.gradle.kts':

pluginManagement {
    repositories {
        gradlePluginPortal()
        mavenCentral()
        //...
    }
}

Then in your root 'build.gradle.kts' apply the plugin:

plugins {
    id("rocks.frieler.android.release") version "0.4.0"
}

You can configure the plugin using the releasing-extension again in your root 'build.gradle.kts':

releasing {
    appModule = "my-app" // Name of the actual app-module, defaults to "app".
}

Contributing

If you have a feature idea, problem or question you can open an issue. If you want to work on this plugin to contribute a PR, have a look at the development docs.