Skip to content

Add documentation for including JRE with Eclipse products#5601

Merged
laeubi merged 4 commits intomainfrom
copilot/add-jre-inclusion-section
Nov 12, 2025
Merged

Add documentation for including JRE with Eclipse products#5601
laeubi merged 4 commits intomainfrom
copilot/add-jre-inclusion-section

Conversation

Copy link
Contributor

Copilot AI commented Nov 12, 2025

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.md explaining JRE inclusion methods

    • Automatic inclusion via includeJRE="true" (recommended approach)
    • Manual inclusion via explicit JRE features
    • Complete working examples with pom.xml and .product configurations
    • Troubleshooting guide covering common pitfalls
    • FAQ addressing multi-platform builds, JRE variants, and provider alternatives
  • Site navigation updates: Added links in site.xml, index.md, and Products.md

Example Configuration

Automatic JRE inclusion with JustJ:

<!-- .product file -->
<product name="My Application" 
         uid="my.application.product"
         includeJRE="true"
         ...>

That's it! No additional pom.xml configuration needed. Tycho automatically fetches the JRE from the JustJ repository via the productRepository parameter (defaults to https://download.eclipse.org/justj/jres).

Optional Customization

If you need to use a specific JRE version:

<plugin>
  <groupId>org.eclipse.tycho</groupId>
  <artifactId>tycho-p2-director-plugin</artifactId>
  <configuration>
    <productRepository>https://download.eclipse.org/justj/jres/21/updates/release/</productRepository>
  </configuration>
</plugin>

Key Points

  • Automatic method (includeJRE="true"): Zero configuration needed - Tycho handles JRE fetching automatically
  • Manual method (explicit features): Requires JustJ repository in <repositories> and executionEnvironment=none in target-platform-configuration
  • The productRepository parameter in tycho-p2-director-plugin controls where Tycho fetches JRE from for automatic inclusion

Screenshot

Documentation page follows existing Tycho site structure and styling, positioned alongside SignProducts documentation under "Building Products" section.

Original prompt

Add a new section to the sitedocs that explains how to inlcude a JRE with the product

We already have SignProducts section that explains the signing, but we also want to have one that explains how to inlcude a JRE in prodcuts as Tycho offers multiple ways.

Esepcially the new option to let tycho include it automatically when the product has the flag includeJRE="true" needs further description as people are often confused how to use it see for further information


💡 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.

Co-authored-by: laeubi <1331477+laeubi@users.noreply.github.com>
Copilot AI changed the title [WIP] Add section for including JRE in product documentation Add documentation for including JRE with Eclipse products Nov 12, 2025
Copilot AI requested a review from laeubi November 12, 2025 08:11
Copy link
Member

@laeubi laeubi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot please look at my review comments something is out of track here

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>
Copy link
Contributor Author

Copilot AI commented Nov 12, 2025

@copilot please look at my review comments something is out of track here

Addressed both review comments in commit 5634698:

  1. Line 32 - Fixed incorrect Prerequisites section for automatic JRE inclusion. No repository or target platform configuration needed - Tycho automatically fetches JRE via productRepository parameter.

  2. Line 118 - Removed incorrect "Customizing the JRE Name" section. The jreName parameter is not meant for customization per the source code documentation.

The documentation now correctly distinguishes between:

  • Automatic method: Only needs includeJRE="true", no additional config
  • Manual method: Requires JustJ repository and executionEnvironment=none

Screenshot of updated Prerequisites section: https://github.com/user-attachments/assets/c3903f2a-6175-4d32-b4a2-5421fc415d06

Copilot AI requested a review from laeubi November 12, 2025 08:32
@laeubi laeubi marked this pull request as ready for review November 12, 2025 12:07
@laeubi laeubi enabled auto-merge (squash) November 12, 2025 12:08
@laeubi laeubi merged commit 0fd7323 into main Nov 12, 2025
16 checks passed
@laeubi laeubi deleted the copilot/add-jre-inclusion-section branch November 12, 2025 13:55
eclipse-tycho-bot pushed a commit that referenced this pull request Nov 12, 2025
Add comprehensive documentation for including JRE with products

(cherry picked from commit 0fd7323)
@eclipse-tycho-bot
Copy link

💚 All backports created successfully

Status Branch Result
tycho-5.0.x

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

eclipse-tycho-bot pushed a commit that referenced this pull request Nov 12, 2025
Add comprehensive documentation for including JRE with products

(cherry picked from commit 0fd7323)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants