Search code examples
mavenjarmaven-assembly-plugin

remove file from jar-with-dependencies with maven assembly plugin


I use maven-assembly-plugin version 3.1.1 to make a jar with all dependencies included. I want to exclude my application.yml however I am unable to remove it from jar.

pom.xml :

             <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.1.1</version>
                <configuration>
                    <descriptors>
                        <descriptor>env/assembly/descriptor.xml</descriptor>
                    </descriptors>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

my descriptor.xml:

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.0 http://maven.apache.org/xsd/assembly-2.1.0.xsd">
    <id>test</id>
    <formats>
        <format>jar</format>
    </formats>
    <includeBaseDirectory>false</includeBaseDirectory>
    <dependencySets>
        <dependencySet>
            <outputDirectory>/</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact>
            <unpack>true</unpack>
            <scope>compile</scope>
            <excludes>
                <exclude>
                    application.yml
                </exclude>
            </excludes>
        </dependencySet>
    </dependencySets>
    <fileSets>
        <fileSet>
            <outputDirectory>/</outputDirectory>
            <directory>${project.build.outputDirectory}</directory>
            <excludes>
                <exclude>
                    application.yml
                </exclude>
            </excludes>
        </fileSet>
    </fileSets>
</assembly>

result :

The following patterns were never triggered in this artifact exclusion filter:
o  'application.yml'

If instead of application.yml i use the * pattern all file are well removed.

I have tried to put the absolute path but it change nothing :

        <excludes>
            <exclude>
                env/dev/conf/application.yml
            </exclude>
        </excludes>

Also the exclude in my fileSets seam useless.

Also tried this pattern in fileSets and dependencySet but application.yml still include :

         <exclude>
            **/application.yml
        </exclude>

Solution

  • solution that worked, I forgot to add the unpackOptions in the assembly file :

    pom.xml :

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>3.1.1</version>
            <executions>
                <execution>
                    <id>make-jar</id>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                    <configuration>
                    <descriptors>
                        <descriptor>env/assembly/descriptor.xml</descriptor>
                    </descriptors>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    

    descriptor.xml :

    <assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.0"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.0 http://maven.apache.org/xsd/assembly-2.1.0.xsd">
        <id>jar-with-dependencies</id>
        <formats>
            <format>jar</format>
        </formats>
        <includeBaseDirectory>false</includeBaseDirectory>
        <fileSets>
            <fileSet>
                <outputDirectory>/</outputDirectory>
                <directory>${project.basedir}</directory>
            </fileSet>
        </fileSets>
        <dependencySets>
            <dependencySet>
                <outputDirectory>/</outputDirectory>
                <useProjectArtifact>true</useProjectArtifact>
                <unpack>true</unpack>
                <scope>runtime</scope>
                <unpackOptions>
                    <excludes>
                        <exclude>**/application.yml</exclude>
                    </excludes>
                </unpackOptions>
            </dependencySet>
        </dependencySets>
    </assembly>