[DOXIASITETOOLS-348] Extend site descriptor to enforce a parent

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.0.0-M19
• Fix Version/s: 2.0.0
• Component/s: Site model
• Assignee: Konrad Windszus
• Reporter: Konrad Windszus
• Created: 17/Sep/24 08:00
• Updated: 06/Oct/24 18:31
• Resolved: 24/Sep/24 18:29

Description

Currently the site descriptor does not allow to enforce a parent site.xml.
The attribute combine.self does not lead to a failure in case no parent site.xml can be found.

This may easily lead to broken sites without breaking the site build as
a) the site transparently inherits the site.xml attached to the parent POM.
b) attaching the site.xml to a project is a manual step (https://maven.apache.org/plugins/maven-site-plugin/attach-descriptor-mojo.html)

As at the time when the descriptor of the derived site.xml is created it is known whether the descriptor works standalone or requires a parent site.xml, therefore this should be made explicit in the site descriptor.
I propose to add an additional attribute requireParent on the top level element which is false by default (current behaviour). If set to true it should lead to a build failure in case the parent site.xml cannot be resolved (for whatever reason).

Issue Links

• relates to: MPOM-480 Remove maven-site-plugin:attach-descriptor from ASF parent
• links to: GitHub Pull Request #173