Bug 531089 - Use standard Git setup for Platform development as Oomph setup files frequently out of date
Summary: Use standard Git setup for Platform development as Oomph setup files frequent...
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 4.8   Edit
Hardware: PC Windows 10
: P3 major (vote)
Target Milestone: ---   Edit
Assignee: Patrik Suzzi CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 531135
Blocks:
  Show dependency tree
 
Reported: 2018-02-13 05:11 EST by Max Bureck CLA
Modified: 2019-06-19 05:00 EDT (History)
8 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Max Bureck CLA 2018-02-13 05:11:15 EST
Hi,

The CONTRIBUTING.md file in the "eclipse.platform.ui" git repository points to the wiki entry https://wiki.eclipse.org/Platform_UI/How_to_Contribute.
This wiki entry suggests to install Eclipse via the installer and use the Oomph setup to install and set up an Eclipse installation.

Unfortunately this setup seems to fail for the current master.  The setup file seems to be out of date. 
This scares away new contributors. If the officially documented setup fails they are unlikely to try again in the future.

There are two possible solutions to the problem:

1. Keep the Setup up to date. At least after each release, update the Oomph setup, so it stays current on the master branch.

2. Change the official contribution guide to a different setup (or link to existing external tutorials from there), delete the setup file and request removal from the official installer.


I myself have some experience with Oomph setups and tried to update the setup file to work with Photon. Unfortunately I ran into p2 issues. The issue seems to be that the dependency from bundle "org.eclipse.e4.ui.services" to the service class "org.osgi.service.event.EventAdmin", which is located in bundle "org.eclipse.osgi.services", cannot be resolved (for whatever reason). Adding the feature dependency "org.eclipse.equinox.core.feature" (which seems to contain "org.eclipse.osgi.services") manually to the modular target does not help. Not sure if this is a shortcoming in Oomph. At least my adjusted setup fails with this error. Oomph is centrally configured to use repository "http://download.eclipse.org/eclipse/updates/4.8-I-builds" for Photon.


From my perspective, the Oomph setup is the fastest and easiest way to get a new contributor up and running. But if the burden of maintenance is too high, this setup path should be removed.
Comment 1 Lars Vogel CLA 2018-02-13 05:20:27 EST
We constantly facing issues with the Oomph setup. Also, most of the platfrom committer are not using Oomph for their setup. Stefan Xenos was a big promoter of Ooomph and used to handle the setup but he left the project.

I suggest we switch back to the traditional Git + description setup.
Comment 2 Lars Vogel CLA 2018-02-13 05:30:30 EST
Dani, is the IBM team using the Oomph setup?
Comment 3 Lars Vogel CLA 2018-02-13 05:30:48 EST
Alex, is the Redhat team using the Oomph setup?
Comment 4 Mickael Istria CLA 2018-02-13 05:33:08 EST
(In reply to Max Bureck from comment #0)
> The CONTRIBUTING.md file in the "eclipse.platform.ui" git repository points
> to the wiki entry https://wiki.eclipse.org/Platform_UI/How_to_Contribute.

I believe it would be nicer to do it the other way round (doc on Git, wiki referencing Git), so we'd have:
* history of contributor guide
* ability to review change more easily
* contributor guide shipped with the code (so someone who just clone the repo has  it directly without browsing to someplace else)
* more visibility to remind us to keep it up-to-date.
Comment 5 Lars Vogel CLA 2018-02-13 05:48:34 EST
(In reply to Mickael Istria from comment #4)
> I believe it would be nicer to do it the other way round (doc on Git, wiki
> referencing Git), so we'd have:

+1, the only issue is that we would have to replicate content accross of repos.
Comment 6 Alexander Kurtakov CLA 2018-02-13 06:15:50 EST
(In reply to Lars Vogel from comment #3)
> Alex, is the Redhat team using the Oomph setup?

No one AFAIK.
Comment 7 Patrik Suzzi CLA 2018-02-14 06:23:12 EST
We should restore the old content [#1] and move Oomph instructions in a separate page. 

Oomph setup should be updated regularly, after each release. With Oomph working, it will be easy to have new contributors, and to work on different platform projects. This should be discussed in a different bug -> Bug 530807

I like Mickael's idea to ship docs with code, but this should be discussed in a new bug -> Bug 531141

[#1] https://wiki.eclipse.org/index.php?title=Platform_UI/How_to_Contribute&oldid=394080
Comment 8 Lars Vogel CLA 2018-02-14 06:28:52 EST
(In reply to Patrik Suzzi from comment #7)
> We should restore the old content [#1] and move Oomph instructions in a
> separate page. 

+1
Comment 9 Patrik Suzzi CLA 2018-02-15 01:41:19 EST
I updated the default page with the manual setup [#1] and created a new page [#2] for the setup with Oomph. 

Please, feel free to check the wiki page and correct the information. 


P.S. I still think Oomph is great for new contributors and for setting up multiple platform projects in a breeze, but we should keep the setup files updated.


[#1] https://wiki.eclipse.org/Platform_UI/How_to_Contribute
[#2] https://wiki.eclipse.org/Platform_UI/How_to_Contribute/Oomph
Comment 10 Karsten Thoms CLA 2018-02-15 05:11:05 EST
The platform setup had an invalid repository URL for Nebula snapshots. I removed them with bug#531135 yesterday.
Comment 11 Rolf Theunissen CLA 2019-06-19 05:00:53 EDT
The structure of Oomph setup files has changed, such that they do not need to be updated any time there is a new release.
The current Oomph configuration is stable for at least 3 releases. Marking this one as fixed.