Maven 2.x and 3.x Site Plugin

[regression] Site navigation not generated

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Critical Critical
  • Resolution: Fixed
  • Affects Version/s: 2.1
  • Fix Version/s: 2.1.1, 3.0-beta-1
  • Component/s: None
  • Labels:
    None
  • Environment:
  • Number of attachments :
    2

Description

My corporate POM locks down the maven-site-plugin to version 2.1. The site of the corporate POM generates just fine. However, when a child project inherits from it, that project's site contains no left-hand navigation. Reverting to 2.0.1 is my workaround.

Issue Links

depends upon

Bug - A problem which impairs or prevents the functions of the product. MSHARED-144 NPE in DefaultSiteTool.populateParentMenu() under certain conditions

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

Bug - A problem which impairs or prevents the functions of the product. MSHARED-145 The default-site.xml is not used if both parent and child are missing site.xml files

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

Bug - A problem which impairs or prevents the functions of the product. MSITE-486 Site navigation not generated for submodules of multimodule project when site.xml defined in the parent

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

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Paul Benedict added a comment -

Attached project can reproduce problem. First generate parent site and verify it is normal; then install parent. Next, generate child's site and verify missing navigation.

Show
Paul Benedict added a comment - Attached project can reproduce problem. First generate parent site and verify it is normal; then install parent. Next, generate child's site and verify missing navigation.
Hide
Permalink
Dennis Lundberg added a comment -

Confirmed.

Show
Dennis Lundberg added a comment - Confirmed.
Hide
Permalink
Charlie Collins added a comment -

Confirmed also.

Just used the versions plugin on a large number of projects at our corporate location to idenitify plugins that had updates. Showed me that site 2.1 was avail, used it in parent POM, now all projects that inherit parent have no left hand navigation. Reports are still there, etc, but no nav.

Reverting to site 2.0.1 fixes it.

Show
Charlie Collins added a comment - Confirmed also. Just used the versions plugin on a large number of projects at our corporate location to idenitify plugins that had updates. Showed me that site 2.1 was avail, used it in parent POM, now all projects that inherit parent have no left hand navigation. Reports are still there, etc, but no nav. Reverting to site 2.0.1 fixes it.
Hide
Permalink
Paul Grove added a comment -

Same issue here.

Reverting to site 2.0.1 fixes it.

How can such a bug be introduced this is fundamental functionality?

Show
Paul Grove added a comment - Same issue here. Reverting to site 2.0.1 fixes it. How can such a bug be introduced this is fundamental functionality?
Hide
Permalink
Dennis Lundberg added a comment -

I'll give you a couple of reasons:

  • We have too few integration tests
  • Not enough people help to test the plugins during the release process

If you have patches I'll be happy to review them.

Show
Dennis Lundberg added a comment - I'll give you a couple of reasons: We have too few integration tests Not enough people help to test the plugins during the release process If you have patches I'll be happy to review them.
Hide
Permalink
Steven MountJoy added a comment -

Confirming Paul's bug. My inherited set of <reporting> plugins are generating their separate reports as defined but are not being linked in the div "navcolumn" of the generated index.html. I, too, have reverted to 2.0.1 for workaround.

Show
Steven MountJoy added a comment - Confirming Paul's bug. My inherited set of <reporting> plugins are generating their separate reports as defined but are not being linked in the div "navcolumn" of the generated index.html. I, too, have reverted to 2.0.1 for workaround.
Hide
Permalink
Dennis Lundberg added a comment - - edited

Fixed in r919644 and r949865.

A 2.1.1-SNAPSHOT has been deployed. Please test that it solves this issue for you.

Show
Dennis Lundberg added a comment - - edited Fixed in r919644 and r949865 . A 2.1.1-SNAPSHOT has been deployed. Please test that it solves this issue for you.
Hide
Permalink
Mirko Friedenhagen added a comment -

Just as a side note for those reluctant or unable to use snapshots: when you switch back to 2.0.1 of the site plugin you have to go back to an older version of the maven-project-info-reports-plugin (2.1.2) as well.

Show
Mirko Friedenhagen added a comment - Just as a side note for those reluctant or unable to use snapshots: when you switch back to 2.0.1 of the site plugin you have to go back to an older version of the maven-project-info-reports-plugin (2.1.2) as well.
Hide
Permalink
Grzegorz Slowikowski added a comment -

