Retrieve version from maven pom xml in code

Question

What is the simplest way to retrieve version number from maven s pom xml in code  i e   programatically

User · Answer

lt build gt               lt finalName gt   project artifactId -  project version  lt  finalName gt               lt pluginManagement gt                   lt plugins gt                       lt plugin gt                           lt groupId gt org apache maven plugins lt  groupId gt                           lt artifactId gt maven-war-plugin lt  artifactId gt                           lt version gt 3 2 2 lt  version gt                           lt configuration gt                               lt failOnMissingWebXml gt false lt  failOnMissingWebXml gt                               lt archive gt                                   lt manifest gt                                       lt addDefaultImplementationEntries gt true lt  addDefaultImplementationEntries gt                                       lt addDefaultSpecificationEntries gt true lt  addDefaultSpecificationEntries gt                                   lt  manifest gt                               lt  archive gt                           lt  configuration gt                       lt  plugin gt                    lt  plugins gt               lt  pluginManagement gt   lt  build gt    Get Version using this getClass   getPackage   getImplementationVersion    PS Don t forget to add    lt manifest gt       lt addDefaultImplementationEntries gt true lt  addDefaultImplementationEntries gt       lt addDefaultSpecificationEntries gt true lt  addDefaultSpecificationEntries gt   lt  manifest gt

User · Answer

There is also the method described in Easy way to display your apps version number using Maven   Add this to pom xml   lt build gt     lt plugins gt       lt plugin gt         lt groupId gt org apache maven plugins lt  groupId gt         lt artifactId gt maven-jar-plugin lt  artifactId gt         lt configuration gt           lt archive gt             lt manifest gt               lt mainClass gt test App lt  mainClass gt               lt addDefaultImplementationEntries gt                true              lt  addDefaultImplementationEntries gt             lt  manifest gt           lt  archive gt         lt  configuration gt       lt  plugin gt     lt  plugins gt   lt  build gt    Then use this   App class getPackage   getImplementationVersion     I have found this method to be simpler

User · Answer

With reference to ketankk s answer   Unfortunately  adding this messed with how my application dealt with resources    lt build gt     lt resources gt       lt resource gt         lt directory gt src main resources lt  directory gt         lt filtering gt true lt  filtering gt       lt  resource gt     lt  resources gt      lt  build gt    But using this inside maven-assemble-plugin s  lt  manifest   tag did the trick    lt addDefaultImplementationEntries gt true lt  addDefaultImplementationEntries gt   lt addDefaultSpecificationEntries gt true lt  addDefaultSpecificationEntries gt    So I was able to get version using  String version   getClass   getPackage   getImplementationVersion

User · Answer

The accepted answer may be the best and most stable way to get a version number into an application statically  but does not actually answer the original question  How to retrieve the artifact s version number from pom xml  Thus  I want to offer an alternative showing how to do it dynamically during runtime   You can use Maven itself  To be more exact  you can use a Maven library    lt dependency gt     lt groupId gt org apache maven lt  groupId gt     lt artifactId gt maven-model lt  artifactId gt     lt version gt 3 3 9 lt  version gt   lt  dependency gt    And then do something like this in Java   package de scrum master app   import org apache maven model Model  import org apache maven model io xpp3 MavenXpp3Reader  import org codehaus plexus util xml pull XmlPullParserException   import java io FileReader  import java io IOException   public class Application       public static void main String   args  throws IOException  XmlPullParserException           MavenXpp3Reader reader   new MavenXpp3Reader            Model model   reader read new FileReader  pom xml             System out println model getId             System out println model getGroupId             System out println model getArtifactId             System out println model getVersion               The console log is as follows   de scrum-master stackoverflow my-artifact jar 1 0-SNAPSHOT de scrum-master stackoverflow my-artifact 1 0-SNAPSHOT     Update 2017-10-31  In order to answer Simon Sobisch s follow-up question I modified the example like this   package de scrum master app   import org apache maven model Model  import org apache maven model io xpp3 MavenXpp3Reader  import org codehaus plexus util xml pull XmlPullParserException   import java io File  import java io FileReader  import java io IOException  import java io InputStreamReader   public class Application     public static void main String   args  throws IOException  XmlPullParserException       MavenXpp3Reader reader   new MavenXpp3Reader        Model model      if   new File  pom xml    exists          model   reader read new FileReader  pom xml         else       model   reader read          new InputStreamReader            Application class getResourceAsStream                META-INF maven de scrum-master stackoverflow aspectj-introduce-method pom xml                                     System out println model getId         System out println model getGroupId         System out println model getArtifactId         System out println model getVersion

