12

Questions like this haven been asked over and over but somehow they just focus on dependencies. So according to the maven documentation the build order is determined as follows.

  • a project dependency on another module in the build
  • a plugin declaration where the plugin is another modules in the build
  • a plugin dependency on another module in the build
  • a build extension declaration on another module in the build
  • the order declared in the <modules> element (if no other rule applies)

The first rule is quit clear e.g. if module A is dependent on module B the latter is build first.

The fifth rule (last) is quite clear as well. If the former three rules do not apply we look at the order in the module section.

The other two rules are not that clear to me. English is not my native language but I'm wondering if rule two contains a typo of some sort.

I'm looking for a simple example that explains these two rules in some detail.

pjanssen
  • 1,065
  • 13
  • 35
  • Best would be to show the project as example (may be on github) so it is easier to take a look into it... – khmarbaise Oct 07 '16 at 08:57
  • Couldn't you "solve" your problem by declaring a dependency from A to C? – J Fabian Meier Oct 07 '16 at 09:44
  • Actually, I'm not interested in the solution to that specific problem. So I edited the question to remove that. I'm really wondering how these sorting rules work. – pjanssen Oct 07 '16 at 10:19

1 Answers1

14

Let's go through them one by one.

  • a project dependency on another module in the build

This means that if a module A has a dependency on a module B, then B must be built before A. This handles the case where, in the POM of A, you'd have:

<dependencies>
  <dependency>
    <groupId>${project.groupId}</groupId>
    <artifactId>B</artifactId>
    <version>${project.version}</version>
  </dependency>
</dependencies>
  • a plugin declaration where the plugin is another modules in the build

This means that if a module A uses a Maven plugin which is a module B, then B must be built before A. This handles the case where, in the POM of A, you'd have:

<build>
  <plugins>
    <plugin>
      <groupId>${project.groupId}</groupId>
      <artifactId>B</artifactId>
      <version>${project.version}</version>
    </plugin>
  </plugins>
</build>
  • a plugin dependency on another module in the build

This means that if a module A uses a Maven plugin that has a dependency on a module B, then B must be built before A. This handles the case where, in the POM of A, you'd have:

<build>
  <plugins>
    <plugin>
      <groupId>some.plugin.groupId</groupId>
      <artifactId>some.plugin.artifactId</artifactId>
      <version>some.version</version>
      <dependencies>
        <dependency>
          <groupId>${project.groupId}</groupId>
          <artifactId>B</artifactId>
          <version>${project.version}</version>
        </dependency>
      </dependencies>
    </plugin>
  </plugins>
</build>

Note that this rule is applied after the last one, so even if the plugin itself is also a module of the build, it will be built before, making sure it is safe to resolve the dependencies.

  • a build extension declaration on another module in the build

This means that if a module A declares to use as extention a module B, then B must be built before A. This handles the case where, in the POM of A, you'd have:

<build>
  <extensions>
    <extension>
      <groupId>${project.groupId}</groupId>
      <artifactId>B</artifactId>
      <version>${project.version}</version>
    </extension>
  </extensions>
</build>
  • the order declared in the <modules> element (if no other rule applies)

When none of the previous rules were applied, the order is the order of the <modules>, which would look like in the POM of the aggregator project:

<modules>
  <module>A</module>
  <module>B</module>
</modules>

A would be built before B if none of the previous rules applied.

Michi-2142
  • 1,170
  • 3
  • 18
  • 39
Tunaki
  • 132,869
  • 46
  • 340
  • 423
  • Thank you so much for this clear answer. You should consider make these into examples for the new documentation thing... – pjanssen Oct 07 '16 at 12:06