A Gradle plugin that generates a git.properties file containing Git repository metadata at build time.

• Requirements
• Installation
• Configuration
• Kotlin DSL
• Spring Boot Integration
• Advanced Usage
• Compatibility
• License

• Java 8 or higher
• Gradle 5.1 or higher
• A Git repository (.git directory)

Add the plugin to your build file:

Groovy DSL (build.gradle)

plugins {
    id "com.gorylenko.gradle-git-properties" version "2.5.7"
}

Kotlin DSL (build.gradle.kts)

plugins {
    id("com.gorylenko.gradle-git-properties") version "2.5.7"
}

The plugin generates git.properties at build/resources/main/git.properties. For Java projects, generation occurs automatically during the build. For non-Java projects, run the task explicitly:

./gradlew generateGitProperties

All configuration is optional. The plugin uses sensible defaults.

Customize the output file name and directory:

gitProperties {
    gitPropertiesName = "git-info.properties"
    gitPropertiesResourceDir = file("${project.rootDir}/src/main/resources")
}

Configure the format for git.commit.time using SimpleDateFormat patterns and TimeZone IDs:

gitProperties {
    dateFormat = "yyyy-MM-dd'T'HH:mm:ssZ"
    dateFormatTimeZone = "UTC"
}

By default, the plugin generates all available properties:

To generate only specific properties, use the keys option:

gitProperties {
    keys = ['git.branch', 'git.commit.id', 'git.commit.time']
}

Add custom properties using static values or closures. Closures receive a Grgit instance for accessing Git data:

gitProperties {
    customProperty 'greeting', 'Hello'
    customProperty 'my_custom_git_id', { it.head().id }
    customProperty 'project_version', { project.version }
}

You can also override standard properties. This example includes lightweight tags in git.commit.id.describe:

gitProperties {
    customProperty 'git.commit.id.describe', { it.describe(tags: true) }
}

Override the detected branch name. This is useful in CI environments where builds run in detached HEAD state:

gitProperties {
    branch = System.getenv('BRANCH_NAME')
}

The plugin automatically detects branch names from these CI environments:

• GitHub Actions
• GitLab CI
• Jenkins
• CircleCI
• Travis CI
• Azure DevOps
• Bitbucket Pipelines
• Bamboo
• AWS CodeBuild

Specify a custom .git directory location:

gitProperties {
    dotGitDirectory = layout.projectDirectory.dir("../.git")
}

To suppress errors when the .git directory is missing:

gitProperties {
    failOnNoGitDirectory = false
}

To disable git.properties generation:

tasks.withType(com.gorylenko.GenerateGitPropertiesTask).configureEach {
    enabled = false
}

Basic configuration:

gitProperties {
    dateFormat = "yyyy-MM-dd'T'HH:mm:ssZ"
    dateFormatTimeZone = "UTC"
    keys = listOf("git.branch", "git.commit.id", "git.commit.time")
}

For custom properties with closures, use KotlinClosure1. The closure receiver is a Grgit instance:

import org.gradle.kotlin.dsl.KotlinClosure1
import gradlegitproperties.org.ajoberstar.grgit.Grgit

gitProperties {
    customProperty("greeting", "Hello")
    customProperty("my_custom_git_id", KotlinClosure1<Grgit, String>({ head().id }))
}

The plugin integrates with Spring Boot Actuator. The /info endpoint automatically includes Git information when git.properties is present on the classpath.

By default, Spring Boot exposes only git.branch, git.commit.id, and git.commit.time. To expose all properties, add to application.properties:

management.info.git.mode=full

{
  "git": {
    "commit": {
      "time": "2018-03-28T05:13:53Z",
      "id": "32ff212"
    },
    "branch": "Fix_issue_68"
  }
}

{
  "git": {
    "build": {
      "host": "myserver-1",
      "version": "0.0.1-SNAPSHOT",
      "user": {
        "name": "First Last",
        "email": "username1@example.com"
      }
    },
    "branch": "Fix_issue_68",
    "commit": {
      "message": {
        "short": "Fix issue #68",
        "full": "Fix issue #68"
      },
      "id": {
        "describe": "v1.4.21-28-g32ff212-dirty",
        "abbrev": "32ff212",
        "full": "32ff212b9e2873fa4672f1b5dd41f67aca6e0731"
      },
      "time": "2018-03-28T05:13:53Z",
      "user": {
        "email": "username1@example.com",
        "name": "First Last"
      }
    },
    "closest": {
      "tag": {
        "name": "v1.4.21",
        "commit": {
          "count": "28"
        }
      }
    },
    "dirty": "true",
    "remote": {
      "origin": {
        "url": "git@github.com:n0mer/gradle-git-properties.git"
      }
    },
    "tags": "",
    "total": {
      "commit": {
        "count": "93"
      }
    }
  }
}

Use extProperty to expose generated properties to other build tasks. This enables use cases such as embedding the Git commit ID in JAR manifests.

gitProperties {
    extProperty = 'gitProps'
}

// Ensure properties are always regenerated
generateGitProperties.outputs.upToDateWhen { false }

bootJar {
    dependsOn generateGitProperties
    manifest {
        // Use lazy GString evaluation to defer property access
        attributes('Git-Commit': "${-> project.ext.gitProps['git.commit.id.abbrev']}")
    }
}

The plugin supports Gradle configuration cache.

This project is licensed under the Apache License 2.0.

Originally inspired by @lievendoclo's article "Spring Boot's info endpoint, Git and Gradle" (2014).