User · Answer

Packaged artifacts contain a META-INF maven   groupId    artifactId  pom properties file which content looks like    Generated by Maven  Sun Feb 21 23 38 24 GMT 2010 version 2 5 groupId commons-lang artifactId commons-lang   Many applications use this file to read the application jar version at runtime  there is zero setup required   The only problem with the above approach is that this file is  currently  generated during the package phase and will thus not be present during tests  etc  there is a Jira issue to change this  see MJAR-76   If this is an issue for you  then the approach described by Alex is the way to go

User · Answer

Use this Library for the ease of a simple solution  Add to the manifest whatever you need and then query by string    System out println  JAR was created by     Manifests read  Created-By       http   manifests jcabi com index html

User · Answer

Assuming you re using Java  you can   Create a  properties file in  most commonly  your src main resources directory  but in step 4 you could tell it to look elsewhere    Set the value of some property in your  properties file using the standard Maven property for project version  foo bar   project version    In your Java code  load the value from the properties file as a resource from the classpath  google for copious examples of how to do this  but here s an example for starters    In Maven  enable resource filtering  This will cause Maven to copy that file into your output classes and translate the resource during that copy  interpreting the property   You can find some info here but you mostly just do this in your pom   lt build gt     lt resources gt       lt resource gt         lt directory gt src main resources lt  directory gt         lt filtering gt true lt  filtering gt       lt  resource gt     lt  resources gt      lt  build gt     You can also get to other standard properties like project name  project description  or even arbitrary properties you put in your pom  lt properties gt   etc   Resource filtering  combined with Maven profiles  can give you variable build behavior at build time   When you specify a profile at runtime with -PmyProfile  that can enable properties that then can show up in your build

User · Answer

If you use mvn packaging such as jar or war  use   getClass   getPackage   getImplementationVersion     It reads a property  Implementation-Version  of the generated META-INF MANIFEST MF  that is set to the pom xml s version  in the archive

User · Answer

Sometimes the Maven command line is sufficient when scripting something related to the project version  e g  for artifact retrieval via URL from a repository   mvn help evaluate -Dexpression project version -q -DforceStdout   Usage example   VERSION    mvn help evaluate -Dexpression project version -q -DforceStdout   ARTIFACT ID    mvn help evaluate -Dexpression project artifactId -q -DforceStdout   GROUP ID URL    mvn help evaluate -Dexpression project groupId -q -DforceStdout   sed -e  s      g    curl -f -S -O http   REPO-URL mvn-repos   GROUP ID URL    ARTIFACT ID    VERSION    ARTIFACT ID -  VERSION  jar

User · Answer

When using spring boot  this link might be useful  https   docs spring io spring-boot docs 2 3 x reference html howto html howto-properties-and-configuration With spring-boot-starter-parent you just need to add the following to your application config file    get values from pom xml pom version  project version   After that the value is available like this   Value  quot   pom version  quot   private String pomVersion

User · Answer

To complement what  kieste has posted  which I think is the best way to have Maven build informations available in your code if you re using Spring-boot  the documentation at http   docs spring io spring-boot docs current reference htmlsingle  production-ready-application-info is very useful   You just need to activate actuators  and add the properties you need in your application properties or application yml  Automatic property expansion using Maven  You can automatically expand info properties from the Maven project using resource filtering  If you use the spring-boot-starter-parent you can then refer to your Maven    project properties    via      placeholders  e g   project artifactId myproject project name Demo project version X X X X project description Demo project for info endpoint info build artifact  project artifactId  info build name  project name  info build description  project description  info build version  project version

[java] Retrieve version from maven pom.xml in code

Examples related to java

Examples related to maven-2

Examples related to version