[jira] [Updated] (DOXIASITETOOLS-348) Extend site descriptor to enforce a parent

["Konrad Windszus (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/DOXIASITETOOLS-348?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Konrad Windszus updated DOXIASITETOOLS-348:
-------------------------------------------
    Description: 
Currently the [site descriptor|https://maven.apache.org/doxia/doxia-sitetools/doxia-site-model/site.html] 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).

  was:
Currently the [site descriptor|https://maven.apache.org/doxia/doxia-sitetools/doxia-site-model/site.html] 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 it
a) 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 should be explicitly noted in it whether the descriptor works standalone or requires a parent {{site.xml}}

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).


> Extend site descriptor to enforce a parent
> ------------------------------------------
>
>                 Key: DOXIASITETOOLS-348
>                 URL: https://issues.apache.org/jira/browse/DOXIASITETOOLS-348
>             Project: Maven Doxia Sitetools
>          Issue Type: Improvement
>          Components: Site model
>    Affects Versions: 2.0.0-M19
>            Reporter: Konrad Windszus
>            Priority: Major
>
> Currently the [site descriptor|https://maven.apache.org/doxia/doxia-sitetools/doxia-site-model/site.html] 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).



--
This message was sent by Atlassian Jira
(v8.20.10#820010)