[MDEP-674] Add IDE build support #257

kwin · 2022-10-28T11:26:29Z

Use BuildContext to notify about newly generated files/folders

Following this checklist to help us incorporate your
contribution quickly and easily:

Make sure there is a JIRA issue 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 [MDEP-XXX] - Fixes bug in ApproximateQuantiles,
where you replace MDEP-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 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
you have to acknowledge this by using the following check-box.

I hereby declare this contribution to be licensed under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.

Use BuildContext to notify about newly generated files/folders

slawekjaranowski

I'm not feel good with such implementation ... yes I know there are no other proposition.

pom.xml

slawekjaranowski · 2022-10-28T13:05:01Z

pom.xml

+    <dependency>
+      <groupId>org.sonatype.plexus</groupId>
+      <artifactId>plexus-build-api</artifactId>
+      <version>0.0.7</version>
+      <scope>compile</scope>
+    </dependency>


unmaintained dependency ...

Not really, it saw a new release at https://github.com/codehaus-plexus/plexus-build-api. The new GAV and packages are just not compatible with m2e yet (eclipse-m2e/m2e-core#944).

Compare also with the discussion at https://lists.apache.org/thread/h2gy5l7j5bv7ycbpwdjby66v8gwhzck2.

slawekjaranowski · 2022-10-28T13:09:19Z

src/main/resources/META-INF/m2e/lifecycle-mapping-metadata.xml

+specific language governing permissions and limitations
+under the License.
+-->
+<lifecycleMappingMetadata>


Specific only for Eclipse ...

could be used by any IDE supporting incremental builds, but currently m2e is the only consumer, right.

Eclipse and its derivative, such as Java edition in VSCode.

is there option to not store such specific IDE file here?
I don't like much this... I would be -1.
we already have a sort of specific API and now specific files.
Imagine if every IDE ask for storing their specific files?
sounds a bad design to me.

Fact is: There is no other metadata defined for any other IDE. Every IDE could reuse this metadata. We already have m2e metadata in other Maven plugins e.g. in https://github.com/apache/maven-resources-plugin/blob/master/src/main/resources/META-INF/m2e/lifecycle-mapping-metadata.xml or in https://github.com/apache/maven-enforcer/tree/master/maven-enforcer-plugin/src/main/resources/META-INF/m2e.

which should have never been accepted....

Imagine if every IDE ask for storing their specific files? sounds a bad design to me.

Indeed that would be bad and was the reason why I/we the M2E team reached out to the Maven devs on their mailing list (the link @kwin posted above) to establish a unified API defined/maintained by Maven that all IDEs could use. Eventually this probably would have lead to a similar Maven-defined/maintained lifecycle-mapping metadata format (which actually also could be generated from annotations see e.g. eclipse-m2e/m2e-core#830).
But there was only negative feedback from all Maven devs about that suggestion, so each IDE has to continue to handle it their one way.

Anyway, as @mickaelistria said below we can maintain that metadata in a Eclipse M2E plug-in.

Indeed that would be bad and was the reason why I/we the M2E team reached out to the Maven devs on their mailing list (the link @kwin posted above) to establish a unified API defined/maintained by Maven that all IDEs could use. [...] But there was only negative feedback from all Maven devs about that suggestion, so each IDE has to continue to handle it their one way.

A very very strange conclusion drawn from a ML thread having this post: https://lists.apache.org/thread/044tno4lvdjvm4yv7orsqpmn3x4175c4

(edit: typo)

That's right Guillaume Nodet was not averse to the suggestion, but from the other not so positive comments I had the impression that this was not the general conclusion. However, if that was a misinterpretation from my side and the suggestion will be considered in the future, I'm glad. :)

As there was no consensus to add m2e specific metadata I removed it now in c34c3c7.

src/main/resources/META-INF/m2e/lifecycle-mapping-metadata.xml

HannesWell · 2022-10-31T21:21:01Z

src/main/java/org/apache/maven/plugins/dependency/AbstractDependencyMojo.java

@@ -59,6 +60,21 @@
    @Component
    private ArchiverManager archiverManager;

