[jira] [Commented] (MSITE-1006) MSITE-723 causes duplicate document rendering and log output
[ https://issues.apache.org/jira/browse/MSITE-1006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17843472#comment-17843472 ] ASF GitHub Bot commented on MSITE-1006: --- asfgit merged PR #183: URL: https://github.com/apache/maven-site-plugin/pull/183 > MSITE-723 causes duplicate document rendering and log output > > > Key: MSITE-1006 > URL: https://issues.apache.org/jira/browse/MSITE-1006 > Project: Maven Site Plugin > Issue Type: Bug > Components: doxia integration >Affects Versions: 4.0.0-M13 >Reporter: Michael Osipov >Assignee: Michael Osipov >Priority: Major > Fix For: 4.0.0, 4.0.0-M14 > > > Consider the following output: > {noformat} > ... > [INFO] --- maven-site-plugin:3.12.1:site (default-site) @ doxia-skin-model --- > [INFO] configuring report plugin > org.apache.maven.plugins:maven-project-info-reports-plugin:3.4.5 > [INFO] 15 reports configured for maven-project-info-reports-plugin:3.4.5: > index, summary, dependency-info, modules, team, scm, issue-management, > mailing-lists, dependency-management, dependencies, dependency-convergence, > ci-management, plugin-management, plugins, distribution-management > [INFO] Rendering site with default locale English (en) > [INFO] Relativizing decoration links with respect to localized project URL: > https://maven.apache.org/doxia/doxia-sitetools/doxia-skin-model/ > [INFO] Rendering content with > org.apache.maven.skins:maven-fluido-skin:jar:1.11.2 skin. > [INFO] Skipped "About" report > (maven-project-info-reports-plugin:3.4.5:index), file "index.html" already > exists. > [INFO] Rendering 2 Doxia documents: 1 apt, 1 xdoc > [INFO] Generating "Summary" report --- > maven-project-info-reports-plugin:3.4.5:summary > [INFO] Generating "Dependency Information" report --- > maven-project-info-reports-plugin:3.4.5:dependency-info > [INFO] Generating "Team" report --- > maven-project-info-reports-plugin:3.4.5:team > [INFO] Generating "Source Code Management" report --- > maven-project-info-reports-plugin:3.4.5:scm > [INFO] Generating "Issue Management" report --- > maven-project-info-reports-plugin:3.4.5:issue-management > [INFO] Generating "Mailing Lists" report--- > maven-project-info-reports-plugin:3.4.5:mailing-lists > [INFO] Generating "Dependency Management" report --- > maven-project-info-reports-plugin:3.4.5:dependency-management > [INFO] Generating "Dependencies" report --- > maven-project-info-reports-plugin:3.4.5:dependencies > [INFO] Generating "Dependency Convergence" report --- > maven-project-info-reports-plugin:3.4.5:dependency-convergence > [INFO] Generating "CI Management" report--- > maven-project-info-reports-plugin:3.4.5:ci-management > [INFO] Generating "Plugin Management" report--- > maven-project-info-reports-plugin:3.4.5:plugin-management > [INFO] Generating "Plugins" report --- > maven-project-info-reports-plugin:3.4.5:plugins > [INFO] Generating "Distribution Management" report --- > maven-project-info-reports-plugin:3.4.5:distribution-management > [INFO] Rendering 1 generated Doxia document: 1 xdoc > ... > {noformat} > Let's locate these two handwritten documents: > {noformat} > ~/var/Projekte/maven-doxia-sitetools (master =) > $ tree doxia-skin-model/src/site/ > doxia-skin-model/src/site/ > ├── apt > │ └── index.apt > └── site.xml > 2 directories, 2 files > {noformat} > There aren't. This is caused by MSITE-723 which add generated documents for > the first round of rendering (non-editable ones), then does the rendering, > does reports and then allows generated documents to overwrite report output > by running generated rendering again. > This is suboptimal since it causes: > * Duplicate rendering > * Deceiving log output > * Maven Fluido Skin generates an "Edit Button" for such content sind the > editable flag is set to true: > view-source:https://maven.apache.org/doxia/doxia-sitetools-archives/doxia-sitetools-2.0.0-M16/doxia-skin-model/skin.html > The solution to the problem is to flag the document renderer for such output > with Sitetools to allow unconditional overwrite. We need to fix Doxia > Sitetools first and then we can fix in this plugin. > Block in question: > https://github.com/apache/maven-site-plugin/blob/036997f9a70b7394d9a9771ede04a686aca834e1/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java#L123-L167 > This needs to be {{true}}: > https://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/xref/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.html#L61 -- This message was sent by Atlassian Jira (v8.20.10#820010)
[jira] [Commented] (MSITE-1006) MSITE-723 causes duplicate document rendering and log output
[ https://issues.apache.org/jira/browse/MSITE-1006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17843471#comment-17843471 ] ASF GitHub Bot commented on MSITE-1006: --- asfgit closed pull request #183: [MSITE-1006] MSITE-723 causes duplicate document rendering and log ou… URL: https://github.com/apache/maven-site-plugin/pull/183 > MSITE-723 causes duplicate document rendering and log output > > > Key: MSITE-1006 > URL: https://issues.apache.org/jira/browse/MSITE-1006 > Project: Maven Site Plugin > Issue Type: Bug > Components: doxia integration >Affects Versions: 4.0.0-M13 >Reporter: Michael Osipov >Assignee: Michael Osipov >Priority: Major > Fix For: 4.0.0, 4.0.0-M14 > > > Consider the following output: > {noformat} > ... > [INFO] --- maven-site-plugin:3.12.1:site (default-site) @ doxia-skin-model --- > [INFO] configuring report plugin > org.apache.maven.plugins:maven-project-info-reports-plugin:3.4.5 > [INFO] 15 reports configured for maven-project-info-reports-plugin:3.4.5: > index, summary, dependency-info, modules, team, scm, issue-management, > mailing-lists, dependency-management, dependencies, dependency-convergence, > ci-management, plugin-management, plugins, distribution-management > [INFO] Rendering site with default locale English (en) > [INFO] Relativizing decoration links with respect to localized project URL: > https://maven.apache.org/doxia/doxia-sitetools/doxia-skin-model/ > [INFO] Rendering content with > org.apache.maven.skins:maven-fluido-skin:jar:1.11.2 skin. > [INFO] Skipped "About" report > (maven-project-info-reports-plugin:3.4.5:index), file "index.html" already > exists. > [INFO] Rendering 2 Doxia documents: 1 apt, 1 xdoc > [INFO] Generating "Summary" report --- > maven-project-info-reports-plugin:3.4.5:summary > [INFO] Generating "Dependency Information" report --- > maven-project-info-reports-plugin:3.4.5:dependency-info > [INFO] Generating "Team" report --- > maven-project-info-reports-plugin:3.4.5:team > [INFO] Generating "Source Code Management" report --- > maven-project-info-reports-plugin:3.4.5:scm > [INFO] Generating "Issue Management" report --- > maven-project-info-reports-plugin:3.4.5:issue-management > [INFO] Generating "Mailing Lists" report--- > maven-project-info-reports-plugin:3.4.5:mailing-lists > [INFO] Generating "Dependency Management" report --- > maven-project-info-reports-plugin:3.4.5:dependency-management > [INFO] Generating "Dependencies" report --- > maven-project-info-reports-plugin:3.4.5:dependencies > [INFO] Generating "Dependency Convergence" report --- > maven-project-info-reports-plugin:3.4.5:dependency-convergence > [INFO] Generating "CI Management" report--- > maven-project-info-reports-plugin:3.4.5:ci-management > [INFO] Generating "Plugin Management" report--- > maven-project-info-reports-plugin:3.4.5:plugin-management > [INFO] Generating "Plugins" report --- > maven-project-info-reports-plugin:3.4.5:plugins > [INFO] Generating "Distribution Management" report --- > maven-project-info-reports-plugin:3.4.5:distribution-management > [INFO] Rendering 1 generated Doxia document: 1 xdoc > ... > {noformat} > Let's locate these two handwritten documents: > {noformat} > ~/var/Projekte/maven-doxia-sitetools (master =) > $ tree doxia-skin-model/src/site/ > doxia-skin-model/src/site/ > ├── apt > │ └── index.apt > └── site.xml > 2 directories, 2 files > {noformat} > There aren't. This is caused by MSITE-723 which add generated documents for > the first round of rendering (non-editable ones), then does the rendering, > does reports and then allows generated documents to overwrite report output > by running generated rendering again. > This is suboptimal since it causes: > * Duplicate rendering > * Deceiving log output > * Maven Fluido Skin generates an "Edit Button" for such content sind the > editable flag is set to true: > view-source:https://maven.apache.org/doxia/doxia-sitetools-archives/doxia-sitetools-2.0.0-M16/doxia-skin-model/skin.html > The solution to the problem is to flag the document renderer for such output > with Sitetools to allow unconditional overwrite. We need to fix Doxia > Sitetools first and then we can fix in this plugin. > Block in question: > https://github.com/apache/maven-site-plugin/blob/036997f9a70b7394d9a9771ede04a686aca834e1/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java#L123-L167 > This needs to be {{true}}: > https://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/xref/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.html#L61 -- This message was sent by Atlassian Jira (v8.20.10#820010)
[jira] [Commented] (MSITE-1006) MSITE-723 causes duplicate document rendering and log output
[ https://issues.apache.org/jira/browse/MSITE-1006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17843140#comment-17843140 ] ASF GitHub Bot commented on MSITE-1006: --- michael-o commented on PR #183: URL: https://github.com/apache/maven-site-plugin/pull/183#issuecomment-2092418124 If I don't get any objections will merge this until end of week. > MSITE-723 causes duplicate document rendering and log output > > > Key: MSITE-1006 > URL: https://issues.apache.org/jira/browse/MSITE-1006 > Project: Maven Site Plugin > Issue Type: Bug > Components: doxia integration >Affects Versions: 4.0.0-M13 >Reporter: Michael Osipov >Assignee: Michael Osipov >Priority: Major > Fix For: 4.0.0, 4.0.0-M14 > > > Consider the following output: > {noformat} > ... > [INFO] --- maven-site-plugin:3.12.1:site (default-site) @ doxia-skin-model --- > [INFO] configuring report plugin > org.apache.maven.plugins:maven-project-info-reports-plugin:3.4.5 > [INFO] 15 reports configured for maven-project-info-reports-plugin:3.4.5: > index, summary, dependency-info, modules, team, scm, issue-management, > mailing-lists, dependency-management, dependencies, dependency-convergence, > ci-management, plugin-management, plugins, distribution-management > [INFO] Rendering site with default locale English (en) > [INFO] Relativizing decoration links with respect to localized project URL: > https://maven.apache.org/doxia/doxia-sitetools/doxia-skin-model/ > [INFO] Rendering content with > org.apache.maven.skins:maven-fluido-skin:jar:1.11.2 skin. > [INFO] Skipped "About" report > (maven-project-info-reports-plugin:3.4.5:index), file "index.html" already > exists. > [INFO] Rendering 2 Doxia documents: 1 apt, 1 xdoc > [INFO] Generating "Summary" report --- > maven-project-info-reports-plugin:3.4.5:summary > [INFO] Generating "Dependency Information" report --- > maven-project-info-reports-plugin:3.4.5:dependency-info > [INFO] Generating "Team" report --- > maven-project-info-reports-plugin:3.4.5:team > [INFO] Generating "Source Code Management" report --- > maven-project-info-reports-plugin:3.4.5:scm > [INFO] Generating "Issue Management" report --- > maven-project-info-reports-plugin:3.4.5:issue-management > [INFO] Generating "Mailing Lists" report--- > maven-project-info-reports-plugin:3.4.5:mailing-lists > [INFO] Generating "Dependency Management" report --- > maven-project-info-reports-plugin:3.4.5:dependency-management > [INFO] Generating "Dependencies" report --- > maven-project-info-reports-plugin:3.4.5:dependencies > [INFO] Generating "Dependency Convergence" report --- > maven-project-info-reports-plugin:3.4.5:dependency-convergence > [INFO] Generating "CI Management" report--- > maven-project-info-reports-plugin:3.4.5:ci-management > [INFO] Generating "Plugin Management" report--- > maven-project-info-reports-plugin:3.4.5:plugin-management > [INFO] Generating "Plugins" report --- > maven-project-info-reports-plugin:3.4.5:plugins > [INFO] Generating "Distribution Management" report --- > maven-project-info-reports-plugin:3.4.5:distribution-management > [INFO] Rendering 1 generated Doxia document: 1 xdoc > ... > {noformat} > Let's locate these two handwritten documents: > {noformat} > ~/var/Projekte/maven-doxia-sitetools (master =) > $ tree doxia-skin-model/src/site/ > doxia-skin-model/src/site/ > ├── apt > │ └── index.apt > └── site.xml > 2 directories, 2 files > {noformat} > There aren't. This is caused by MSITE-723 which add generated documents for > the first round of rendering (non-editable ones), then does the rendering, > does reports and then allows generated documents to overwrite report output > by running generated rendering again. > This is suboptimal since it causes: > * Duplicate rendering > * Deceiving log output > * Maven Fluido Skin generates an "Edit Button" for such content sind the > editable flag is set to true: > view-source:https://maven.apache.org/doxia/doxia-sitetools-archives/doxia-sitetools-2.0.0-M16/doxia-skin-model/skin.html > The solution to the problem is to flag the document renderer for such output > with Sitetools to allow unconditional overwrite. We need to fix Doxia > Sitetools first and then we can fix in this plugin. > Block in question: > https://github.com/apache/maven-site-plugin/blob/036997f9a70b7394d9a9771ede04a686aca834e1/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java#L123-L167 > This needs to be {{true}}: > https://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/xref/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.html#L61 -- This message was sent by Atlassian Jira (v8.20.10#820010)
[jira] [Commented] (MSITE-1006) MSITE-723 causes duplicate document rendering and log output
[ https://issues.apache.org/jira/browse/MSITE-1006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17839071#comment-17839071 ] ASF GitHub Bot commented on MSITE-1006: --- michael-o opened a new pull request, #183: URL: https://github.com/apache/maven-site-plugin/pull/183 …tput Following this checklist to help us incorporate your contribution quickly and easily: - [ ] Make sure there is a [JIRA issue](https://issues.apache.org/jira/browse/MSITE) filed for the change (usually before you start working on it). Trivial changes like typos do not require a JIRA issue. Your pull request should address just this issue, without pulling in other changes. - [ ] Each commit in the pull request should have a meaningful subject line and body. - [ ] Format the pull request title like `[MSITE-XXX] - Fixes bug in ApproximateQuantiles`, where you replace `MSITE-XXX` with the appropriate JIRA issue. Best practice is to use the JIRA issue title in the pull request title and in the first line of the commit message. - [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why. - [ ] Run `mvn clean verify` to make sure basic checks pass. A more thorough check will be performed on your pull request automatically. - [ ] You have run the integration tests successfully (`mvn -Prun-its clean verify`). If your pull request is about ~20 lines of code you don't need to sign an [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure please ask on the developers list. To make clear that you license your contribution under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0) you have to acknowledge this by using the following check-box. - [ ] I hereby declare this contribution to be licenced under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0) - [ ] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf). > MSITE-723 causes duplicate document rendering and log output > > > Key: MSITE-1006 > URL: https://issues.apache.org/jira/browse/MSITE-1006 > Project: Maven Site Plugin > Issue Type: Bug > Components: doxia integration >Affects Versions: 4.0.0-M13 >Reporter: Michael Osipov >Assignee: Michael Osipov >Priority: Major > Fix For: 4.0.0, 4.0.0-M14 > > > Consider the following output: > {noformat} > ... > [INFO] --- maven-site-plugin:3.12.1:site (default-site) @ doxia-skin-model --- > [INFO] configuring report plugin > org.apache.maven.plugins:maven-project-info-reports-plugin:3.4.5 > [INFO] 15 reports configured for maven-project-info-reports-plugin:3.4.5: > index, summary, dependency-info, modules, team, scm, issue-management, > mailing-lists, dependency-management, dependencies, dependency-convergence, > ci-management, plugin-management, plugins, distribution-management > [INFO] Rendering site with default locale English (en) > [INFO] Relativizing decoration links with respect to localized project URL: > https://maven.apache.org/doxia/doxia-sitetools/doxia-skin-model/ > [INFO] Rendering content with > org.apache.maven.skins:maven-fluido-skin:jar:1.11.2 skin. > [INFO] Skipped "About" report > (maven-project-info-reports-plugin:3.4.5:index), file "index.html" already > exists. > [INFO] Rendering 2 Doxia documents: 1 apt, 1 xdoc > [INFO] Generating "Summary" report --- > maven-project-info-reports-plugin:3.4.5:summary > [INFO] Generating "Dependency Information" report --- > maven-project-info-reports-plugin:3.4.5:dependency-info > [INFO] Generating "Team" report --- > maven-project-info-reports-plugin:3.4.5:team > [INFO] Generating "Source Code Management" report --- > maven-project-info-reports-plugin:3.4.5:scm > [INFO] Generating "Issue Management" report --- > maven-project-info-reports-plugin:3.4.5:issue-management > [INFO] Generating "Mailing Lists" report--- > maven-project-info-reports-plugin:3.4.5:mailing-lists > [INFO] Generating "Dependency Management" report --- > maven-project-info-reports-plugin:3.4.5:dependency-management > [INFO] Generating "Dependencies" report --- > maven-project-info-reports-plugin:3.4.5:dependencies > [INFO] Generating "Dependency Convergence" report --- > maven-project-info-reports-plugin:3.4.5:dependency-convergence > [INFO] Generating "CI Management" report--- > maven-project-info-reports-plugin:3.4.5:ci-management > [INFO] Generating "Plugin Management"
[jira] [Commented] (MSITE-1006) MSITE-723 causes duplicate document rendering and log output
[ https://issues.apache.org/jira/browse/MSITE-1006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17838193#comment-17838193 ] Michael Osipov commented on MSITE-1006: --- Don't confuse reports with generated documents. There is no issue with reports vs. documents, but solely generated documents. Currently they override reports and editable documents, but that his implemented ugly. > MSITE-723 causes duplicate document rendering and log output > > > Key: MSITE-1006 > URL: https://issues.apache.org/jira/browse/MSITE-1006 > Project: Maven Site Plugin > Issue Type: Bug > Components: doxia integration >Affects Versions: 4.0.0-M13 >Reporter: Michael Osipov >Assignee: Michael Osipov >Priority: Major > Fix For: 4.0.0, 4.0.0-M14 > > > Consider the following output: > {noformat} > ... > [INFO] --- maven-site-plugin:3.12.1:site (default-site) @ doxia-skin-model --- > [INFO] configuring report plugin > org.apache.maven.plugins:maven-project-info-reports-plugin:3.4.5 > [INFO] 15 reports configured for maven-project-info-reports-plugin:3.4.5: > index, summary, dependency-info, modules, team, scm, issue-management, > mailing-lists, dependency-management, dependencies, dependency-convergence, > ci-management, plugin-management, plugins, distribution-management > [INFO] Rendering site with default locale English (en) > [INFO] Relativizing decoration links with respect to localized project URL: > https://maven.apache.org/doxia/doxia-sitetools/doxia-skin-model/ > [INFO] Rendering content with > org.apache.maven.skins:maven-fluido-skin:jar:1.11.2 skin. > [INFO] Skipped "About" report > (maven-project-info-reports-plugin:3.4.5:index), file "index.html" already > exists. > [INFO] Rendering 2 Doxia documents: 1 apt, 1 xdoc > [INFO] Generating "Summary" report --- > maven-project-info-reports-plugin:3.4.5:summary > [INFO] Generating "Dependency Information" report --- > maven-project-info-reports-plugin:3.4.5:dependency-info > [INFO] Generating "Team" report --- > maven-project-info-reports-plugin:3.4.5:team > [INFO] Generating "Source Code Management" report --- > maven-project-info-reports-plugin:3.4.5:scm > [INFO] Generating "Issue Management" report --- > maven-project-info-reports-plugin:3.4.5:issue-management > [INFO] Generating "Mailing Lists" report--- > maven-project-info-reports-plugin:3.4.5:mailing-lists > [INFO] Generating "Dependency Management" report --- > maven-project-info-reports-plugin:3.4.5:dependency-management > [INFO] Generating "Dependencies" report --- > maven-project-info-reports-plugin:3.4.5:dependencies > [INFO] Generating "Dependency Convergence" report --- > maven-project-info-reports-plugin:3.4.5:dependency-convergence > [INFO] Generating "CI Management" report--- > maven-project-info-reports-plugin:3.4.5:ci-management > [INFO] Generating "Plugin Management" report--- > maven-project-info-reports-plugin:3.4.5:plugin-management > [INFO] Generating "Plugins" report --- > maven-project-info-reports-plugin:3.4.5:plugins > [INFO] Generating "Distribution Management" report --- > maven-project-info-reports-plugin:3.4.5:distribution-management > [INFO] Rendering 1 generated Doxia document: 1 xdoc > ... > {noformat} > Let's locate these two handwritten documents: > {noformat} > ~/var/Projekte/maven-doxia-sitetools (master =) > $ tree doxia-skin-model/src/site/ > doxia-skin-model/src/site/ > ├── apt > │ └── index.apt > └── site.xml > 2 directories, 2 files > {noformat} > There aren't. This is caused by MSITE-723 which add generated documents for > the first round of rendering (non-editable ones), then does the rendering, > does reports and then allows generated documents to overwrite report output > by running generated rendering again. > This is suboptimal since it causes: > * Duplicate rendering > * Deceiving log output > * Maven Fluido Skin generates an "Edit Button" for such content sind the > editable flag is set to true: > view-source:https://maven.apache.org/doxia/doxia-sitetools-archives/doxia-sitetools-2.0.0-M16/doxia-skin-model/skin.html > The solution to the problem is to flag the document renderer for such output > with Sitetools to allow unconditional overwrite. We need to fix Doxia > Sitetools first and then we can fix in this plugin. > Block in question: > https://github.com/apache/maven-site-plugin/blob/036997f9a70b7394d9a9771ede04a686aca834e1/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java#L123-L167 > This needs to be {{true}}: > https://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/xref/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.html#L61 -- This message was sent by Atlassian Jira
[jira] [Commented] (MSITE-1006) MSITE-723 causes duplicate document rendering and log output
[ https://issues.apache.org/jira/browse/MSITE-1006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17838109#comment-17838109 ] Konrad Windszus commented on MSITE-1006: I would expect that those documents which are based on doxia source files (editable) take precedence over same-named (generated) reports (not the other way around). But there should be a WARNING emitted in case a report would emit to a clashing path. > MSITE-723 causes duplicate document rendering and log output > > > Key: MSITE-1006 > URL: https://issues.apache.org/jira/browse/MSITE-1006 > Project: Maven Site Plugin > Issue Type: Bug > Components: doxia integration >Affects Versions: 4.0.0-M13 >Reporter: Michael Osipov >Assignee: Michael Osipov >Priority: Major > Fix For: 4.0.0, 4.0.0-M14 > > > Consider the following output: > {noformat} > ... > [INFO] --- maven-site-plugin:3.12.1:site (default-site) @ doxia-skin-model --- > [INFO] configuring report plugin > org.apache.maven.plugins:maven-project-info-reports-plugin:3.4.5 > [INFO] 15 reports configured for maven-project-info-reports-plugin:3.4.5: > index, summary, dependency-info, modules, team, scm, issue-management, > mailing-lists, dependency-management, dependencies, dependency-convergence, > ci-management, plugin-management, plugins, distribution-management > [INFO] Rendering site with default locale English (en) > [INFO] Relativizing decoration links with respect to localized project URL: > https://maven.apache.org/doxia/doxia-sitetools/doxia-skin-model/ > [INFO] Rendering content with > org.apache.maven.skins:maven-fluido-skin:jar:1.11.2 skin. > [INFO] Skipped "About" report > (maven-project-info-reports-plugin:3.4.5:index), file "index.html" already > exists. > [INFO] Rendering 2 Doxia documents: 1 apt, 1 xdoc > [INFO] Generating "Summary" report --- > maven-project-info-reports-plugin:3.4.5:summary > [INFO] Generating "Dependency Information" report --- > maven-project-info-reports-plugin:3.4.5:dependency-info > [INFO] Generating "Team" report --- > maven-project-info-reports-plugin:3.4.5:team > [INFO] Generating "Source Code Management" report --- > maven-project-info-reports-plugin:3.4.5:scm > [INFO] Generating "Issue Management" report --- > maven-project-info-reports-plugin:3.4.5:issue-management > [INFO] Generating "Mailing Lists" report--- > maven-project-info-reports-plugin:3.4.5:mailing-lists > [INFO] Generating "Dependency Management" report --- > maven-project-info-reports-plugin:3.4.5:dependency-management > [INFO] Generating "Dependencies" report --- > maven-project-info-reports-plugin:3.4.5:dependencies > [INFO] Generating "Dependency Convergence" report --- > maven-project-info-reports-plugin:3.4.5:dependency-convergence > [INFO] Generating "CI Management" report--- > maven-project-info-reports-plugin:3.4.5:ci-management > [INFO] Generating "Plugin Management" report--- > maven-project-info-reports-plugin:3.4.5:plugin-management > [INFO] Generating "Plugins" report --- > maven-project-info-reports-plugin:3.4.5:plugins > [INFO] Generating "Distribution Management" report --- > maven-project-info-reports-plugin:3.4.5:distribution-management > [INFO] Rendering 1 generated Doxia document: 1 xdoc > ... > {noformat} > Let's locate these two handwritten documents: > {noformat} > ~/var/Projekte/maven-doxia-sitetools (master =) > $ tree doxia-skin-model/src/site/ > doxia-skin-model/src/site/ > ├── apt > │ └── index.apt > └── site.xml > 2 directories, 2 files > {noformat} > There aren't. This is caused by MSITE-723 which add generated documents for > the first round of rendering (non-editable ones), then does the rendering, > does reports and then allows generated documents to overwrite report output > by running generated rendering again. > This is suboptimal since it causes: > * Duplicate rendering > * Deceiving log output > * Maven Fluido Skin generates an "Edit Button" for such content sind the > editable flag is set to true: > view-source:https://maven.apache.org/doxia/doxia-sitetools-archives/doxia-sitetools-2.0.0-M16/doxia-skin-model/skin.html > The solution to the problem is to flag the document renderer for such output > with Sitetools to allow unconditional overwrite. We need to fix Doxia > Sitetools first and then we can fix in this plugin. > Block in question: > https://github.com/apache/maven-site-plugin/blob/036997f9a70b7394d9a9771ede04a686aca834e1/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java#L123-L167 > This needs to be {{true}}: > https://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/xref/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.html#L61 -- This message
[jira] [Commented] (MSITE-1006) MSITE-723 causes duplicate document rendering and log output
[ https://issues.apache.org/jira/browse/MSITE-1006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17838047#comment-17838047 ] Michael Osipov commented on MSITE-1006: --- Some design questions before I implement the fix: * Can we always assume that non-editable documents come last and can overwrite everything from before? * Should this be controlable via parameter? [~kwin], [~hboutemy], opinions? Cheapest solution: {noformat} $ git stash show -p diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java index a436c94..92b4390 100644 --- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java +++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java @@ -58,7 +58,7 @@ public class DoxiaDocumentRenderer implements DocumentRenderer { /** {@inheritDoc} */ public boolean isOverwrite() { -return false; +return !docRenderingContext.isEditable(); } public boolean isExternalReport() { {noformat} > MSITE-723 causes duplicate document rendering and log output > > > Key: MSITE-1006 > URL: https://issues.apache.org/jira/browse/MSITE-1006 > Project: Maven Site Plugin > Issue Type: Bug > Components: doxia integration >Affects Versions: 4.0.0-M13 >Reporter: Michael Osipov >Assignee: Michael Osipov >Priority: Major > Fix For: 4.0.0, 4.0.0-M14 > > > Consider the following output: > {noformat} > ... > [INFO] --- maven-site-plugin:3.12.1:site (default-site) @ doxia-skin-model --- > [INFO] configuring report plugin > org.apache.maven.plugins:maven-project-info-reports-plugin:3.4.5 > [INFO] 15 reports configured for maven-project-info-reports-plugin:3.4.5: > index, summary, dependency-info, modules, team, scm, issue-management, > mailing-lists, dependency-management, dependencies, dependency-convergence, > ci-management, plugin-management, plugins, distribution-management > [INFO] Rendering site with default locale English (en) > [INFO] Relativizing decoration links with respect to localized project URL: > https://maven.apache.org/doxia/doxia-sitetools/doxia-skin-model/ > [INFO] Rendering content with > org.apache.maven.skins:maven-fluido-skin:jar:1.11.2 skin. > [INFO] Skipped "About" report > (maven-project-info-reports-plugin:3.4.5:index), file "index.html" already > exists. > [INFO] Rendering 2 Doxia documents: 1 apt, 1 xdoc > [INFO] Generating "Summary" report --- > maven-project-info-reports-plugin:3.4.5:summary > [INFO] Generating "Dependency Information" report --- > maven-project-info-reports-plugin:3.4.5:dependency-info > [INFO] Generating "Team" report --- > maven-project-info-reports-plugin:3.4.5:team > [INFO] Generating "Source Code Management" report --- > maven-project-info-reports-plugin:3.4.5:scm > [INFO] Generating "Issue Management" report --- > maven-project-info-reports-plugin:3.4.5:issue-management > [INFO] Generating "Mailing Lists" report--- > maven-project-info-reports-plugin:3.4.5:mailing-lists > [INFO] Generating "Dependency Management" report --- > maven-project-info-reports-plugin:3.4.5:dependency-management > [INFO] Generating "Dependencies" report --- > maven-project-info-reports-plugin:3.4.5:dependencies > [INFO] Generating "Dependency Convergence" report --- > maven-project-info-reports-plugin:3.4.5:dependency-convergence > [INFO] Generating "CI Management" report--- > maven-project-info-reports-plugin:3.4.5:ci-management > [INFO] Generating "Plugin Management" report--- > maven-project-info-reports-plugin:3.4.5:plugin-management > [INFO] Generating "Plugins" report --- > maven-project-info-reports-plugin:3.4.5:plugins > [INFO] Generating "Distribution Management" report --- > maven-project-info-reports-plugin:3.4.5:distribution-management > [INFO] Rendering 1 generated Doxia document: 1 xdoc > ... > {noformat} > Let's locate these two handwritten documents: > {noformat} > ~/var/Projekte/maven-doxia-sitetools (master =) > $ tree doxia-skin-model/src/site/ > doxia-skin-model/src/site/ > ├── apt > │ └── index.apt > └── site.xml > 2 directories, 2 files > {noformat} > There aren't. This is caused by MSITE-723 which add generated documents for > the first round of rendering (non-editable ones), then does the rendering, > does reports and then allows generated documents to overwrite report output > by running generated rendering again. > This is suboptimal since it causes: > * Duplicate rendering > * Deceiving log output > * Maven Fluido Skin generates an "Edit Button" for such