docs: clarify JDK 17 build requirement for contributors#1010
Open
nielspardon wants to merge 1 commit into
Open
docs: clarify JDK 17 build requirement for contributors#1010nielspardon wants to merge 1 commit into
nielspardon wants to merge 1 commit into
Conversation
Add a JDK 17 prerequisite to the README's build instructions and correct
the "Gradle & JDK 17" section in CONTRIBUTING.md.
The previous CONTRIBUTING instructions asked contributors to copy
`--add-exports` flags into `~/.gradle/gradle.properties`, but those flags
are already committed to the project's own `gradle.properties`, making the
step redundant. The stated reason ("uses JDK 17 features") was also
outdated: compile and test tasks are pinned to a Java 17 toolchain and run
under any launching JDK, while Spotless's google-java-format is what
actually requires the Gradle daemon to run on JDK 17.
Closes substrait-io#116
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.
Adds a JDK 17 prerequisite to the README's build instructions and corrects the "Gradle & JDK 17" section in
CONTRIBUTING.md.The previous CONTRIBUTING instructions asked contributors to copy
--add-exportsflags into~/.gradle/gradle.properties, but those flags are already committed to the project's owngradle.properties, making the step redundant. The stated reason ("uses JDK 17 features") was also outdated: compile and test tasks are pinned to a Java 17 toolchain and run under any launching JDK, while Spotless'sgoogle-java-formatis what actually requires the Gradle daemon to run on JDK 17.Docs-only change; no build files touched.
Closes #116
🤖 Generated with AI