Matthias Friedrich's Blog

Adding the Git Revision to a Docker Image

Spring Boot makes it quite easy to find the Git revision of a running application. You add a Gradle plugin and the revision is added to the Actuator's info endpoint. What it doesn't do though is publish the Git revision as part of the SBOM or OCI metadata. That requires some manual work.

The basic idea is using the data that the gradle-git-properties plugin makes available and pass it in an environment variable to the Paketo Image Labels Buildpack.

First of all, you need the mentioned Gradle plugin, which puts a git.properties file on the classpath:

plugins {
    // ...
    id 'com.gorylenko.gradle-git-properties' version '2.4.0'
}

That file is picked up and exposed as a GitProperties bean to the Spring Boot application - this is how the Actuator picks it up and adds it to its info endpoint.

Several attempts with Groovy's string interpolation failed, but this is how it finally worked:

gitProperties {
    extProperty = 'gitProps'
}

generateGitProperties.outputs.upToDateWhen { false }

task addRevision(dependsOn: 'generateGitProperties') {
    doLast {
        bootBuildImage.environment['BP_OCI_REVISION'] = gitProps['git.commit.id']
    }
}

bootBuildImage {
    imageName = "registry.mafr.de/mafr/${project.name}"
    environment = [
        "BP_OCI_VENDOR": "mafr.de",
        "BP_OCI_VERSION": version,
    ]
}

bootBuildImage.dependsOn addRevision

You build the image as usual:

$ ./gradlew bootBuildImage

The labels are visible when inspecting the image.

If anyone finds an easier way to do this with Gradle, please let me know.

Other articles

Prometheus and Spring Boot Health Checks

Published: Sun 24 June 2018
By mafr

In java.

When trying to set up alerting for Spring Boot services with Prometheus, I discovered the synthetic "up" time series which is great for checking whether the monitoring system can reach my service instances. While this is a great thing, I also wanted to alert on the health status of my …
read more
Spring Boot: Logging Failed Logins

Published: Tue 18 April 2017
By mafr

In java.

tags: security

In many applications it's important to react to failed logins and other security-critical events, for example to log the failed login attempt to a file or to display a captcha after repeated failures. Spring-based applications come with a simple mechanism to access this kind of information using Application Events.

Spring's …
read more
Empty InputStream with Spring MVC

Published: Fri 06 January 2017
By mafr

In java.

tags: server web

The other day, I was trying to build a simple batch upload interface for a Java web application running Spring Boot with Spring MVC on Apache Tomcat. But when I tried reading the InputStream in my controller, it was always empty. Fortunately, this turned out to be quite easy to …
read more
Resolving JARs

Published: Sun 20 March 2016
By mafr

In java.

tags: java python

Sometimes it's useful to check whether a local JAR file is available from Maven Central, for example when converting an old build system to Maven. In many old systems, JARs aren't named consistently and versioning info isn't available. Fortunately, Maven Central has a search interface that supports lookup by a …
read more
Normalizing Text in Java

Published: Sat 10 October 2015
By mafr

In java.

tags: best practices

Once in a while I see misguided attempts at normalizing text to make it suitable for use in URLs, file names, or other situations where a plain ASCII representation is desired. This can be tricky but with Java's excellent Unicode support and some background knowledge it is pretty easy to …
read more
Installing Oracle's JDK on Debian/Ubuntu

Published: Sun 09 November 2014
By mafr

In java.

tags: linux ubuntu

Due to licensing issues, Linux distributions don't ship Oracle Java packages anymore. In many cases, that doesn't matter since you can just use OpenJDK. But if you do need Oracle's JDK, Debian packages are a bit more convenient than handling tarballs because they integrate nicely with the rest of the …
read more
Maven: Discovering Dependency Conflicts

Published: Sat 30 August 2014
By mafr

In java.

tags: maven shell

Among other things, Maven's dependency plugin displays the result of Maven's dependency resolution mechanism. The output of the dependency:tree goal makes it easy to see where transitive dependencies come from. This week I discovered that recent versions of the plugin also support a verbose flag that lists conflicts and …
read more
Testing equals() with Guava

Published: Mon 21 July 2014
By mafr

In java.

tags: best practices libraries testing

I've long held the opinion that Guava belongs on every Java classpath because its design and the quality of its implementation surpass other comparable utility libraries (and sometimes even the JDK). Guava's testlib is pretty cool, too, even though it's not as widely known.

Most things in testlib are useful …
read more
Visualizing Package Dependencies

Published: Sun 26 August 2012
By mafr

In java.

tags: python quality tools

Managing module or package dependencies is an important design activity that helps to keep a software project maintainable. Visualizing these dependencies is a good way of getting a first impression on a project and for exposing design problems. In this article we're going to create a basic visualization for a …
read more

Other articles

social