Version Generator

A very simple Gradle plugin (and/or a factory method) to generate version data based on environment status.

Install

Add the dependency to your buildscript block, in your build.gradle at the top:

buildscript {

  repositories {

...

maven {
 url 'https://jitpack.io' 
}

maven {
 url "https://plugins.gradle.org/m2/" 
}

  
}

dependencies {

...

classpath 'com.github.menny:GradleVersion:0.0.4'
  
}
 
}
 

More information about adding dependencies: https://jitpack.io/#menny/GradleVersion/

Usage

In your gradle.build file apply the plugin:

apply plugin: 'net.evendanan.versiongenerator' 

Then, generate the version data

def versionData = versionGenerator.generateVersion(1, 8, 0) 

This will apply the generated version-name to the project.version property. You may want to use the versionData object for other places:

You might want to print out the version info:

println "Building app with ${
versionData.versionName
}
, code ${
versionData.versionCode
}
." 

or, if you are building an Android app, you should also do:

android {

  defaultConfig {

versionCode versionData.versionCode

versionName versionData.versionName
  
}
 
}
 

Generators

The way the version-data is generated is by using a VersionGenerator. Usually, a generator is specific to a local(?) environment, for example the GitBuildVersionGenerator will look at the number of lines in the git history, which will only work in a project that is a git repo. Each generator should also say if it can work in the current local environment. This is the return value of isValidForEnvironment().

Currently, built-in support for:

• StaticVersionGenerator - always returns the same version number.
• GitBuildVersionGenerator - uses the number of commits + tags in the local git repo.
• EnvBuildVersionGenerator.Shippable - uses BUILD_NUMBER environment variable as the version number.
• EnvBuildVersionGenerator.CircleCi - uses CIRCLE_BUILD_NUM environment variable as the version number.

You can also implement your own generators by extending VersionGenerator. You'll need to implement:

//return `true` is this generator can calculate the version-number at the moment. //this could check for existance of an environment variable, //or some file-system attribute/property (like git support), etc. abstract fun isValidForEnvironment(): Boolean  //return an integer representing the version number. This could be the number of builds //done so far, or the number of commits in the source-control system, etc. protected abstract fun getVersionCode(generationData: GenerationData): Int 

The default generators used are (in order)

1. EnvBuildVersionGenerator.CircleCi 2. EnvBuildVersionGenerator.Shippable 3. GitBuildVersionGenerator 4. StaticVersionGenerator 

You can change that (especially, if you have a new generator) by call generate which an ordered-list of generators to use:

def generators = [

new net.evendanan.versiongenerator.generators.EnvBuildVersionGenerator.CircleCi(1650, 0),

new net.evendanan.versiongenerator.generators.GitBuildVersionGenerator(-2268, 0),

new net.evendanan.versiongenerator.generators.StaticVersionGenerator() ]  def versionData = versionGenerator.generateVersion(1, 8, 0, generators) 

AnySoftKeyboard is using this plugin.