Skip to content

[ISSUE #11159] Fix Gradle dependency snippets that use the removed compile configuration - #11160

Open
neoLsH wants to merge 1 commit into
apache:developfrom
neoLsH:fix/gradle-compile-config-in-docs
Open

neoLsH wants to merge 1 commit into
apache:developfrom
neoLsH:fix/gradle-compile-config-in-docs

Conversation

@neoLsH

@neoLsH neoLsH commented Sep 14, 2026

Copy link
Copy Markdown

Which Issue(s) This PR Fixes

Brief Description

The Gradle snippets in the quick-start docs still use compile, which Gradle removed in 7.0. Copying them into a current build fails while the project is being evaluated, and the error reads like a method-name typo with no hint that the configuration itself is gone. Switched to implementation, which is what the Gradle upgrade guide's migration table maps compile to. The other option in that table, api, requires the java-library plugin, and these snippets are for sample applications.

The Maven blocks right above them are untouched.

How Did You Test This Change?

Docs only, no code path affected. Checked on Gradle 9.7.1 with a minimal java project: with compile the build fails with "Could not find method compile() for arguments [...] on object of type ...DefaultDependencyHandler", with implementation it succeeds and resolves rocketmq-client:5.5.0 along with its transitive dependencies from Maven Central, which also confirms the coordinates and version already in the docs are correct.

Grepped the whole tree on develop too. These are the only Gradle-style dependency declarations and the only files that mention Gradle at all, so nothing is left half-migrated.

@RockteMQ-AI RockteMQ-AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary

LGTM — straightforward and correct fix for outdated Gradle dependency syntax.

Review Notes

  • Correctness: ✅ → is the right migration path per Gradle 7.0 release notes
  • Completeness: ✅ All 3 occurrences updated (2 Chinese docs, 1 English doc)
  • Testing: ✅ Author verified with Gradle 9.7.1 and confirmed the dependency resolves correctly
  • Scope: ✅ Minimal change, no unintended side effects

The PR description is thorough and explains the rationale well. This fixes a real pain point for users following the quick-start guide with modern Gradle versions.

Thanks for the contribution!


Automated review by github-manager-bot

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc] Gradle snippets in the quick-start docs use the removed compile configuration

2 participants