Skip to content

docs: the Eclipse plugin now downloads JetBrains Runtime - #5886

Open
totally-not-ai[bot] wants to merge 1 commit into
mainfrom
docs/eclipse-plugin-downloads-jbr
Open

docs: the Eclipse plugin now downloads JetBrains Runtime#5886
totally-not-ai[bot] wants to merge 1 commit into
mainfrom
docs/eclipse-plugin-downloads-jbr

Conversation

@totally-not-ai

Copy link
Copy Markdown
Contributor

Follow-up to #5884, now that vaadin/eclipse-plugin#89 is merged.

What changed

Until now, the Vaadin plugin for Eclipse could only use a JetBrains Runtime that was already registered with the IDE — downloadAndInstallJBR() was a stub — so the docs told readers that JBR was "the only thing you have to install yourself". The plugin now resolves, downloads, installs and registers a JBR on its own when it can't find a compatible one, the same way the IntelliJ IDEA and VS Code plugins do.

run/eclipse.adoc

  • JetBrains Runtime: no longer opens with "download it from GitHub". It states why the runtime is needed, notes that the plugin offers to download one, and keeps the manual download link for the manual route.
  • Enabling Hotswap Using the Vaadin Plugin: dropped "the only thing you have to install yourself is JetBrains Runtime" and the instruction to register a JBR under menu:Java[Installed JREs] before launching.
  • Added a description of what actually happens on launch: the plugin looks for a JetBrains Runtime matching the project's required Java version among the JREs Eclipse knows about, and shows the JetBrains Runtime Required dialog if there isn't one. Both buttons are documented — Download JetBrains Runtime (latest release for the platform, progress dialog, installed to .vaadin/jdk in the home directory shared with the other IDE plugins, registered under menu:Java[Installed JREs]) and Continue Without JBR (regular JVM, method bodies only).
  • Kept a pointer for people who want to use their own JetBrains Runtime: register it under menu:Java[Installed JREs] before launching and the plugin uses that one.

flow/configuration/live-reload/hotswap-agent.adoc

  • The Eclipse paragraph said the same thing about installing JBR yourself; it now mentions the download instead.

The Enabling Hotswap Manually section is unchanged — that route still needs a hand-installed runtime.

Note on timing

The plugin change is on main but is not in a released version yet — the latest Marketplace release is 1.0.7 (February 2026), and vaadin/eclipse-plugin#89 was merged on 2026-08-20. This PR probably shouldn't be merged before the plugin release that contains it ships.

The Vaadin plugin for Eclipse used to require a JetBrains Runtime that
was already registered with the IDE, so the docs told readers to install
one by hand. Since vaadin/eclipse-plugin#89 the plugin resolves,
downloads, installs and registers a JBR on its own when it cannot find a
compatible one.

Describe the JetBrains Runtime Required dialog and its two options, the
shared ~/.vaadin/jdk install location, and how to keep using a manually
installed runtime instead. The manual hotswap setup is unchanged.
@github-actions

Copy link
Copy Markdown

Preview Deployment

This PR has been deployed for preview.

URL: https://docs-preview-pr-5886.fly.dev

Changed pages

Added content is highlighted in green; removed content is marked in red on each page.

Built from f04c278

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants