Add Support for JetBrains Runtime #637

gmitch215 · 2024-06-05T20:55:03Z

Current Workaround

- name: Setup JBR 21
  uses: gmitch215/setup-java@4e56c31b28053b7081e102121153633227d6dd8e
  with:
    distribution: 'jetbrains'
    java-version: 21
    cache: 'gradle'
  # For GitHub API (use if you believe you'd run into rate limits)
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Description:
This PR adds support for the JetBrains Runtime, which is required in dependencies like jewel and useful for Compose Multiplatform.

The PR uses the binaries listed in Binaries for Developers , using the JBRSDK flavor as shown in the releases page for the default flavor jdk. Alternative flavors include jdk+jcef and jdk+ft with jre counterparts.

It uses the GitHub API to find and parse versions, then calculates the URL using cache-redirector.jetbrains.com with the parsed SemVer, OS, Arch, and build number, which all output a .tar.gz file. Left a few comments in there for maintainability. Some tags have inconsistent naming conventions, or have been removed from public view for various reasons, so it will filter out those versions.

Since this uses the GitHub API, you can optionally specify a GITHUB_TOKEN environmental variable to increase your rate limit.

Related issue:

Closes Support JetBrainsRuntime distribution #399
Closes JDK support distribution JBR (jetbrains runtime version) #585 (Duplicate)

Check list:

Mark if documentation changes are required.
Mark if tests were added or updated to cover the changes.

Notes
Tested using jetbrains-installer.test.ts. Most of the tests were copied from other installers, but some I couldn't figure out how to bring over, so additional work may be required. I also copied downloadTool from the Temurin installer.

I also executed npm run build for dist/setup/index.js. I think something else was also thrown because I was on TypeScript 5.3, so I'm not sure how that will affect ncc.

- Add Installer, Models - Includes Tests & Test Manifest Data - Add to `e2e-versions.yml` - Run `npm run build` - Update README.md

Goooler · 2024-06-19T01:52:30Z

I'm using your branch as a workaround

  # TODO: replace this once https://github.com/actions/setup-java/pull/637 gets merged.
  - uses: gmitch215/setup-java@07ea605e4b1f0f8b0621155fb1722d6094c3e183
    with:
      distribution: 'jetbrains'
      java-version: 17

with an error:

Installed distributions
  Error: No supported distribution was found for input jetbrains

is there anything I can do?

See:

gmitch215 · 2024-06-19T03:03:11Z

Hmm, I'll debug and get back here later.

gmitch215 · 2024-06-19T03:18:34Z

Seems I just forgot to add it to the map of recognized runtimes to their IDs. Update your commit hash and it should succeed.

My project passed with the following configuration:

      - name: Setup JBR 17
        uses: gmitch215/setup-java@7f3ab2648f3d20faa20c4fe6e52a455757e0f38a
        with:
          distribution: 'jetbrains'
          java-version: 17
          cache: 'gradle'

Output:

Goooler · 2024-06-19T03:35:59Z

It could be picked correctly now!

But seems some libs are missing in this JDK installed.

Execution failed for task ':checkRuntime'.
You can use '--warning-mode all' to show the individual deprecation warnings and determine if they come from your own scripts or plugins.
> Failed to check JDK distribution: 'jlink', 'jpackage' are missing

  JDK distribution path: /Users/runner/hostedtoolcache/Java_JetBrains_jdk/17.0.11-1312.2/arm64/Contents/Home

See https://github.com/Goooler/kotlin-explorer/actions/runs/9575738587/job/26401058613.

Goooler · 2024-06-19T03:49:24Z

The JDK installed by Gradle toolchain worked fine.

Invalid Java installation found at '/Users/runner/.gradle/jdks/jetbrains_s_r_o_-17-aarch64-os_x/jbrsdk_jcef-17.0.11-osx-aarch64-b1207.24/Contents/Home' (Auto-provisioned by Gradle). It will be re-checked in the next build. This might have performance impact if it keeps failing. Run the 'javaToolchains' task for more details.

Seems we need Binaries for developers instead of Binaries for launching IntelliJ IDEA, which is installed by your action. Check https://github.com/JetBrains/JetBrainsRuntime/releases/tag/jbr-release-17.0.11b1312.2.

