Maven 2 & 3

Document how parent-child POM relationships, <modules/>, and <parent><relativePath/> works

Details

  • Complexity:
    Intermediate
  • Number of attachments :
    0

Description

Create a document that will describe how POMs can be related to one another in a multimodule build. Specifically, document:

  • The parent-child relationship - how is this manifest in the POMs
  • How does the <modules/> section work
  • How does the <relativePath/> element of the <parent/> section work...and what is required in the <parent/> section?
  • How to install ONLY the parent POM for a multimodule setup (mvn -N pom.xml at the top level)
  • How to build an entire multimodule setup from one command (tie all of this together into a working example)

Related to this, but in another document, should be a list of things that are inherited (could be a link to somewhere else, if this documentation exists in other places). Also, the algorithm used to merge inherited and local POM sections should be in this other document.

Issue Links

depends upon

Improvement - An improvement or enhancement to an existing feature or task. MNG-4687 Maven should not warn about incorrect parent path when no relativePath is specified

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Open - The issue is open and ready for the assignee to start work on it.
is related to

Task - A task that needs to be done. MNG-1141 document <relativePath /> tag, and where we plan to go with USD and workspace definitions

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Hide
Permalink
Stan Devitt added a comment -

1. Parents capture shared configurations. This role should not be confused with aggregation.
2. In the absence of <relativePath/> it is not safe to assume the pom in the parent directory is the parent pom. It might be an aggregation pom.
3. It is very useful to gain access to the parent solely through the repository.

Show
Stan Devitt added a comment - 1. Parents capture shared configurations. This role should not be confused with aggregation. 2. In the absence of <relativePath/> it is not safe to assume the pom in the parent directory is the parent pom. It might be an aggregation pom. 3. It is very useful to gain access to the parent solely through the repository.

People

  • Assignee:
    Unassigned
    Reporter:
    John Casey
Vote (4)
Watch (4)

Dates

  • Created:
    Updated: