-
Notifications
You must be signed in to change notification settings - Fork 23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MPOM-260 configure javadoc for reproducible builds #31
MPOM-260 configure javadoc for reproducible builds #31
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is incomplete:
- Version not set in reporting
- Configuration missing in
<build />
Under which circumstances would I need to configure in |
Interesting, this never worked for me...I need to check. |
Also the comments in https://issues.apache.org/jira/browse/MSITE-443 are highly confusing. So are versions from pluginManagement taken into account for reporting plugins or not? |
I have just tried this on my own projects with MJAVADOC removed from plugin management:
as well as
Do you see the difference? The first one is not quiet, it ignores reporting configuration. Maybe @hboutemy can clarify. |
Ok, so basically the documentation at https://maven.apache.org/guides/mini/guide-configuring-plugins.html#using-the-reporting-tag-vs-build-tag is just plain wrong and reporting plugin configuration is not taken into account for reporting mojos called directly? How do you then configure javadoc correctly then? Duplicate the configuration? |
@kwin I found with this over the years, but never found the time to dive deep into this. It also does not make sense. Plugin config should not depend on reporting. If at all, it should be the other way around. Have a look how I do it in my POM: https://search.maven.org/artifact/net.sf.michael-o/michael-o-parent/14/pom Sometimes the docs, unfortunately, represent the to be situation, not as-is. |
7d84c30
to
12f42b4
Compare
12f42b4
to
a3e6d37
Compare
this PR mixes many many different things:
all in all, in this PR, I would only keep the timestamp removal in plugin configuration (and not advertise it as "configure javadoc for reproducible builds", because it's only a little part of what is needed for that) |
Please explain.
Likely, but this will at least spare wasteful commits to scmpubsub.
It causes fuzz as you can see. What is your concrete recommendatoin.
I ran reword the issue title. Would you keep the Javadoc version or rather remove it? |
On that page, I could not find hints, also the link https://maven.apache.org/plugins/maven-site-plugin/maven-3.html is dead on that page. The only references towards build plugin/reference plugin configuration is
There is also the related bug report about Maven not behaving as documented: https://issues.apache.org/jira/browse/MNG-7006. |
@michael-o I proposed PR #34 for the way I see MPOM-260 to be solved: review welcome before I merge to master @kwin thanks for the pointers to many locations in the site that should be updated/enhanced: I did much work on this in the past, but I missed some FYI, I finally remembered where I wrote the reference documentation of how reporting management evolves over time: it's in reporting-exec, given it's where the direct evolution was coded https://maven.apache.org/shared/maven-reporting-exec/ And I did not fight against removing maven-3.html page from 3.9.1 in apache/maven-site-plugin#20 , because I knew this page was too complex (and I can't fight against every time people try to do cleanup, even if I'm convinced that I'll be hit like here...), but this is where in the past evolution was described in detail: https://maven.apache.org/plugins-archives/maven-site-plugin-3.9.0/maven-3.html I moved MNG-7006 to https://issues.apache.org/jira/browse/MNGSITE-440 because that's a better Jira project: let's track in this Jira issue the documentation improvement |
@hboutemy Thanks for the comments, but even https://maven.apache.org/shared/maven-reporting-exec/ only talks about inheriting versions(!) but not configuration in general. |
@kwin it is mentioned
but I agree that you need to read with attention perhaps just inverting the 2 topics ("since 1.4" and "since 1.2") could probably be an easy way to disambiguate: WDYT? |
@hboutemy Indeed, I have overlooked it. Reversing the order will definitely help. An additional sentence on how this is merged with configuration in reporting->plugins would be valuable as well. Does it work the same as merging of build->pluginMgmt with build->plugins? |
@kwin here is a proposed update https://maven.apache.org/shared-archives/maven-reporting-exec-LATEST/
yes: I'm happy that you immediately guessed the intent :) |
Looks much better, but I would still add an explicit sentence about merging
is a bit too vague for me. |
ok, fair: any proposal? |
It would be good to explain the relation to https://maven.apache.org/ref/3.6.3/maven-model-builder/, especially the role of https://maven.apache.org/ref/3.6.3/maven-model-builder/apidocs/org/apache/maven/model/plugin/ReportConfigurationExpander.html |
No description provided.