How to inject SVN revision number into JAR?

views:

answers:

+3 Q:

How to inject SVN revision number into JAR?

I want my JAR/WAR application to know what is the SVN revision number of its source code. I want this revision number to be later rendered for web end-users at the bottom of a web page, etc.

Is there any existing Maven plugin to automate the process? I think that the plugin has to collect the information from svn and save to some file, like src/resources/revision.txt.

You can use svn keyword substitution

qrtt1 2010-10-12 12:10:07

@qrtt1 In such a case I will pickup the SVN version of this particular file, not of the entire code base.

Vincenzo 2010-10-12 12:14:12

Keyword substitution is only performed on changed files, i.e. no change, no new revision number. One has to read the current project's revision from the `.svn` directory. MediaWiki has code that does that, however it is written in PHP.

Archimedix 2010-10-12 12:16:07

+2 A:

use the ~~versions-maven-plugin~~ buildnumber-maven-plugin from the Codehaus Mojo project. Provides lots of options to do this.

Salandur 2010-10-12 12:22:52

Really? I can't find any. We are talking about SVN revision, not POM version.

seanizer 2010-10-12 12:24:48

i have edited my anwser, had the wrong plugin

Salandur 2010-10-12 12:30:25

@Salandur Thanks for the update, but this is exactly what `seanizer` have explained above.

Vincenzo 2010-10-12 12:46:15

Salandur 2010-10-12 12:53:27

@Vincenzo: when two people give the same answer it can still be correct (+1 for Salandur)

seanizer 2010-10-12 12:55:58

@Salandur, I upvoted your answer, thanks!

Vincenzo 2010-10-12 13:00:32

+3 A:

This page provides the answer to an almost identical problem:

Maven CookBook: How To Add SVN Revision To A JAR Manifest?

In your case, instead of building a manifest entry, you need to use the buildNumber variable for resource filtering

seanizer 2010-10-12 12:23:17

@seanizer What's wrong with manifest entry? I assume that it is accessible from Java then. Right?

Vincenzo 2010-10-12 12:39:10

@vincenzo sure, there was a question about a similar problem yesterday (you can use the answer): http://stackoverflow.com/questions/3907737/how-to-read-manifest-mf-from-pojo-class-not-a-servlet-instantiated-by-spring

seanizer 2010-10-12 12:50:22

@vincenzo but filtering a jsp or simple text file with maven is a lot easier

seanizer 2010-10-12 12:54:21

beware: this revision number will be only the revision of the topmost project directory. if you have separately ran "svn up" in some subdirectory, this will not be recorded. Not an issue, if you turn on the <doUpdate>true</doUpdate> option. Safer option would be to list the revisions of all subdirectories and files, but I have not yet come across a publicly available plugin that would be capable of this (we have one developed in-house, it also records the SVN URL so you know which branch the code is from).

Neeme Praks 2010-10-12 13:00:39

ansaurus

tags:

views:

answers:

How to inject SVN revision number into JAR?

related questions