Skip to content

[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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tomncooper
Copy link
Contributor

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

  • Does this pull request introduce a new feature? no

@flinkbot
Copy link
Collaborator

flinkbot commented Jul 9, 2025

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

@github-actions github-actions bot added the community-reviewed PR has been reviewed by the community. label Jul 10, 2025
@@ -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.
Copy link
Contributor

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.

Copy link
Contributor Author

@tomncooper tomncooper Jul 10, 2025

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.

Copy link
Contributor

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.

@github-actions github-actions bot added community-reviewed PR has been reviewed by the community. and removed community-reviewed PR has been reviewed by the community. labels Jul 10, 2025
@github-actions github-actions bot added community-reviewed PR has been reviewed by the community. and removed community-reviewed PR has been reviewed by the community. labels Jul 18, 2025
@github-actions github-actions bot added community-reviewed PR has been reviewed by the community. and removed community-reviewed PR has been reviewed by the community. labels Jul 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-reviewed PR has been reviewed by the community.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants