Improve instructions in CONTRIBUTING.md#2871
Open
dplyukhin wants to merge 6 commits into
Open
Conversation
Add missing gradle toolchain dependencies to the list of Java version requirements, both in CONTRIBUTING.md and mise.toml. Fix test instructions in CONTRIBUTING.md, which incorrectly state that a temporal server needs to be running during tests. Explain how to run the tests that *do* require a temporal server.
|
|
dplyukhin
commented
May 8, 2026
Quinn-With-Two-Ns
approved these changes
May 11, 2026
maciejdudko
requested changes
May 20, 2026
| - Java 23+ | ||
| - Docker to run Temporal Server | ||
| - **Java 23+** is required to run Gradle and to compile the project. | ||
| - Some tests assume you also have **Java 17 and 21** installed. |
Contributor
There was a problem hiding this comment.
I don't think this is correct? Some tests require a minimum of 17 or 21, but all of them will run fine on 23 and later too. Is there any test that doesn't?
Author
There was a problem hiding this comment.
These lines cause the build to fail unless JDK 17 and 21 toolchains are installed. It looks like we really just wanted at least 17 and 21, so I've updated those lines in the latest commit.
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
4 participants
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.
What was changed
Updated CONTRIBUTING.md and mise.toml, adding missing gradle toolchain dependencies.
Also fixed test instructions in CONTRIBUTING.md, which incorrectly state that a temporal server needs to be running during tests. Explained how to run the tests that do require a temporal server.
Why?
The project wouldn't build when following the old instructions. The instructions were also omitting some tests that require a temporal server to be running.