gmitch215 · 2024-06-19T04:01:21Z

I switched the URL to the ones listed in the Binaries for Developers section, still getting the same errors. Going to do some more research.

gmitch215 · 2024-06-19T04:12:10Z

I guessed correctly! :checkRuntime seems to pass.

      - name: Setup JBR 17
        uses: gmitch215/setup-java@99fc2135f7f7b08068e180cb5f29340f9de70720
        with:
          distribution: 'jetbrains'
          java-version: 17
          cache: 'gradle'

(This action failed due to below)

Note: Running on windows-latest seems to fail, so I'll fix that too.

Goooler · 2024-06-19T04:25:49Z

99fc213 works for me now, someone who needs this can ref romainguy/kotlin-explorer#62.

Thanks for your quick response!

gmitch215 · 2024-06-19T04:48:53Z

Got windows-latest to build now. Everything else works fine too.

      - name: Setup JBR 17
        uses: gmitch215/setup-java@e1f4c15facc0cf68c0e764340e374be034e4a859
        with:
          distribution: 'jetbrains'
          java-version: 17
          cache: 'gradle'

eskatos · 2024-07-06T11:11:54Z

Thank you @gmitch215, I'm using your branch as a workaround too and can confirm it works fine!
It would be great if this contribution could be accepted.

eskatos · 2024-07-08T22:15:58Z

On a relatively complex workflow with a fan-out setup and composite actions that parallelize builds I get rate limit failures from time to time:

Run gmitch215/setup-java@36531813787dd0ff3269feeb1144b35b3d68f927
  with:
    java-version: 21
    java-package: jdk
    distribution: jetbrains
    check-latest: false
    server-id: github
    server-username: GITHUB_ACTOR
    server-password: GITHUB_TOKEN
    overwrite-settings: true
    job-status: success
    token: ***
