-
Notifications
You must be signed in to change notification settings - Fork 546
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
Update get_started.md #724
base: gh-pages-source
Are you sure you want to change the base?
Conversation
Adding details about the versions of the JDK and Gradle that are needed to build successfully.
* [Run the Examples](#run-the-examples) | ||
* [API](#api) | ||
* [Code Generator](#code-generator) | ||
|
||
## Setup | ||
|
||
JDK: You will need a Java 1.8 JDK to build the code. Using Java 1.9 or later will fail because Rest.li uses some APIs that were deprecated in 1.9 and the build treats warnings as error in order to ensure high code quality. On Linux systems openjdk-8-jdk is known to work. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately this is not entirely true. Certain version of openJDK 11 on linux can work as well. We mostly heard build failures only in MAC.
Maybe this should be one of the FAQ sections to suggest if build failed,try reverting back to java 1.8 :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be useful to warn people up front that they likely need to use an older version of Java. My first try was with openjdk 14 on Linux and it failed. Is there a recommended version to use? Is it expected to build and work with newer versions like 14 (default on Ubuntu) or 17 (default when downloading from Oracle)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No problem, we can keep it here in this section for now. My point is just to say Java1.9's later version might still build.
Personally this is my java version, seems to work.
openjdk version "11.0.11" 2021-04-20 LTS
OpenJDK Runtime Environment 18.9 (build 11.0.11+9-LTS)
OpenJDK 64-Bit Server VM 18.9 (build 11.0.11+9-LTS, mixed mode, sharing
Adding details about the versions of the JDK and Gradle that are needed to build successfully.