Maven 2.x Changes Plugin

[regression] Incorrect parsing of the <author> element

Details

  • Type: Bug Bug
  • Status: Reopened Reopened
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: 2.1
  • Fix Version/s: None
  • Component/s: changes.xml, modello
  • Labels:
    None
  • Number of attachments :
    3

Description

I was locking down my Maven Changes Plugin version with the following config:

<reporting>
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-changes-plugin</artifactId>
  <version>2.1</version>
  <reportSets>
    <reportSet>
      <reports>
        <report>changes-report</report>
      </reports>
    </reportSet>
  </reportSets>
  </plugin>
</reporting>

And then I created the site and noticed the report was empty. The report markup was there, of course, but it generated like my changes.xml was blank. I could run changes:changes-report just fine. However, when I then removed the <version> tag and tried site:site again, the report output was present as expected.

Here's an interesting line from the debug output when <version> is specified:

[DEBUG] The following artifacts were filtered out for plugin: org.apache.maven.plugins:maven-changes-plugin:2.1 because they're already in the core of Maven:

My theory is that because my plugin version has an exact match on the version, my specified plugin configuration is tossed. That certainly seems like a bug to me.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Brett Porter added a comment -

where is the report configuration in this POM?

Show
Brett Porter added a comment - where is the report configuration in this POM?
Hide
Permalink
Paul Benedict added a comment -

Isn't the <reportSets> part of the configuration? If I mislabeled this issue, I apologize. So the reportSets get tossed?

Show
Paul Benedict added a comment - Isn't the <reportSets> part of the configuration? If I mislabeled this issue, I apologize. So the reportSets get tossed?
Hide
Permalink
Brett Porter added a comment -

see attached test project where it works just fine

Show
Brett Porter added a comment - see attached test project where it works just fine
Hide
Permalink
Brett Porter added a comment -

this wasn't a direct cut and paste (there is a missing <plugins> element), so there's a chance it was mistyped in your original POM.

If it is correct, I would put this down to a different version of the changes plugin behaving differently based on the existence of src/changes/changes.xml. The report is not generated if that file is missing in 2.1. Maybe it is in a different version that you get with the version removed. Either way, this isn't a Maven issue AFAICT.

Show
Brett Porter added a comment - this wasn't a direct cut and paste (there is a missing <plugins> element), so there's a chance it was mistyped in your original POM. If it is correct, I would put this down to a different version of the changes plugin behaving differently based on the existence of src/changes/changes.xml. The report is not generated if that file is missing in 2.1. Maybe it is in a different version that you get with the version removed. Either way, this isn't a Maven issue AFAICT.
Hide
Permalink
Paul Benedict added a comment -

Brett, I think you misunderstood the issue. The changes.xml file is always present. It's only when I put in the <version> of the plugin that it does not generate in the site goal.

Show
Paul Benedict added a comment - Brett, I think you misunderstood the issue. The changes.xml file is always present. It's only when I put in the <version> of the plugin that it does not generate in the site goal.
Hide
Permalink
Brett Porter added a comment -

that's what I understood, and is consistent with my comment. does the attached sample project work for you?

Show
Brett Porter added a comment - that's what I understood, and is consistent with my comment. does the attached sample project work for you?
Hide
Permalink
Paul Benedict added a comment -

I am reopening this because I can reproduce it. If we can re-determine it is actually a problem with the Changes Plugin, I will move this issue into that project. I will be attaching updated documents in the next comment.

Show
Paul Benedict added a comment - I am reopening this because I can reproduce it. If we can re-determine it is actually a problem with the Changes Plugin, I will move this issue into that project. I will be attaching updated documents in the next comment.
Hide
Permalink
Paul Benedict added a comment - - edited

Attached is the Maven debug output, and an updated changes file.

Note how the report contents are only generated for the explicit changes:changes-report goal, not the site:site goal.

Again, the only reason I think this is not a problem in the plugin is because the <version> tag directly affects the test case. Put the tag in there, the contents will not generate for the site. Without the tag, it will be fine. I don't see how that kind of high-level POM configuration could affect the plugin itself, so my guess it's a "reactor" problem.

Show
Paul Benedict added a comment - - edited Attached is the Maven debug output, and an updated changes file. Note how the report contents are only generated for the explicit changes:changes-report goal, not the site:site goal. Again, the only reason I think this is not a problem in the plugin is because the <version> tag directly affects the test case. Put the tag in there, the contents will not generate for the site. Without the tag, it will be fine. I don't see how that kind of high-level POM configuration could affect the plugin itself, so my guess it's a "reactor" problem.
Hide
Permalink
Brett Porter added a comment -

I'm guessing that when you remove the version, you get v2.0 due to some old metadata in your environment. I misunderstood what you meant by "empty" - the report has no rows, but is still generated. This comes up correctly in 2.0, but not in 2.1

Therefore, it is a regression in the changes plugin for the format of your changes file.

Show
Brett Porter added a comment - I'm guessing that when you remove the version, you get v2.0 due to some old metadata in your environment. I misunderstood what you meant by "empty" - the report has no rows, but is still generated. This comes up correctly in 2.0, but not in 2.1 Therefore, it is a regression in the changes plugin for the format of your changes file.
Hide
Permalink
Dennis Lundberg added a comment -

I can confirm that this is a regression between versions 2.0 and 2.1 of Maven Changes Plugin.

However it has nothing to do with whether you are invoking the report via the "site" phase or if you run the "changes:changes-report". You can use the following commands to verify it:

mvn org.apache.maven.plugins:maven-changes-plugin:2.0:changes-report

mvn org.apache.maven.plugins:maven-changes-plugin:2.1:changes-report

The first one will include the issue in the report, but the second one will not.

Show
Dennis Lundberg added a comment - I can confirm that this is a regression between versions 2.0 and 2.1 of Maven Changes Plugin. However it has nothing to do with whether you are invoking the report via the "site" phase or if you run the "changes:changes-report". You can use the following commands to verify it: mvn org.apache.maven.plugins:maven-changes-plugin:2.0:changes-report mvn org.apache.maven.plugins:maven-changes-plugin:2.1:changes-report The first one will include the issue in the report, but the second one will not.
Hide
Permalink
Dennis Lundberg added a comment -

After some digging I've found the source of the problem. Your sparse, but correct, usage of the author element is parsed incorrectly by the Modello generated parser.

<author email="pbenedict@apache.org"/>

results in this xhtml code:

<meta name="author" content="<author email="pbenedict@apache.org"/>" />

I've tried upgrading to a newer version of Modello, but that results in test failures.

Show
Dennis Lundberg added a comment - After some digging I've found the source of the problem. Your sparse, but correct, usage of the author element is parsed incorrectly by the Modello generated parser. <author email="pbenedict@apache.org"/> results in this xhtml code: <meta name="author" content="<author email="pbenedict@apache.org"/>" /> I've tried upgrading to a newer version of Modello, but that results in test failures.

People

  • Assignee:
    Unassigned
    Reporter:
    Paul Benedict
Vote (1)
Watch (1)

Dates

  • Created:
    Updated: