How do I exclude certain modules from a Maven build using the commandline

Question

Is there a way to exclude some modules from a big reactor build, similar to -pl ?

Here are a number of ways to do it persistently:

How to exclude a module from a Maven reactor build?

I want to do it from shell, or at least without modifying the poms, which I am not allowed to change.

Using profiles seems to be the easiest and most correct way to me. — Andrew Logvinov, Nov 07 '12 at 17:09
@AndrewLogvinov can that be done in settings.xml ? Switching off tests per profile will not be appreciated in central poms. ;-) — Bastl, Nov 08 '12 at 08:52

score 116 · Accepted Answer · edited Feb 08 '22 at 07:01

116

Maven 3.2.1 has added this feature, you can use to specify the exact projects you want (or to exclude the projects you don't want) -pl or --projects Here's how to exclude two:

-pl "!<modulename>,!<modulename2>"

for exclude certain modules. This can be comma separated list of values that you want to include/exclude.

Update For windows user following

> mvn clean [package|install] --projects \!groupId:artifactId

edited Feb 08 '22 at 07:01

Ratul Sharker

7,484
4
35
44

answered Apr 01 '14 at 10:48

Yogesh_D

17,656
10
41
55

1

! is not work in window. is there different key word ! for window? – bNd Apr 21 '17 at 06:22
1

@bNd on windows you have to mention '!:' of particular module even if it is a submodule – napster Jun 10 '19 at 14:40
4

`` is the directory name of the submodule, not the artifactId – domi Apr 29 '20 at 14:43

score 66 · Answer 2 · answered Dec 16 '14 at 13:20

66

Another comment on the accepted answer, don't forget to escape the exclamation sign when running the command in bash:

> mvn clean install -pl \!module,\!module/submodule,\!groupId:artifactId

answered Dec 16 '14 at 13:20

Radu

2,027
1
15
10

or surround with quotes :) – rogerdpack Sep 20 '16 at 18:18
11

Single quotes ('), that is – dstibbe Jan 05 '18 at 10:06
5

thanks @dstibbe `mvn clean -pl '!module'` did the trick for me – λraulain Nov 08 '18 at 14:47
2

or use `-` instead of `!`, i.e. `> mvn clean install -pl -module,-module/submodule,-groupId:artifactId` – msa May 07 '20 at 18:09

score 19 · Answer 3 · edited Sep 20 '16 at 18:12

19

As Yogesh_D wrote it can be done with the -pl argument with maven 3.2.1+

Here's an example:

> mvn clean install -amd -pl !module,!module/submodule

You need to list every sub-module (and sub-sub-module etc) manually, it does not exclude them recursively. Use the slash for package separation. It's the folder path, not the group or artifact id.

edited Sep 20 '16 at 18:12

rogerdpack

62,887
36
269
388

answered Dec 14 '14 at 10:06

Gonfi den Tschal

1,754
1
20
29

score 6 · Answer 4 · edited Jan 15 '21 at 19:12

6

I don't believe this is currently possible from the command line. There is an open feature request in maven3 for this very thing (https://issues.apache.org/jira/browse/MNG-5230).

Looks like your only option at this point is to modify the pom and create a new build profile that includes only the modules you want to build.

edited Jan 15 '21 at 19:12

Slawomir Jaranowski

7,381
3
25
33

answered Nov 08 '12 at 08:02

gregwhitaker

13,124
7
69
78

Jira link is dead – Dale May 13 '19 at 13:58
MNG-5230 - was resolved in version maven 3.2.1 – Slawomir Jaranowski Jan 15 '21 at 19:13

score 4 · Answer 5 · answered Jan 15 '21 at 19:23

Instead of using exclamation ! sign you can use minus - sign.

mvn clean -pl -module1

You can also exclude multiple modules.

mvn clean -pl -module1,-module2

or

mvn clean -pl -module1 -pl -module2

Tested with:

Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T20:33:14+02:00)
Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)

Excluded modules must be in reactor of current project, so we can't exclude no existing module.

mvn clean -pl -no-existing-module

currently will fail - https://issues.apache.org/jira/browse/MNG-7033

score 1 · Answer 6 · answered Nov 20 '19 at 14:03

1

in 2019 it's

mvn install -pl !:module1

(Windows 10 cmd)

answered Nov 20 '19 at 14:03

davidluckystar

928
5
15

score -2 · Answer 7 · answered Oct 03 '18 at 07:50

-2

comma separated module name enclosed with double quotes. eg::

mvn install -pl "!Module1, !Module2"

answered Oct 03 '18 at 07:50

Nirbhay Rana

4,229
2
18
4

How do I exclude certain modules from a Maven build using the commandline

7 Answers7

Linked

Related