It does not work for me with site 2.1.1 (from https://repository.apache.org/content/repositories/maven-025)

Show
Grzegorz Slowikowski added a comment - It does not work for me with site 2.1.1 (from https://repository.apache.org/content/repositories/maven-025 )
Hide
Permalink
Lukas Theussl added a comment -

Your link does not exist and "it does not work" is hard to diagnose. Please give us a chance and be more specific.

Show
Lukas Theussl added a comment - Your link does not exist and "it does not work" is hard to diagnose. Please give us a chance and be more specific.
Hide
Permalink
Grzegorz Slowikowski added a comment -

I need some time to prepare simple example project. I checked Paul's attachment and I see that my problem is different - site navigation is not generated for child modules of multimodule build. I will create another JIRA error for it when I'll be ready with example project.

Show
Grzegorz Slowikowski added a comment - I need some time to prepare simple example project. I checked Paul's attachment and I see that my problem is different - site navigation is not generated for child modules of multimodule build. I will create another JIRA error for it when I'll be ready with example project.
Hide
Permalink
André Fügenschuh added a comment -

I can confirm Grzegorz Slowikowski's comment that the regression isn't fixed for multi-module projects if a "site.xml" on the parent module is used.

1) Run the attached sample as is with
>mvn site:stage -DstagingDirectory=[someLocation]

and the left navigation bar for the sub-modules is not created.

2) Remove/Rename the "site.xml" and it works.

3) Alternatively re-configure the parent's POM to use v. 2.0.1 and it works fine including the "site.xml".

How to proceed? Re-open this issue or create a new one?

Show
André Fügenschuh added a comment - I can confirm Grzegorz Slowikowski's comment that the regression isn't fixed for multi-module projects if a "site.xml" on the parent module is used. 1) Run the attached sample as is with >mvn site:stage -DstagingDirectory= [someLocation] and the left navigation bar for the sub-modules is not created. 2) Remove/Rename the "site.xml" and it works. 3) Alternatively re-configure the parent's POM to use v. 2.0.1 and it works fine including the "site.xml". How to proceed? Re-open this issue or create a new one?
Hide
Permalink
Paul Benedict added a comment -

My suggestion is to open a new issue and link it to this one.

Show
Paul Benedict added a comment - My suggestion is to open a new issue and link it to this one.
Hide
Permalink
André Fügenschuh added a comment -

Solved!? I think I got it.
Adding an inherit attribute to the menu entries in src/site/site.xml will make it work with v. 2.1.1 again.

2.0.1

  <body>
    <menu ref="parent"/>
    ...

2.1.1

  <body>
    <menu ref="parent" inherit="top"/>
    ...

If this behaviour is not just a side-effect but 'works as designed', an explicit hint in the documentation for the site descriptor usage (for multi-module projects?) is required.

Show
André Fügenschuh added a comment - Solved!? I think I got it. Adding an inherit attribute to the menu entries in src/site/site.xml will make it work with v. 2.1.1 again. which is not documented as such!, see: Site Descriptor . 2.0.1 <body> <menu ref="parent"/> ... 2.1.1 <body> <menu ref="parent" inherit="top"/> ... If this behaviour is not just a side-effect but 'works as designed', an explicit hint in the documentation for the site descriptor usage (for multi-module projects?) is required.
Hide
Permalink
Dennis Lundberg added a comment -

André, did you read the section about inheritance?

Show
Dennis Lundberg added a comment - André, did you read the section about inheritance?
Hide
Permalink
André Fügenschuh added a comment -

Yes, I did.

Cite:

Ineritance
"... By default, only the basic settings are inherited. From the body, only the links are inherited, ..."

Including Generated Content
"... several preset menus ... These are linked via the ref attribute, like so:"
... <menu ref="modules" /> ...

And - as this is a regression issue - the above sample has worked fine up 'til v 2.0.1, even with multi-module projects.
That's why I'm demanding an explicit hint/clarification in the docs.

Show
André Fügenschuh added a comment - Yes, I did. Cite: Ineritance "... By default, only the basic settings are inherited. From the body, only the links are inherited, ..." Including Generated Content "... several preset menus ... These are linked via the ref attribute, like so:" ... <menu ref="modules" /> ... And - as this is a regression issue - the above sample has worked fine up 'til v 2.0.1, even with multi-module projects. That's why I'm demanding an explicit hint/clarification in the docs.
Hide
Permalink
Dennis Lundberg added a comment -

The JIRA-issue that we are all writing to is a regression and it has been fixed. In order to fix this issue we had to make some internal changes that may have affected the behavior of the plugin. Previous versions, i.e. 2.0.1, did not work as intended. It now works as it should.

Your issue seems to be a different one. Please open a new issue in JIRA with a description of what happens and what you feel should be happening, and attach a test-case to it.

Show
Dennis Lundberg added a comment - The JIRA-issue that we are all writing to is a regression and it has been fixed. In order to fix this issue we had to make some internal changes that may have affected the behavior of the plugin. Previous versions, i.e. 2.0.1, did not work as intended. It now works as it should. Your issue seems to be a different one. Please open a new issue in JIRA with a description of what happens and what you feel should be happening, and attach a test-case to it.
Hide
Permalink
Lukas Theussl added a comment -

MSITE-486 has been opened as a follow-up to this issue, please report any new findings there, or open a new issue if you think it's not related and link back to this one.

Show
Lukas Theussl added a comment - MSITE-486 has been opened as a follow-up to this issue, please report any new findings there, or open a new issue if you think it's not related and link back to this one.

People

  • Assignee:
    Dennis Lundberg
    Reporter:
    Paul Benedict
Vote (4)
Watch (8)

Dates

  • Created:
    Updated:
    Resolved: