Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README to include a general build section #656

Open
snicoll opened this issue Dec 16, 2024 · 1 comment
Open

Improve README to include a general build section #656

snicoll opened this issue Dec 16, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@snicoll
Copy link
Collaborator

snicoll commented Dec 16, 2024

Is your feature request related to a problem? Please describe.
Cloning this repository and then invoking ./gradlew build on my machine leads to:

FAILURE: Build failed with an exception.

* What went wrong:
A problem occurred configuring project ':native-gradle-plugin'.
> Failed to calculate the value of task ':native-gradle-plugin:compileJava' property 'javaCompiler'.
   > No matching toolchains found for requested specification: {languageVersion=11, vendor=any, implementation=vendor-specific} for MAC_OS on aarch64.
      > No locally installed toolchains match and toolchain download repositories have not been configured.

* Try:
> Learn more about toolchain auto-detection at https://docs.gradle.org/8.3/userguide/toolchains.html#sec:auto_detection.
> Learn more about toolchain repositories at https://docs.gradle.org/8.3/userguide/toolchains.html#sub:download_repositories.
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to get full insights.
> Get more help at https://help.gradle.org.

BUILD FAILED in 1s
49 actionable tasks: 15 executed, 34 from cache

I don't have any particular setup regarding the toolchain that I know of. Given that it's used, I was expecting it to either download the necessary release for me or that some instructions in the README would tell me what to do.

Describe the solution you'd like
With the help of @sdeleuze I was able to actually build quite easily by issuing a single command prior to the build:

$ sdk env install

Not everybody uses SDKMan! I suppose so it would be nice that the README would at least explain what is required and the easiest way to do so.

@snicoll snicoll added the enhancement New feature or request label Dec 16, 2024
@vjovanov
Copy link
Member

Thanks for reporting. In top-level README.md we need to point developers to the individual plugins for building instructions and mention which version of the JDK they need.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants