Controlling Maven final name of jar artifact

Question

I m trying to define a property in our super pom which will be used by all child projects as the destination of the generated artifact   For this I was thinking about using project build finalName yet this does not seem work  even for simple poms   Command   mvn archetype create       -DarchetypeGroupId org apache maven archetypes      -DgroupId com mycompany app      -DartifactId my-app   POM     lt project xmlns  http   maven apache org POM 4 0 0  xmlns xsi  http   www w3 org 2001 XMLSchema-instance    xsi schemaLocation  http   maven apache org POM 4 0 0 http   maven apache org xsd maven-4 0 0 xsd  gt     lt modelVersion gt 4 0 0 lt  modelVersion gt      lt groupId gt com mycompany app lt  groupId gt     lt artifactId gt my-app lt  artifactId gt     lt version gt 1 0-SNAPSHOT lt  version gt     lt packaging gt jar lt  packaging gt      lt name gt my-app lt  name gt     lt url gt http   maven apache org lt  url gt      lt properties gt       lt project build sourceEncoding gt UTF-8 lt  project build sourceEncoding gt     lt  properties gt      lt build gt           lt finalName gt   project name -testing lt  finalName gt     lt  build gt     lt dependencies gt       lt dependency gt         lt groupId gt junit lt  groupId gt         lt artifactId gt junit lt  artifactId gt         lt version gt 3 8 1 lt  version gt         lt scope gt test lt  scope gt       lt  dependency gt     lt  dependencies gt   lt  project gt    And when I executed       mvn install   INFO  Scanning for projects     INFO  ------------------------------------------------------------------------  INFO  Building my-app  INFO     task-segment   install   INFO  ------------------------------------------------------------------------  INFO   resources resources  execution  default-resources    INFO  Using  UTF-8  encoding to copy filtered resources   INFO  skip non existing resourceDirectory  tmp mvn test my-app src main resources  INFO   compiler compile  execution  default-compile    INFO  Nothing to compile - all classes are up to date  INFO   resources testResources  execution  default-testResources    INFO  Using  UTF-8  encoding to copy filtered resources   INFO  skip non existing resourceDirectory  tmp mvn test my-app src test resources  INFO   compiler testCompile  execution  default-testCompile    INFO  Nothing to compile - all classes are up to date  INFO   surefire test  execution  default-test    INFO  Surefire report directory   tmp mvn test my-app target surefire-reports  -------------------------------------------------------  T E S T S ------------------------------------------------------- Running com mycompany app AppTest Tests run  1  Failures  0  Errors  0  Skipped  0  Time elapsed  0 024 sec  Results    Tests run  1  Failures  0  Errors  0  Skipped  0   INFO   jar jar  execution  default-jar    INFO   install install  execution  default-install    INFO  Installing  tmp mvn test my-app target my-app-testing jar to  home maxim  m2 repository com mycompany app my-app 1 0-SNAPSHOT my-app-1 0-SNAPSHOT jar  INFO  ------------------------------------------------------------------------  INFO  BUILD SUCCESSFUL  INFO  ------------------------------------------------------------------------  INFO  Total time  2 seconds  INFO  Finished at  Sun Nov 21 18 37 02 IST 2010  INFO  Final Memory  17M 162M  INFO  ------------------------------------------------------------------------   I would expect the string  testing  would appear somewhere in the generated artifact name   Am I misunderstanding the purpose of  finalName

User · Answer

At the package stage  the plugin allows configuration of the imported file names via file mapping   maven-ear-plugin  http   maven apache org plugins maven-ear-plugin examples customize-file-name-mapping html     lt plugin gt       lt groupId gt org apache maven plugins lt  groupId gt       lt artifactId gt maven-ear-plugin lt  artifactId gt       lt version gt 2 7 lt  version gt       lt configuration gt                        lt fileNameMapping gt full lt  fileNameMapping gt       lt  configuration gt   lt  plugin gt    http   maven apache org plugins maven-war-plugin war-mojo html outputFileNameMapping  If you have configured your version to be  testing  via a profile or something  this would work for a war package   maven-war-plugin   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 2 2 lt  version gt       lt configuration gt           lt encoding gt UTF-8 lt  encoding gt                                   lt outputFileNameMapping gt   groupId  -  artifactId  -  baseVersion    dashClassifier      extension   lt  outputFileNameMapping gt       lt  configuration gt   lt  plugin gt

User · Answer

In my maven ee project I am using    lt build gt       lt finalName gt shop lt  finalName 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   maven war version  lt  version gt               lt configuration gt  lt webappDirectory gt   project build directory    project build finalName       lt  webappDirectory gt               lt  configuration gt           lt  plugin gt       lt  plugins gt   lt  build gt

User · Answer

