docs: correct the documented minimum Java version - #137
Open
aymenmehri wants to merge 1 commit into
Open
Conversation
The README states that Java 8 or higher is required, but the project has not been buildable on Java 8 for some time: maven-compiler-plugin is configured with <release>11</release>, and the integration workflow only ever exercises Java 11, 17 and 21. A user on Java 8 hits a compilation failure with no indication that the documented requirement is wrong. Correct the stated minimum to Java 11 and align the javadoc plugin, which was still pinned to <source>1.8</source> while the compiler targeted 11. Also bump the version in the installation snippet from 4.1.0 to 4.1.2 to match the latest release.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Corrects the documented minimum Java version and the one build setting that was inconsistent with it.
README.md: minimum requirementJava 8→Java 11.pom.xml:maven-javadoc-plugin<source>1.8</source>→<source>11</source>, aligning it with the compiler's<release>11</release>.README.md: installation snippet4.1.0→4.1.2to match the latest release.Related Issue
Closes #136
Motivation and Context
The README tells users that Java 8 or higher is enough, but the project has not been buildable or consumable on Java 8 for some time:
pom.xmlsetsmaven-compiler-pluginto<release>11</release>, so the published artifact is class file major version 55..github/workflows/integration.ymlonly ever runs the matrix against Java 11, 17 and 21.A user on Java 8 therefore hits a compilation failure with no hint that the documented requirement is stale. The javadoc plugin was still pinned to
<source>1.8</source>, a leftover from the same migration.No supported configuration changes here — this documents what the build already enforces.
A note on the
4.1.0→4.1.2bump in the installation snippet: nothing in.releaserc.jsonupdates the README, so this number appears to drift manually between releases. Happy to drop that hunk if you would rather keep it out of a docs fix, or to wire the README into the release config in a separate PR if that is preferable.How Has This Been Tested?
Locally on Temurin 21.0.11 / Maven 3.9.16:
mvn spotless:check test— BUILD SUCCESS, 18/18 tests pass, no formatting violations.mvn javadoc:javadoc— BUILD SUCCESS with the updated<source>11</source>.Documentation:
The README change is itself the documentation update.
Checklist: