aboutsummaryrefslogtreecommitdiff
path: root/buildSrc/src/main/java/VersioningPlugin.kt
blob: a2c9ff8118c135dea5fb5d6d4224d4865b8ae8b0 (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*
 * Copyright © 2014-2021 The Android Password Store Authors. All Rights Reserved.
 * SPDX-License-Identifier: GPL-3.0-only
 */


import com.android.build.gradle.internal.plugins.AppPlugin
import com.vdurmont.semver4j.Semver
import java.io.OutputStream
import java.util.Properties
import org.gradle.api.Plugin
import org.gradle.api.Project

private const val VERSIONING_PROP_FILE = "version.properties"
private const val VERSIONING_PROP_VERSION_NAME = "versioning-plugin.versionName"
private const val VERSIONING_PROP_VERSION_CODE = "versioning-plugin.versionCode"
private const val VERSIONING_PROP_COMMENT = """
This file was automatically generated by 'versioning-plugin'. DO NOT EDIT MANUALLY.
"""

/**
 * A Gradle [Plugin] that takes a [Project] with the [AppPlugin] applied and dynamically sets the
 * versionCode and versionName properties based on values read from a [VERSIONING_PROP_FILE] file in
 * the [Project.getBuildDir] directory. It also adds Gradle tasks to bump the major, minor, and patch
 * versions along with one to prepare the next snapshot.
 */
@Suppress(
    "UnstableApiUsage",
    "NAME_SHADOWING"
)
class VersioningPlugin : Plugin<Project> {

    /**
     * Generate the Android 'versionCode' property
     */
    private fun Semver.androidCode(): Int {
        return major * 1_00_00 +
            minor * 1_00 +
            patch
    }

    /**
     * Write an Android-specific variant of [this] to [stream]
     */
    private fun Semver.writeForAndroid(stream: OutputStream) {
        val newVersionCode = androidCode()
        val props = Properties()
        props.setProperty(VERSIONING_PROP_VERSION_CODE, "$newVersionCode")
        props.setProperty(VERSIONING_PROP_VERSION_NAME, toString())
        props.store(stream, VERSIONING_PROP_COMMENT)
    }

    override fun apply(project: Project) {
        with(project) {
            val appPlugin = requireNotNull(plugins.findPlugin(AppPlugin::class.java)) {
                "Plugin 'com.android.application' must be applied to use this plugin"
            }
            val propFile = layout.projectDirectory.file(VERSIONING_PROP_FILE)
            require(propFile.asFile.exists()) {
                "A 'version.properties' file must exist in the project subdirectory to use this plugin"
            }
            val contents = providers.fileContents(propFile).asText.forUseAtConfigurationTime()
            val versionProps = Properties().also { it.load(contents.get().byteInputStream()) }
            val versionName = requireNotNull(versionProps.getProperty(VERSIONING_PROP_VERSION_NAME)) {
                "version.properties must contain a '$VERSIONING_PROP_VERSION_NAME' property"
            }
            val versionCode = requireNotNull(versionProps.getProperty(VERSIONING_PROP_VERSION_CODE).toInt()) {
                "version.properties must contain a '$VERSIONING_PROP_VERSION_CODE' property"
            }
            appPlugin.extension.defaultConfig.versionName = versionName
            appPlugin.extension.defaultConfig.versionCode = versionCode
            afterEvaluate {
                val version = Semver(versionName)
                tasks.register("clearPreRelease") {
                    doLast {
                        version.withClearedSuffix()
                            .writeForAndroid(propFile.asFile.outputStream())
                    }
                }
                tasks.register("bumpMajor") {
                    doLast {
                        version.withIncMajor()
                            .withClearedSuffix()
                            .writeForAndroid(propFile.asFile.outputStream())
                    }
                }
                tasks.register("bumpMinor") {
                    doLast {
                        version.withIncMinor()
                            .withClearedSuffix()
                            .writeForAndroid(propFile.asFile.outputStream())
                    }
                }
                tasks.register("bumpPatch") {
                    doLast {
                        version.withIncPatch()
                            .withClearedSuffix()
                            .writeForAndroid(propFile.asFile.outputStream())
                    }
                }
                tasks.register("bumpSnapshot") {
                    doLast {
                        version.withIncMinor()
                            .withSuffix("SNAPSHOT")
                            .writeForAndroid(propFile.asFile.outputStream())
                    }
                }
            }
        }
    }
}