Maxim  try this     pom xml      lt groupId gt org opensource lt  groupId gt    lt artifactId gt base lt  artifactId gt    lt version gt 1 0 0 SNAPSHOT lt  version gt                     lt properties gt       lt my version gt 4 0 8 8 lt  my version gt   lt  properties gt    lt build gt       lt finalName gt my-base-project lt  finalName gt       lt plugins gt           lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-install-plugin lt  artifactId gt               lt version gt 2 3 1 lt  version gt               lt executions gt                   lt execution gt                       lt goals gt                           lt goal gt install-file lt  goal gt                       lt  goals gt                       lt phase gt install lt  phase gt                       lt configuration gt                           lt file gt   project build finalName    project packaging  lt  file gt                           lt generatePom gt false lt  generatePom gt                           lt pomFile gt pom xml lt  pomFile gt                           lt version gt   my version  lt  version gt                       lt  configuration gt                   lt  execution gt               lt  executions gt           lt  plugin gt   lt  plugins gt   lt  build gt    Commnad mvn clean install  Output   INFO  --- maven-jar-plugin 2 3 1 jar  default-jar    base ---  INFO  Building jar  D  dev project base target my-base-project jar  INFO   INFO  --- maven-install-plugin 2 3 1 install  default-install    base ---  INFO  Installing D  dev project base target my-base-project jar to H  dev  m2 repository org opensource base 1 0 0 SNAPSHOT base-1 0 0 SNAPSHOT jar  INFO  Installing D  dev project base pom xml to H  dev  m2 repository org opensource base 1 0 0 SNAPSHOT base-1 0 0 SNAPSHOT pom  INFO   INFO  --- maven-install-plugin 2 3 1 install-file  default    base ---  INFO  Installing D  dev project base my-base-project jar to H  dev  m2 repository org opensource base 4 0 8 8 base-4 0 8 8 jar  INFO  Installing D  dev project base pom xml to H  dev  m2 repository org opensource base 4 0 8 8 base-4 0 8 8 pom  INFO  ------------------------------------------------------------------------  INFO  BUILD SUCCESS  INFO  ------------------------------------------------------------------------    Reference

User · Answer

The approach you ve been using indeed does jar file with a string  testing  in its name  as you specified  but the default install command sends it to your    m2 repository directory  as seen in this output line    tmp mvn test my-app target my-app-testing jar to  home maxim  m2 repository com mycompany app my-app 1 0-SNAPSHOT my-app-1 0-SNAPSHOT jar   It seems to me that you re trying to generate a jar with such name and then copy it to a directory of your choice   Try using outputDirectory property as described here  http   maven apache org plugins maven-jar-plugin jar-mojo html

User · Answer

The simplest solution   lt artifactId gt Example lt  artifactId gt   lt version gt 1 0 lt  version gt    lt properties gt       lt jarName gt   project artifactId -  project version  lt  jarName gt   lt  properties gt    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 version gt 3 0 2 lt  version gt           lt configuration gt               lt finalName gt   jarName  lt  finalName gt           lt  configuration gt       lt  plugin gt         lt  plugins gt   lt  build gt   Which results in  mvn clean package -DjarName 123 - gt  target 123 jar mvn clean package - gt  target Example jar

User · Answer

All of the provided answers are more complicated than necessary  Assuming you are building a jar file  all you need to do is add a  lt jar finalName gt  tag to your  lt properties gt  section    lt properties gt       lt jar finalName gt   project name  lt  jar finalName gt   lt  properties gt    This will generate a jar   project target   project name  jar   This is in the documentation - note the User Property   finalName  Name of the generated JAR  Type  java lang String Required  No User Property  jar finalName Default    project build finalName    Command Line Usage  You should also be able to use this option on the command line with   mvn -Djar finalName myCustomName       You should get myCustomName jar  although I haven t tested this

User · Answer

You set the finalName property in the plugin configuration section    lt plugin gt       lt groupId gt org apache maven plugins lt  groupId gt       lt artifactId gt maven-jar-plugin lt  artifactId gt       lt version gt 2 3 2 lt  version gt       lt configuration gt           lt finalName gt myJar lt  finalName gt                          lt  configuration gt   lt  plugin gt           As indicated in the official documentation   Update   For Maven    3  Based on Matthew s comment you can now do it like this     lt packaging gt jar lt  packaging gt    lt build gt      lt finalName gt WhatEverYouLikey lt  finalName gt    lt  build gt    See bug report documentation

User · Answer

This works for me  mvn jar jar -Djar finalName custom-jar-name

User · Answer

I am using the following                        lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-jar-plugin lt  artifactId gt               lt version gt 3 0 2 lt  version gt               lt configuration gt                   lt finalName gt   project groupId    project artifactId -  baseVersion    monthlyVersion    instanceVersion  lt  finalName gt               lt  configuration gt           lt  plugin gt                 This way you can define each value individually or pragmatically from Jenkins of some other system   mvn package -DbaseVersion 1 -monthlyVersion 2 -instanceVersion 3   This will place a folder target  group id  projectName-1 2 3 jar  A better way to save time might be                        lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-jar-plugin lt  artifactId gt               lt version gt 3 0 2 lt  version gt               lt configuration gt                   lt finalName gt   project groupId    project artifactId -  baseVersion  lt  finalName gt               lt  configuration gt           lt  plugin gt                 Like the same except I use on variable     mvn package -DbaseVersion 0 3 4   This will place a folder target  group id  projectName-1 2 3 jar  you can also use outputDirectory inside of configuration to specify a location you may want the package to be located

[java] Controlling Maven final name of jar artifact

maven-ear-plugin

maven-war-plugin

Examples related to java

Examples related to maven-2

Examples related to jar

Examples related to build-automation