Add documentation for including JRE with Eclipse products#5601
Conversation
Co-authored-by: laeubi <1331477+laeubi@users.noreply.github.com>
Address review comments: - Remove incorrect requirement to add JustJ repository to pom.xml for automatic inclusion - Remove executionEnvironment configuration from automatic method (not needed) - Clarify that productRepository parameter handles JRE fetching automatically - Update troubleshooting to distinguish between automatic and manual methods - Remove incorrect section about customizing JRE name - Add proper explanation of productRepository parameter customization Co-authored-by: laeubi <1331477+laeubi@users.noreply.github.com>
Addressed both review comments in commit 5634698:
The documentation now correctly distinguishes between:
Screenshot of updated Prerequisites section: https://github.com/user-attachments/assets/c3903f2a-6175-4d32-b4a2-5421fc415d06 |
Add comprehensive documentation for including JRE with products (cherry picked from commit 0fd7323)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation and see the Github Action logs for details |
Add comprehensive documentation for including JRE with products (cherry picked from commit 0fd7323)
Users frequently encounter confusion when trying to bundle a JRE with Eclipse products, particularly around the
includeJRE="true"flag and its interaction with JustJ and target platform configuration (issues #5579, #4791, #2064).Changes
New documentation page:
IncludeJRE.mdexplaining JRE inclusion methodsincludeJRE="true"(recommended approach)Site navigation updates: Added links in
site.xml,index.md, andProducts.mdExample Configuration
Automatic JRE inclusion with JustJ:
That's it! No additional pom.xml configuration needed. Tycho automatically fetches the JRE from the JustJ repository via the
productRepositoryparameter (defaults tohttps://download.eclipse.org/justj/jres).Optional Customization
If you need to use a specific JRE version:
Key Points
includeJRE="true"): Zero configuration needed - Tycho handles JRE fetching automatically<repositories>andexecutionEnvironment=nonein target-platform-configurationproductRepositoryparameter intycho-p2-director-plugincontrols where Tycho fetches JRE from for automatic inclusionScreenshot
Documentation page follows existing Tycho site structure and styling, positioned alongside SignProducts documentation under "Building Products" section.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.