Fix Gradle dependency and Java syntax in client-java guide#1285
Fix Gradle dependency and Java syntax in client-java guide#1285
Conversation
|
|
📝 WalkthroughWalkthroughThe documentation for the Java client is updated to reflect the correct Gradle dependency configuration, changing Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
site/src/sphinx/client-java.rst (1)
582-582:⚠️ Potential issue | 🟡 MinorApply the same Gradle configuration fix here for consistency.
This line still uses the deprecated
compileconfiguration, which is inconsistent with the fix applied at line 23. All Gradle dependency examples in the documentation should useimplementationinstead ofcompileto avoid build errors in modern Gradle versions.📝 Proposed fix
- compile 'com.linecorp.centraldogma:centraldogma-client-spring-boot3-starter:\ |release|\ ' + implementation 'com.linecorp.centraldogma:centraldogma-client-spring-boot3-starter:\ |release|\ '🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@site/src/sphinx/client-java.rst` at line 582, Replace the deprecated Gradle configuration used in the dependency declaration "compile 'com.linecorp.centraldogma:centraldogma-client-spring-boot3-starter:|release| '" by changing the configuration keyword from compile to implementation so the example matches the other fix and modern Gradle usage; update the dependency line in the client-java.rst example to use implementation instead of compile.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@site/src/sphinx/client-java.rst`:
- Line 582: Replace the deprecated Gradle configuration used in the dependency
declaration "compile
'com.linecorp.centraldogma:centraldogma-client-spring-boot3-starter:|release| '"
by changing the configuration keyword from compile to implementation so the
example matches the other fix and modern Gradle usage; update the dependency
line in the client-java.rst example to use implementation instead of compile.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 896a5108-87e8-49db-bc2d-a1518f3c9813
📒 Files selected for processing (1)
site/src/sphinx/client-java.rst
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1285 +/- ##
============================================
+ Coverage 68.82% 68.91% +0.09%
- Complexity 4730 5393 +663
============================================
Files 483 531 +48
Lines 20413 22937 +2524
Branches 2293 2582 +289
============================================
+ Hits 14050 15808 +1758
- Misses 5122 5694 +572
- Partials 1241 1435 +194 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Motivation:
The current client-java.html documentation contains outdated Gradle configuration and a syntax error in the Java code example.
Modifications:
Updated the Gradle dependency example to use implementation instead of the deprecated compile.
Removed the misplaced semicolon before the .build() method call in the Java code snippet.
Result:
Users can now follow the Java client guide without encountering compilation errors in either their Gradle build scripts or their Java source code.