Getting application version from pom

Question

I have a rest endpoint used to return information about application (so far only app version) But so far this info is hardcoded, and it's pretty easy to forget to change it. I will be better to retrieve app version from pom or manifest file. Is there any project that brings such functionality?

Answer 1

There is amazing project named Appinfo, please use it and enjoy! (It has an ugly page, I know - but it works :)

AppInfo allows to automatically feed your application with a current version number, build date or build number.

---

Also excellent Spring Boot Actuator provides feature named Info Endpoint which can publish version information to web or REST.

By default the Actuator adds an /info endpoint to the main server. It contains the commit and timestamp information from git.properties (if that file exists) and also any properties it finds in the environment with prefix "info".

Answer 2

You better use build-in manifest.

new Manifest(Application.class.getResourceAsStream("/META-INF/manifest.mf"))

For the concrete impl-version:

new Manifest(Application.class.getResourceAsStream("/META-INF/manifest.mf"))
            .getMainAttributes()
            .get(Attributes.Name.IMPLEMENTATION_VERSION)

Using maven do not forget to create the manifest using:

<?xml version="1.0" encoding="UTF-8"?>
<project>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.4</version>
                <configuration>
                    <archive>
                        <manifest>
                            <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

Answer 3

Spring Boot can refer to the project version defined in pom.xml and expose it via REST using Actuator:

# application.properties
endpoints.info.enabled=true
info.app.version=@project.version@

Then accessing the /info URL (e.g. http://localhost:8080/info) will return:

{"app": {"version": "<major.minor.incremental>"}}

See also: spring boot/spring web app embedded version number

Answer 4

You could use the resource filtering of maven or something like the maven-substitute-plugin.