Repository navigation
Say that GradleProject defaults to the shared TestKit directory - #835
Merged
Merged
Conversation
From ToolBase `2.0.0-SNAPSHOT.460`, `withSharedTestKitDirectory()` uses `caches/spine-testkit` under the Gradle user home when given no directory. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Contributor
There was a problem hiding this comment.
🟢 Approved
There are no active review issues for this documentation-only update to the shared TestKit directory convention.
No open issues 🎉
What changed in this PR
Updates the KDoc for useSharedTestKitDir() to document ToolBase’s shared TestKit directory convention. No runtime behavior changes.
Changes:
- Documents the directory change from
.gradle-test-kittocaches/spine-testkitunder Gradle user home, starting with ToolBase2.0.0-SNAPSHOT.460. - Notes that
SHARED_TESTKIT_DIRmust stay aligned with the path computed byGradleProject.
| File | Description |
|---|---|
buildSrc/src/main/kotlin/io/spine/gradle/testing/TestKitDir.kt |
Adds KDoc explaining the shared directory default and synchronization requirement. |
Review effort: Balanced
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
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.
Summary
Adds a note to the KDoc of
useSharedTestKitDir(). Starting from ToolBase2.0.0-SNAPSHOT.460(SpineEventEngine/tool-base#207), theGradleProjectAPI ofplugin-testlibusescaches/spine-testkitunder the Gradle user home as the default for a project set up withwithSharedTestKitDirectory(). Earlier versions put that directory under the repository root, in.gradle-test-kit.GradleProjectcomputes the path itself, from the Gradle user home that the test JVM sees, so the note asks to keepSHARED_TESTKIT_DIRin sync with it.KDoc only; no behaviour changes. If tool-base#207 merges at a version other than
.460, the version in the note should follow it.Test plan
./gradlew :buildSrc:build detekt🤖 Generated with Claude Code