Installed distributions
  Trying to resolve the latest version from remote
  Error: API rate limit exceeded for 52.159.14[7](https://github.com/eskatos/private-repository/actions/runs/1234567890/job/1234567890#step:3:8).63. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)

Is there something that can be done in this action's implementation or on my side?

gmitch215 · 2024-07-09T01:33:15Z

@eskatos The JetBrains cache-redirector server does rate limit by IP. To my knowledge, there isn't a way to change the rate limit. The root URL's info page is internal as well, and only accessible by employees.

Your best bet is to do something that changes the IP (not sure if re-running it manually does this, but worth a shot). Unless someone knows how the runner could provide authentication.

Edit: This error page is about the GitHub API, which is something I need to add. However, the above is still true.

Edit 2: Done.

- name: Setup JBR 21
  uses: gmitch215/setup-java@b4d76a354bef7187244f74eea4e80e674a7b4b55
  with:
    distribution: 'jetbrains'
    java-version: 21
    cache: 'gradle'

eskatos · 2024-07-09T06:07:26Z

Re-running did make the job pass indeed.

This error page is about the GitHub API, which is something I need to add.

Thank you for fixing this!

eskatos · 2024-07-09T07:59:20Z

With b4d76a3 I'm getting this:

  Trying to resolve the latest version from remote
  Error: Bad credentials

gmitch215 · 2024-07-09T15:36:12Z

@eskatos I forgot GitHub doesn't automatically inject the GITHUB_TOKEN environment variable on action workflows.

The action should now check if it is provided. Update to this:

- name: Setup JBR 21
  uses: gmitch215/setup-java@6d2c5e1f82f180ae79f799f0ed6e3e5efb4e664d
  with:
    distribution: 'jetbrains'
    java-version: 21
    cache: 'gradle'
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

gmitch215 · 2024-11-21T13:36:54Z

Hi @gmitch215,

The updated PR resolves most issues, but there are some version-specific discrepancies as per this documentation :

Tests fail for certain versions (e.g., 11_0_15) but work for others (e.g., 11.0.15). Users may input versions with underscores (e.g., 11_0_15) instead of dots (e.g., 11.0.15), which should be addressed.

I am a little confused. Are you saying 11_0_15 doesn't work but 11.0.15 does? They're all based on the GitHub tags the bot publishes. I'll validate whether underscores are inputted, since that behavior isn't intended, but that behavior should be expected.

Some versions (e.g., 11.0.10) do not work, while others (e.g., 11.0.11) do. It would be beneficial to update the setup-java documentation to reflect these scenarios, especially the version formatting and compatibility issues.

JetBrains seems to have removed 11.0.10 from their releases page, despite being available via URL. I'll have to add it manually.

.github/workflows/e2e-versions.yml

src/distributions/jetbrains/installer.ts

aparnajyothi-y · 2024-11-27T16:43:22Z

Hi @gmitch215, could you please confirm if you are working on updating the documentation to include information about the valid input for JDK 11?

gmitch215 · 2024-11-28T07:36:49Z

Hi @gmitch215, could you please confirm if you are working on updating the documentation to include information about the valid input for JDK 11?

Yes, currently working on new fixes.

crowforkotlin · 2024-11-28T14:03:00Z

hello, I use jewel in my project, which requires jbrsdk+jcef but I see that jbr doesn't have jpackage, so when I use ./gradlew packageDmg, I get an error! Failed to check JDK distribution: 'jpackage' is missing
Is there a way around this?

gmitch215 · 2024-11-28T18:58:46Z

hello, I use jewel in my project, which requires jbrsdk+jcef but I see that jbr doesn't have jpackage, so when I use ./gradlew packageDmg, I get an error! Failed to check JDK distribution: 'jpackage' is missing Is there a way around this?

You can use jdk+jcef as the package-type parameter and it should install it. I'll update the documentation soon.

gmitch215 · 2024-11-28T19:44:23Z

@aparnajyothi-y @mahabaleshwars Documentation is updated and hidden versions were added.

crowforkotlin · 2024-11-29T01:33:19Z

hello, I use jewel in my project, which requires jbrsdk+jcef but I see that jbr doesn't have jpackage, so when I use ./gradlew packageDmg, I get an error! Failed to check JDK distribution: 'jpackage' is missing Is there a way around this?

You can use jdk+jcef as the package-type parameter and it should install it. I'll update the documentation soon.

how to configure this ‘package-type’

crowforkotlin · 2024-11-29T01:35:09Z

@aparnajyothi-y @mahabaleshwars Documentation is updated and hidden versions were added.

Maybe I didn't make my question clear to you, you can look here JetBrains/jewel#709

gmitch215 · 2024-11-29T19:47:10Z

@aparnajyothi-y @mahabaleshwars Documentation is updated and hidden versions were added.

Maybe I didn't make my question clear to you, you can look here JetBrains/jewel#709

- name: Setup JBR 21
  uses: gmitch215/setup-java@main
  with:
    distribution: 'jetbrains'
    java-version: 21
    cache: 'gradle'
    java-package: 'jdk+jcef'
  # For GitHub API (use if you believe you'd run into rate limits)
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

crowforkotlin · 2024-11-30T06:06:23Z

@aparnajyothi-y @mahabaleshwars Documentation is updated and hidden versions were added.

Maybe I didn't make my question clear to you, you can look here JetBrains/jewel#709
- name: Setup JBR 21
  uses: gmitch215/setup-java@main
  with:
    distribution: 'jetbrains'
    java-version: 21
    cache: 'gradle'
    package-type: 'jdk+jcef'
  # For GitHub API (use if you believe you'd run into rate limits)
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

ok, thank you

Jonatha1983 · 2024-11-30T11:52:05Z

@gmitch215 its package-type or java-package?
I am getting this:

Unexpected input(s) 'package-type', valid inputs are ['java-version', 'java-version-file', 'distribution', 'java-package', 'architecture', 'jdkFile', 'check-latest', 'server-id', 'server-username', 'server-password', 'settings-path', 'overwrite-settings', 'gpg-private-key', 'gpg-passphrase', 'cache', 'cache-dependency-path', 'job-status', 'token', 'mvn-toolchain-id', 'mvn-toolchain-vendor']

gmitch215 · 2024-12-01T19:56:28Z

@gmitch215 its package-type or java-package? I am getting this:

Unexpected input(s) 'package-type', valid inputs are ['java-version', 'java-version-file', 'distribution', 'java-package', 'architecture', 'jdkFile', 'check-latest', 'server-id', 'server-username', 'server-password', 'settings-path', 'overwrite-settings', 'gpg-private-key', 'gpg-passphrase', 'cache', 'cache-dependency-path', 'job-status', 'token', 'mvn-toolchain-id', 'mvn-toolchain-vendor']

That's correct, my bad.

mahabaleshwars · 2024-12-04T03:14:29Z

Hello @gmitch215,

Thanks again for the continuous improvements to the PR! The latest changes addressing the issue with JDK 11.0.10 and the documentation look great. However, I’ve noticed a couple of things that still need attention:

There are some CI failures that can be fixed by running the command:
npm audit fix

Regarding the JDK version input, the documentation mentions that versions are based on the GitHub tags on the JetBrains Runtime releases page, with both underscores (11_0_13) and dots (11.0.13) supported. While the dot format is encouraged for consistency, both are valid. That said, when the input for JDK 11 contains underscores, it is still failing. I see that you've already addressed this, but could you please take another look to see if there’s something we might have missed? I’ve attached a screenshot for reference.

Thanks again for your work on this!

gmitch215 · 2024-12-04T23:29:55Z

@mahabaleshwars Availability between using _ and . is usually inconsistent, especially on JDK 11. Sometimes it works and sometimes it doesn't.

That being said, I notice some tags do exist with underscore notation (_), so I'll take a look and update code/documentation.

Thank you all for moving this forward!

gmitch215 · 2024-12-05T13:51:57Z

@mahabaleshwars

Dot notation is enforced by the base installer, so underscore support is not possible. Updated the documentation to reflect this and fixed a typo.

Also ran npm audit fix.

gmitch215 · 2024-12-09T16:15:38Z

Once again, macos-latest issues are with GraalVM.

mahabaleshwars · 2024-12-11T04:15:59Z

Hello @gmitch215, CI workflow issues are fixed now and this should address the issues in this PR. Please sync the main branch with setup-java.

gmitch215 · 2024-12-11T17:55:42Z

@mahabaleshwars Done.

Add Support for JetBrains Runtime

bee7c85

- Add Installer, Models - Includes Tests & Test Manifest Data - Add to `e2e-versions.yml` - Run `npm run build` - Update README.md

gmitch215 requested a review from a team as a code owner June 5, 2024 20:55

Add Docs + Distro Factory

07ea605

gmitch215 added 2 commits June 18, 2024 22:11

Fix Runtime Unrecognizable

db1c6fa

npm run build (JBR)

7f3ab26

Fix Incorrect JBR Distribution

c192e7b

Switch to jbrsdk_jcef

99fc213

Goooler mentioned this pull request Jun 19, 2024

Workaround for JBR JDK used by Compose Desktop Gradle Plugin romainguy/kotlin-explorer#62

Merged

gmitch215 added 3 commits June 18, 2024 23:37

Fix Incorrect File Extension

4f206ba

npm run build (JBR)

ab5c653

Fix Windows Support

e1f4c15

gmitch215 mentioned this pull request Jun 28, 2024

Support JetBrainsRuntime distribution #399

Closed

Merge branch 'actions:main' into main

3653181

Add GITHUB_TOKEN Authentication

b4d76a3

Update Authorization, Add Documentation

6d2c5e1

jsoref reviewed Nov 27, 2024

View reviewed changes

gmitch215 added 3 commits November 28, 2024 19:43

Add Hidden JDK 11 Versions

3935436

Update jetbrains-installer Tests

847079d

Add Notices in Documentation

bd0d2b8

gmitch215 added 2 commits December 5, 2024 13:50

Fix Documentation

fb0f337

Run npm audit fix

19d961a

Fix Tests on Windows

35c79ae

Merge branch 'actions:main' into main

051967d

mahabaleshwars approved these changes Dec 12, 2024

View reviewed changes

aparnajyothi-y approved these changes Dec 12, 2024

View reviewed changes

HarithaVattikuti approved these changes Dec 12, 2024

View reviewed changes

HarithaVattikuti merged commit 7a6d8a8 into actions:main Dec 12, 2024
364 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Support for JetBrains Runtime #637

Add Support for JetBrains Runtime #637

gmitch215 commented Jun 5, 2024 •

edited

Loading

Goooler commented Jun 19, 2024

gmitch215 commented Jun 19, 2024

gmitch215 commented Jun 19, 2024

Goooler commented Jun 19, 2024

Goooler commented Jun 19, 2024

gmitch215 commented Jun 19, 2024 •

edited

Loading

gmitch215 commented Jun 19, 2024 •

edited

Loading

Goooler commented Jun 19, 2024

gmitch215 commented Jun 19, 2024

eskatos commented Jul 6, 2024

eskatos commented Jul 8, 2024

gmitch215 commented Jul 9, 2024 •

edited

Loading

eskatos commented Jul 9, 2024

eskatos commented Jul 9, 2024

gmitch215 commented Jul 9, 2024 •

edited

Loading

gmitch215 commented Nov 21, 2024

aparnajyothi-y commented Nov 27, 2024

gmitch215 commented Nov 28, 2024

crowforkotlin commented Nov 28, 2024

gmitch215 commented Nov 28, 2024 •

edited

Loading

gmitch215 commented Nov 28, 2024

crowforkotlin commented Nov 29, 2024

crowforkotlin commented Nov 29, 2024

gmitch215 commented Nov 29, 2024 •

edited

Loading

crowforkotlin commented Nov 30, 2024

Jonatha1983 commented Nov 30, 2024

gmitch215 commented Dec 1, 2024

mahabaleshwars commented Dec 4, 2024

gmitch215 commented Dec 4, 2024 •

edited

Loading

gmitch215 commented Dec 5, 2024

gmitch215 commented Dec 9, 2024

mahabaleshwars commented Dec 11, 2024

gmitch215 commented Dec 11, 2024

Add Support for JetBrains Runtime #637

Add Support for JetBrains Runtime #637

Conversation

gmitch215 commented Jun 5, 2024 • edited Loading

Goooler commented Jun 19, 2024

gmitch215 commented Jun 19, 2024

gmitch215 commented Jun 19, 2024

Goooler commented Jun 19, 2024

Goooler commented Jun 19, 2024

gmitch215 commented Jun 19, 2024 • edited Loading

gmitch215 commented Jun 19, 2024 • edited Loading

Goooler commented Jun 19, 2024

gmitch215 commented Jun 19, 2024

eskatos commented Jul 6, 2024

eskatos commented Jul 8, 2024

gmitch215 commented Jul 9, 2024 • edited Loading

eskatos commented Jul 9, 2024

eskatos commented Jul 9, 2024

gmitch215 commented Jul 9, 2024 • edited Loading

gmitch215 commented Nov 21, 2024

aparnajyothi-y commented Nov 27, 2024

gmitch215 commented Nov 28, 2024

crowforkotlin commented Nov 28, 2024

gmitch215 commented Nov 28, 2024 • edited Loading

gmitch215 commented Nov 28, 2024

crowforkotlin commented Nov 29, 2024

crowforkotlin commented Nov 29, 2024

gmitch215 commented Nov 29, 2024 • edited Loading

crowforkotlin commented Nov 30, 2024

Jonatha1983 commented Nov 30, 2024

gmitch215 commented Dec 1, 2024

mahabaleshwars commented Dec 4, 2024

gmitch215 commented Dec 4, 2024 • edited Loading

gmitch215 commented Dec 5, 2024

gmitch215 commented Dec 9, 2024

mahabaleshwars commented Dec 11, 2024

gmitch215 commented Dec 11, 2024

gmitch215 commented Jun 5, 2024 •

edited

Loading

gmitch215 commented Jun 19, 2024 •

edited

Loading

gmitch215 commented Jun 19, 2024 •

edited

Loading

gmitch215 commented Jul 9, 2024 •

edited

Loading

gmitch215 commented Jul 9, 2024 •

edited

Loading

gmitch215 commented Nov 28, 2024 •

edited

Loading

gmitch215 commented Nov 29, 2024 •

edited

Loading

gmitch215 commented Dec 4, 2024 •

edited

Loading