Git Product home page Git Product logo

gradle-advanced-build-version's Introduction

Gradle Advanced Build Version Plugin

A plugin to generate the Android version code and version name automatically based on git commits number, date and Semantic Versioning.

GitHub Workflow Status Maven Central Coverage

Contents

  1. Installation
  2. How to use
  3. Version Name Configuration
  4. Version Code Configuration
  5. File output options

Installation

Add the advanced-build-version plugin to your build script and use the property advancedVersioning.versionName and advancedVersioning.versionCode where you need:

buildscript {
  repositories {
      jcenter()
  }

  dependencies {
      classpath 'me.moallemi.gradle:advanced-build-version:1.7.1'
  }
}

apply plugin: 'me.moallemi.advanced-build-version'

How to use

advancedVersioning {
    nameOptions { }
    codeOptions { }
    outputOptions { }
}

def appVersionName = advancedVersioning.versionName
def appVersionCode = advancedVersioning.versionCode

Version Name Configuration

You can customize version name in your build.gradle file as follow:

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

Version Code Configuration

To customize version code in your build.gradle file write:

advancedVersioning {
    codeOptions {
        versionCodeType 'GIT_COMMIT_COUNT'
    }
}

versionCodeType can be one of following params:

  • GIT_COMMIT_COUNT will output total commits number in current branch
  • DATE formatted number e.g.: 1501101614
  • AUTO_INCREMENT_DATE will output 101101614
  • AUTO_INCREMENT_ONE_STEP will output e.g: 24. this property stores 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)
advancedVersioning {
  codeOptions {
      versionCodeType 'AUTO_INCREMENT_ONE_STEP'
      dependsOnTasks 'release' // defaultValue
  }
}

Setting multiple tasks for dependsOnTasks property:

advancedVersioning {
  codeOptions {
      versionCodeType 'AUTO_INCREMENT_ONE_STEP'
      dependsOnTasks 'debug', 'release', 'assemble'
  }
}

File output options

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

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
advancedVersioning {
  outputOptions {
      renameOutput true
      nameFormat '${appName}-${buildType}-${versionName}'
  }
}

And you can also use custom string in nameFormat like:

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

License

Copyright 2020 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.