9

The Maven WAR plugin has two configuration options: warSourceExcludes and packagingExcludes. There is some documentation on packagingExcludes, saying that:

It is possible to include or exclude certain files from the WAR file, by using the <packagingIncludes> and <packagingExcludes> configuration parameters.

However, I find it very difficult to find information on warSourceExcludes.

What is the difference between these two configuration options?

I'm using Maven 3.1.1 and the WAR plugin is version 2.4

Kevin
  • 4,070
  • 4
  • 45
  • 67

2 Answers2

11

warSourceExcludes: The comma separated list of tokens to exclude when copying the content of the warSourceDirectory.

packagingExcludes: The comma separated list of tokens to exclude from the WAR before packaging.

With packagingExcludes, the tokens are completely excluded from the final war file.

With warSourceExcludes, the tokens are just ignored when copying the war directory into the war file.

As a result, if the tokens are present in the webappDirectory for example, they will not be ignored when using warSourceExcludes but will be when usingpackagingExcludes.

Naman
  • 27,789
  • 26
  • 218
  • 353
Amir Keibi
  • 1,991
  • 28
  • 45
  • 1
    What do you mean by "ignored when copying"??? If they are not copied to the war file - they are not packaged in the war file, and it's the same as packagingExcludes. Can you explain it more clearly? – kolobok May 30 '16 at 07:32
  • the example at the end of the paragraph should've clarified. – Amir Keibi May 30 '16 at 16:55
  • 2
    No. It doesn't make any sense. I have tried the same filter (e.g. `index*`) with `packagingExcludes`, and then only with `warSourceExcludes`. The resulting war file is the same - index.jsp is not in a generated war file. A temporary folder (target/asdf) is different, but does it matter? – kolobok May 30 '16 at 19:59
  • I agree. It makes no sense. The answer of ryenus should be the accepted answer – Matthias Apr 07 '20 at 14:02
4

The process of producing the final war file can be simplified as two major steps:

  1. the web resources are copied from ${warSourceDirectory} into ${<webappDirectory>}, let's say it's target/artifact/, which can be treated like:

    cp -r src/main/webapp/* target/artifact/

    <warSourceExcludes> is used at this step, so that the excluded files are NOT copied into target/artifact/.

  2. the output directory target/artifact of the above step, namely ${webappDirectory}, is then used as the input to produce the final war file, like:

    jar --create --file target/artifact.war -C target/artifact/ WEB-INF ...

    And here <packagingExcludes> is used, deciding what to pack up from target/artifact/.

see https://maven.apache.org/plugins/maven-war-plugin/war-mojo.html

ryenus
  • 15,711
  • 5
  • 56
  • 63