Skip a submodule during a Maven build

Question

We have a need to be able to skip a submodule in certain environments   The module in question contains integration tests and takes half an hour to run   So we want to include it when building on the CI server  but when developers build locally  and tests get run   we want to skip that module   Is there a way to do this with a profile setting   I ve done some googling and looked at the other questions answers here and haven t found a good solution   I suppose one option is to remove that submodule from the parent pom xml entirely  and just add another project on our CI server to just build that module   Suggestions

User · Answer

Maven version 3 2 1 added this feature  you can use the -pl switch  shortcut for --projects list  with   or -  source  to exclude certain submodules   mvn -pl   submodule-to-exclude  install mvn -pl -submodule-to-exclude install   Be careful in bash the character   is a special character  so you either have to single quote it  like I did  or escape it with the backslash character   The syntax to exclude multiple module is the same as the inclusion  mvn -pl   submodule1  submodule2  install mvn -pl -submodule1 -submodule2 install   EDIT Windows does not seem to like the single quotes  but it is necessary in bash   in Windows  use double quotes  thanks  awilkinson   mvn -pl   submodule1  submodule2  install

User · Answer

there is now  from 1 1 1 version  a  skip  flag in pit   So you can do things like         lt profile gt           lt id gt pit lt  id gt           lt build gt               lt plugins gt                   lt plugin gt                       lt groupId gt org pitest lt  groupId gt                       lt artifactId gt pitest-maven lt  artifactId gt                       lt configuration gt                           lt skip gt true lt  skip gt                       lt  configuration gt                   lt  plugin gt               lt  plugins gt           lt  build gt       lt  profile gt    in your module  and pit will skip   INFO  --- pitest-maven 1 1 3 mutationCoverage  default-cli    module-selenium ---  INFO  Skipping project

User · Answer

It s possible to decide which reactor projects to build by specifying the -pl command line argument     mvn --help        -pl --projects  lt arg gt                    Build specified reactor projects                                         instead of all projects         It accepts a comma separated list of parameters in one of the following forms    relative path of the folder containing the POM  groupId  artifactId   Thus  given the following structure   project-root  com mycorp parent          --- server  com mycorp server                          --- orm  com mycorp server orm          --- client  com mycorp client    You can specify the following command line   mvn -pl   server  client com mycorp server orm clean install   to build everything  Remove elements in the list to build only the modules you please     EDIT  as blackbuild pointed out  as of Maven 3 2 1 you have a new -el flag that excludes projects from the reactor  similarly to what  -pl does

User · Answer

The notion of multi-module projects is there to service the needs of codependent segments of a project   Such a client depends on the services which in turn depends on say EJBs or data-access routines   You could group your continuous integration  CI  tests in this manner   I would rationalize that by saying that the CI tests need to be in lock-step with application logic changes   Suppose your project is structured as   project-root         --- ci         --- client         --- server   The project-root pom xml defines modules   lt modules gt     lt module gt ci lt  module gt     lt module gt client lt  module gt     lt module gt server lt  module gt   lt  modules gt    The ci pom xml defines profiles such as         lt profiles gt     lt profile gt       lt id gt default lt  id gt       lt activation gt         lt activeByDefault gt true lt  activeByDefault gt       lt  activation gt       lt plugin gt          lt artifactId gt maven-surefire-plugin lt  artifactId gt          lt configuration gt            lt skip gt true lt  skip gt          lt  configuration gt        lt  plugin gt     lt  profile gt     lt profile gt       lt id gt CI lt  id gt       lt plugin gt          lt artifactId gt maven-surefire-plugin lt  artifactId gt          lt configuration gt            lt skip gt false lt  skip gt          lt  configuration gt        lt  plugin gt     lt  profile gt   lt  profiles gt    This will result in Maven skipping tests in this module except when the profile named CI is active  Your CI server must be instructed to execute mvn clean package -P CI   The Maven web site has an in-depth explanation of the profiling mechanism

User · Answer

Sure  this can be done using profiles   You can do something like the following in your parent pom xml             lt modules gt         lt module gt module1 lt  module gt         lt module gt module2 lt  module gt                 lt  modules gt           lt profiles gt        lt profile gt          lt id gt ci lt  id gt             lt modules gt               lt module gt module1 lt  module gt               lt module gt module2 lt  module gt                               lt module gt module-integration-test lt  module gt             lt  modules gt          lt  profile gt     lt  profiles gt         In your CI  you would run maven with the ci profile  i e  mvn -P ci clean install

[maven] Skip a submodule during a Maven build

Examples related to maven

Examples related to continuous-integration

Examples related to jenkins