How do I embed artifact information in maven shaded jar

Question

I would like to document in the shaded jar what maven artifacts actually end up in that shaded jar.

All the packages get merged and that makes it difficult to workout exactly what artifacts went into it just by looking at the jar.

I suppose the ideal place for that information would be the manifest file but it could just be in a text file.

Ideally I want to see groupId, artifactId and version.

Is this at all possible with the maven shade plugin?

Thanks in advance, Phil.

It's unlikely you can get this kind of information from anything other than the shade plugin itself. So I would look into its configuration properties. For example there's option createDependencyReducedPom which can be combined with keepDependenciesWithProvidedScope to get a modified pom.xml with included dependencies marked with provided scope. I don't see a way to differentiate them from originally provided dependencies, though. — Anton Koscejev

Radouane ROUFID Radouane ROUFID · Accepted Answer · 2016-06-29T10:58:04

You can do this with maven, below steps to follow:

1- Create under src/main/resources a file wich will contain the information, information.txt for example with the following content:

version=${project.version}
artifactId=${project.artifactId}
groupId=${project.groupId}

2- Activate Maven filtring

 <project>
      ...
      <build>
        ...
        <resources>
          <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
            <includes>
                <include>**/information.txt</include>
            </includes>
          </resource>
          ...
        </resources>
        ...
      </build>
      ...
    </project>

3- Build your project. The file will contain now the information you need.

More information about the plugin.

How do I embed artifact information in maven shaded jar

3 Answers