14 October 2014

One great way to track where and when your application came from when building is into include source control information. With Spring Boot, this functionality comes out of the box (more or less). If you read the documentation, it suggests using the the gradle-git plugin to generate this data at build time. However, there is a simple way to do this using Groovy that does not involve the use of a plugin:

task generateGitProperties {
    doLast {
        try {
            def branch = 'git rev-parse --abbrev-ref HEAD'.execute().text.trim()
            def revision = 'git rev-list --max-count 1 --timestamp HEAD'.execute().text.trim()
            def commitHash = revision.split(' ').last()
            def timestamp = revision ? new java.util.Date(java.util.concurrent.TimeUnit.SECONDS.toMillis(revision.split(' ').first() as long)).format("yyyy-MM-dd'T'HH:mm:ssZ") : null

            File resourcesDir = new File(project.getBuildDir(), 'resources/main')
            File propertiesFile = new File(resourcesDir, 'git.properties')

            if(timestamp) {
                // The project may not have any resources, so create the directories and file
                if(!propertiesFile.exists()) {
                propertiesFile.text = """git.branch=${branch}
            } else {
               project.logger.error('Unable to generate Git properties file:  revision could not be retrieved from Git.')
        } catch (e) {
            project.logger.error('Unable to generate Git properties file.', e)


// Generate the Git commit properties file prior to building the artifact

The task above will include the git.properties file in the packaged Spring Boot JAR and can be accessed at the /info servlet to see what branch and hash were used to build your application. It will also safely fail on systems that do not have Git installed or do not have Git on the path (such as if you try to execute this task from inside an IDE).

comments powered by Disqus