Bug 468487 - Add build instructions to JDT UI Readme.md
Summary: Add build instructions to JDT UI Readme.md
Status: RESOLVED WONTFIX
Alias: None
Product: JDT
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 4.5   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Lars Vogel CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2015-05-27 10:44 EDT by Lars Vogel CLA
Modified: 2018-06-12 07:23 EDT (History)
6 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Lars Vogel CLA 2015-05-27 10:44:14 EDT
I think it makes sense to add the info how to build the JDT plug-ins via Maven Tycho. Gerrit review on its way.
Comment 1 Eclipse Genie CLA 2015-05-27 10:51:07 EDT
New Gerrit change created: https://git.eclipse.org/r/48781
Comment 2 Lars Vogel CLA 2015-07-27 16:20:04 EDT
Dani, what do you think?
Comment 3 Dani Megert CLA 2015-07-28 10:37:01 EDT
Everyone who uses Maven should know those and all others should use Gerrit and let it build - and test - the stuff for them. In addition, it's not a must to use Maven. One could still use PDE Build if desired.
Comment 4 Lars Vogel CLA 2015-07-28 11:20:41 EDT
(In reply to Dani Megert from comment #3)
> Everyone who uses Maven should know those and all others should use Gerrit
> and let it build - and test - the stuff for them. 

The -build-individual-bundles profile is specific to Eclipse and unfortunately not easy to find. A normal Maven build "mvn clean verify" will fail without this profile. IMHO adding a short section to a Readme file does not harm. Please reconsider.
Comment 5 Dani Megert CLA 2015-07-28 11:26:23 EDT
(In reply to Lars Vogel from comment #4)
> (In reply to Dani Megert from comment #3)
> > Everyone who uses Maven should know those and all others should use Gerrit
> > and let it build - and test - the stuff for them. 
> 
> The -build-individual-bundles profile is specific to Eclipse and
> unfortunately not easy to find. A normal Maven build "mvn clean verify" will
> fail without this profile. IMHO adding a short section to a Readme file does
> not harm. Please reconsider.

I might reconsider if we (speak: every single repo) can point to a wiki page where the build process is described and can be adapted when things change over time. That page should also contain instructions for beginners, which never used the mvn command before.
Comment 6 Gunnar Morling CLA 2015-11-06 05:09:53 EST
I hope you don't mind me chiming in.

A big +1 from me for adding this info to the readme. This would have saved me a considerable amount of time last night, trying to analyze a JDT bug and having to fight the build first before getting to my actual issue.

As Lars is saying, Maven users won't know by default about any specific profiles that need to be enabled, so providing this info will make things much easier for them.

Actually much better would be to make "mvn clean install/verify" workable, because that's really the expectation Maven users have. Not sure what's needed for that, maybe that profile could just be enabled by default?

I don't see how such wiki page is related (as nice as it may be), why should the ease-of-use for potential contributors not improved for a single repo? Actually I found the solution in a stack overflow answer, how much better it would be to have the answer right there where it is needed.
Comment 7 Lars Vogel CLA 2016-09-09 08:30:14 EDT
(In reply to Gunnar Morling from comment #6)
> I hope you don't mind me chiming in.
> 
> A big +1 from me for adding this info to the readme. This would have saved
> me a considerable amount of time last night, trying to analyze a JDT bug and
> having to fight the build first before getting to my actual issue.

Noopur, could you merge this for M3? As new component lead I hope you will continue to make contributions to JDT UI easier. 

https://projects.eclipse.org/projects/eclipse.jdt.ui/who shows the current stats.
Comment 8 Noopur Gupta CLA 2016-09-26 06:03:19 EDT
(In reply to Gunnar Morling from comment #6)
> Actually much better would be to make "mvn clean install/verify" workable,
> because that's really the expectation Maven users have. Not sure what's
> needed for that, maybe that profile could just be enabled by default?

+1. This should be the correct approach for all Eclipse projects. 

Lars, could you please check if someone can provide a patch for this?

In the meantime:

(In reply to Dani Megert from comment #5)
> I might reconsider if we (speak: every single repo) can point to a wiki page
> where the build process is described and can be adapted when things change
> over time. 

+1. We should have a common wiki page which mentions this and we can add a link to this page in the readme files from individual Eclipse projects so that it is easier to maintain the changes over time. Patch for this is welcome if the first approach is not feasible at the moment.
Comment 9 Lars Vogel CLA 2018-02-14 06:26:25 EST
(In reply to Noopur Gupta from comment #8)
> (In reply to Gunnar Morling from comment #6)
> > Actually much better would be to make "mvn clean install/verify" workable,
> > because that's really the expectation Maven users have. Not sure what's
> > needed for that, maybe that profile could just be enabled by default?

> Lars, could you please check if someone can provide a patch for this?

Alex looked at this a while ago and unfortunately this is not possible. We currently require 

mvn clean verify -Pbuild-individual-bundles

> In the meantime:
> 
> (In reply to Dani Megert from comment #5)
> > I might reconsider if we (speak: every single repo) can point to a wiki page
> > where the build process is described and can be adapted when things change
> > over time. 
> 
> +1. We should have a common wiki page which mentions this and we can add a
> link to this page in the readme files from individual Eclipse projects so
> that it is easier to maintain the changes over time. Patch for this is
> welcome if the first approach is not feasible at the moment.

I don't think it is worth to point to a wiki which says: Use `mvn clean verify -Pbuild-individual-bundles`.

Better to add this to the source repo.
Comment 10 Dani Megert CLA 2018-02-14 09:15:24 EST
(In reply to Lars Vogel from comment #9)
> I don't think it is worth to point to a wiki which says: Use `mvn clean
> verify -Pbuild-individual-bundles`.
> 
> Better to add this to the source repo.

It is worth it. The wiki page can also have additional information that allows beginners to build, e.g. tell what exactly needs to be installed to run the build, required Maven version, etc.

Currently out of the 34 repos I have in my workspace only 2 have instructions for Maven and they are not identical.

==> -2 to merge the change.
Comment 11 Lars Vogel CLA 2018-06-12 07:23:10 EDT
Marking as wontfix as of Dani comment.