[
https://issues.apache.org/jira/browse/DOXIASITETOOLS-348?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17883194#comment-17883194
]
ASF GitHub Bot commented on DOXIASITETOOLS-348:
-----------------------------------------------
kwin commented on PR #173:
URL:
https://github.com/apache/maven-doxia-sitetools/pull/173#issuecomment-2363204708
> we have a conceptual flaw in our design
Yes, but I am trying to fix this without breaking backwards compatibility.
Having an additional parent on the site.xml level would fix this, but in
most cases is highly redundant (and also isn't properly upgraded during
release), so maintaining this on `site.xml` level would lead to a lot of
additional challenges.
Similar an additional dependency on the POM level feels highly redundant,
because this should always reflect the Maven coordinates of the parent. Also
knowledge about classifier (potentially extended with locale) requires
additional knowledge from consumers they shouldn't necessarily know about.
So just having a boolean toggle is IMHO the option with least redundancy and
simplest to understand from a consumer PoV.
> 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
> Assignee: 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)
