Giter Club home page Giter Club logo

versionberg's Introduction

CircleCI Versionberg on Maven Central

Versionberg

Gradle plugin for versioning your library/application on every git commit.

image

(Generated by Breaking Bad Generator)

Usage

You can use the new plugin syntax for gradle 2.1+:

plugins {
  id "io.github.rockerhieu.versionberg" version "<latest-version>"
}

Or the legacy way:

buildscript {
   repositories {
       maven { url "https://plugins.gradle.org/m2/" } // or jcenter()
   }
   dependencies {
       classpath 'io.github.rockerhieu:versionberg:<latest-version>'
   }
}

apply plugin: 'io.github.rockerhieu.versionberg'

Gradle tasks

versionbergInfo: print version info into the console, e.g:

$ ./gradlew versionbergInfo
$ Versionberg: 
          major: 1
          minor: 0
          patch: 10
          build: 25
          commitSha: d48434f
          commitCount: 25
          code: 1000000025
          name: 1.0.d48434f-SNAPSHOT
          gitDir: null

Java

buildscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2/" } // or jcenter()
    }
    dependencies {
        classpath 'io.github.rockerhieu:versionberg:<latest-version>'
    }
}

apply plugin: 'io.github.rockerhieu.versionberg'
apply plugin: 'java'

versionberg {
    major 1
    minor 0
    patch 0
}

version = versionberg.name

Android

buildscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2/" } // or jcenter()
    }
    dependencies {
        classpath 'io.github.rockerhieu:versionberg:<latest-version>'
    }
}

apply plugin: 'io.github.rockerhieu.versionberg'
apply plugin: 'com.android.application'

versionberg {
    major 1
    minor 0
    patch 0
}

android {
    defaultConfig {
        versionCode versionberg.code
        versionName versionberg.name
    }
}

Advanced usage

Custom git repo

By default the plugin will try to find the git repo in the root project directory. But you can change it to any git repo that you want by setting gitDir:

versionberg {
    major 1
    minor 0
    gitDir new File("path/to/git/repo/.git")
}

Template

You can define template for version name and version code if you don't want to use the default settings provided by Versionberg

versionberg {
    // Increase when you make incompatible API changes (default value is 0)
    major 1

    // Increase when you add functionality in a backwards-compatible manner (default value is 0)
    minor 0

    // Increase when you make backwards-compatible bug fixes (default value is 0)
    patch 0

    // default is ${commitCount}, uncomment to use a custom build number
    // build 2

    // Default version name template is '${major}.${minor}.${patch}.${build}'
    nameTemplate '${major}.${minor}.${new Date().format("ddMMyyyy")}-SNAPSHOT'
    
    // Default version code template is '${build}'
    codeTemplate '(((${major} * 100) + ${minor}) * 100) * 100000 + ${build}'
}

You can put date into the template, i.e ${new Date().format("ddMMyyyy")}, see more at SimpleDateFormat.

See Advanced Usage for the list of all available variables can be used in nameTemplate and codeTemplate.

My config

This is the config that I been using for some years:

versionberg {
    major 1
    minor 0
    nameTemplate '${major}.${minor}.${commitCount}.${commitSha}'
    codeTemplate '(((${major} * 100) + ${minor}) * 100) * 100000 + ${build}'
}

Example value:

major: 1
minor: 0
patch: 0
build: 12
commitSha: 9a35eb9
commitCount: 12
code: 1000000012
name: 1.0.12.9a35eb9

Main advantages:

  • ${commitCount}: easy to reference to a version when communicating
  • ${commitSha}: easy to identify the git revision of a given build

Contributing

Please fork this repository and contribute back using pull requests.

Any contributions, large or small, major features, bug fixes, additional language translations, unit/integration tests are welcomed and appreciated but will be thoroughly reviewed and discussed.

License

Copyright (c) 2016 Hieu Rocker

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

versionberg's People

Contributors

herocc avatar rockerhieu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

versionberg's Issues

Issue with large number due to shell.evaluate under Eval.me

return Eval.me(engine.createTemplate(codeTemplate).make(getMap()).toString())

i have huge issue with this script :

apply plugin: 'io.github.rockerhieu.versionberg'
versionberg {
    // Increase when you make incompatible API changes (default value is 0)
    major 25
    minor 1
        nameTemplate 'V01.${major}${minor}-${commitSha}-${new Date().format("dd_MM_yyyy")}'
    codeTemplate '${major}*(100000000) + ${minor}*(10000) +${build}'
}

it always return negative value due tu integer overflow

after some reseach and test on https://groovyconsole.appspot.com/

the codeTemplate is working when you add L at the end of large number :
'25*(100000000) + 1*(10000) +1198' = -1794956098
'25*(100000000L) + 1*(10000L) +1198' = 2500011198

i try : codeTemplate '${major}*(100000000L) + ${minor}*(10000L) +${build}' but doesn't work i still got negative value. ๐Ÿ˜•

Any help, or ideas ?

thanks
thomas

It can work only as a counter build?

I want only to count the times that I build without Git implement.

My code:

apply plugin: 'io.github.rockerhieu.versionberg'
apply plugin: 'com.android.application'
apply plugin: 'realm-android'

versionberg {
    major 1
    minor 0
    patch 0
    nameTemplate '${major}.${minor}.${patch}.${build}'
}

android {
    compileSdkVersion 24
    buildToolsVersion "24.0.1"

    defaultConfig {
        applicationId "app.descubrirosona.lite"
        minSdkVersion 16
        targetSdkVersion 24
        versionCode 1
        versionName versionberg.name
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'

        }
    }
    return true
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    testCompile 'junit:junit:4.12'
    compile 'com.android.support:appcompat-v7:24.2.1'
    compile 'com.android.support:design:24.2.1'
    compile 'com.github.paolorotolo:appintro:3.4.0'
    compile 'com.jonathanfinerty.once:once:1.2.1'
    compile 'com.facebook.stetho:stetho:1.4.1'
    compile 'com.uphyca:stetho_realm:0.9.0'
}

Always is 1.0.0.0

Casting exception

I am having the following error when I use io.github.rockerhieu:versionberg:1.0.1

Cannot cast object 'null' with class 'null' to class 'int'. Try 'java.lang.Integer' instead

This doesn't seem to be the case if I compile the plugin from the source, and declare it as the dependency. Is io.github.rockerhieu:versionberg:1.0.1 the latest version?

For the record, the same gradle script runs well if I use io.github.rockerhieu:versionberg:1.0.0 and comment out the gitDir attribute.

Subprojects using root's version fields

I have an app and a library located at different git repositories. The lib is git submodule and a sub gradle project, both using Versionberg. When the gradle is invoked from the app's top-level for compilation, the version fields are propagated to subproject.

For example, I have

  • Project Root
    --- app (assume version as 1.0.20.XXXXXXX)
    --- someLib (git module, assume version as 1.0.50.YYYYYYY)

when assembleDebug is invoked, the following output files are produced

app-1.0.20.XXXXXXX.apk
someLib-1.0.20.XXXXXXX.aar

The expected output, however, should be

app-1.0.20.XXXXXXX.apk
someLib-1.0.50.YYYYYYY.aar

Not sure, if this is a bug, or an expected behavior. Is there a way to "clear" the state of Versionberg.

Thank you.

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.