-
Notifications
You must be signed in to change notification settings - Fork 13.7k
[hotfix][docs] Update build documentation to require Java 17 #26773
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
base: master
Are you sure you want to change the base?
Conversation
… builds Signed-off-by: Thomas Cooper <[email protected]>
@@ -33,7 +33,7 @@ This page covers how to build Flink {{< version >}} from sources. | |||
|
|||
In order to build Flink you need the source code. Either [download the source of a release]({{< downloads >}}) or [clone the git repository]({{< github_repo >}}). | |||
|
|||
In addition you need **Maven 3.8.6** and a **JDK** (Java Development Kit). Flink requires **Java 11** to build. | |||
In addition you need **Maven 3.8.6** and a **JDK** (Java Development Kit). Flink requires **Java 17** to build. |
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.
We support the minimum of 11 but recommend 17. I suggest using words like this rather than requires 17
.
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.
The commands listed on this page require Java 17. Previously, we supported Java 8 via a profile in the root pom but we stated here that it requires 11, so this statement is consistent.
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.
My first build failed using 11 following the instructions on this page. I think we should recommend 17 as the default and put a note here about how to support 11.
The README correctly states that JDK 17 is the default for building Flink. However, the build instructions in the docs still state Java 11 is required. The default build commands will fail (without the correct profile being set) on Java 11. This PR updates the docs to state Java 17 is required.
Documentation