+
+    /**
+     * For m2e incremental build support


Since the BuildContext API is not Eclipse M2E specific (even though M2E is the only user I'm aware of) I suggest to make this comment more generic.
The same applies for the comment of the skipDuringIncrementalBuild.

It is mostly to not confuse it with http://takari.io/2014/03/25/incremental-build.html. Any suggestion for the naming as just incremental build support may be a bit too generic (as there are other incremental build APIs)?

Maybe IDE build support as this is also not only about incremental support but also about other features from the Build Support API (like notification about updates files or context-specific error messages)

Sounds good.

Done in c34c3c7.

mickaelistria · 2022-11-02T12:45:20Z

@kwin @HannesWell what about adding the lifecycle mappings in https://github.com/eclipse-m2e/m2e-core/blob/master/org.eclipse.m2e.core/lifecycle-mapping-metadata.xml and not include it in the PR if this is an issue for Maven project? After all, @olamy is right and we have a way to put those mappings file somewhere else, only the BuildContext API has to be part of the plugin as far as I know.

HannesWell · 2022-11-02T17:26:38Z

@kwin @HannesWell what about adding the lifecycle mappings in https://github.com/eclipse-m2e/m2e-core/blob/master/org.eclipse.m2e.core/lifecycle-mapping-metadata.xml and not include it in the PR if this is an issue for Maven project? After all, @olamy is right and we have a way to put those mappings file somewhere else, only the BuildContext API has to be part of the plugin as far as I know.

Yes we can do that. Actually it would be natural to have all metadata in the plugin to minimize the synchronization effort, but this does only make sense if that is in a general 'Maven' format and not a IDE specific one (as said above #257 (comment))

remove m2e specific lifecycle mapping metadata

HannesWell

Looks good to me. Thank you!

src/main/java/org/apache/maven/plugins/dependency/AbstractDependencyMojo.java

slawekjaranowski

I'm not a fan such case ... but ok looks good enough

fix since version

[MDEP-674] Add m2e lifecycle metadata

c22e5a5

Use BuildContext to notify about newly generated files/folders

kwin requested review from michael-o and slawekjaranowski October 28, 2022 11:27

slawekjaranowski reviewed Oct 28, 2022

View reviewed changes

kwin requested a review from olamy October 28, 2022 13:29

michael-o removed their request for review October 28, 2022 19:25

HannesWell reviewed Oct 31, 2022

View reviewed changes

src/main/resources/META-INF/m2e/lifecycle-mapping-metadata.xml Outdated Show resolved Hide resolved

HannesWell reviewed Oct 31, 2022

View reviewed changes

fix comments

c34c3c7

remove m2e specific lifecycle mapping metadata

kwin requested review from HannesWell, slawekjaranowski, mickaelistria and cstamas and removed request for HannesWell and mickaelistria November 9, 2022 16:06

kwin changed the title ~~[MDEP-674] Add m2e lifecycle metadata~~ [MDEP-674] Add IDE build support Nov 9, 2022

mickaelistria approved these changes Nov 9, 2022

View reviewed changes

kwin added 3 commits November 9, 2022 18:57

replace m2e link by plexus-build-api one

2da2ab8

add more context to why old coordinates are used

512800e

remove m2e specific metadata

5c310ad

HannesWell approved these changes Nov 9, 2022

View reviewed changes

slawekjaranowski reviewed Nov 21, 2022

View reviewed changes

src/main/java/org/apache/maven/plugins/dependency/AbstractDependencyMojo.java Outdated Show resolved Hide resolved

slawekjaranowski approved these changes Nov 21, 2022

View reviewed changes

olamy approved these changes Nov 22, 2022

View reviewed changes

reword javadoc

1b79277

fix since version

kwin merged commit 50a4b70 into master Nov 22, 2022

kwin deleted the feature/incremental-build-support branch November 22, 2022 10:08

kwin mentioned this pull request Nov 22, 2022

Add m2e lifecycle metadata for maven-dependency-plugin 3.4.0+ eclipse-m2e/m2e-core#1077

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MDEP-674] Add IDE build support #257

[MDEP-674] Add IDE build support #257

kwin commented Oct 28, 2022

slawekjaranowski left a comment

slawekjaranowski Oct 28, 2022

kwin Oct 28, 2022

kwin Oct 28, 2022

slawekjaranowski Oct 28, 2022

kwin Oct 28, 2022

mickaelistria Nov 2, 2022

olamy Nov 2, 2022 •

edited

kwin Nov 2, 2022 •

edited

olamy Nov 2, 2022

HannesWell Nov 2, 2022

cstamas Nov 2, 2022 •

edited

HannesWell Nov 2, 2022

kwin Nov 9, 2022

HannesWell Oct 31, 2022

kwin Oct 31, 2022

kwin Nov 2, 2022

HannesWell Nov 2, 2022

kwin Nov 9, 2022

mickaelistria commented Nov 2, 2022

HannesWell commented Nov 2, 2022

HannesWell left a comment

slawekjaranowski left a comment

[MDEP-674] Add IDE build support #257

[MDEP-674] Add IDE build support #257

Conversation

kwin commented Oct 28, 2022

slawekjaranowski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

olamy Nov 2, 2022 • edited

Choose a reason for hiding this comment

kwin Nov 2, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cstamas Nov 2, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mickaelistria commented Nov 2, 2022

HannesWell commented Nov 2, 2022

HannesWell left a comment

Choose a reason for hiding this comment

slawekjaranowski left a comment

Choose a reason for hiding this comment

olamy Nov 2, 2022 •

edited

kwin Nov 2, 2022 •

edited

cstamas Nov 2, 2022 •

edited