Skip to content

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

Description

@neoLsH

Search before creation

  • I had searched in the issues and found no similar issues.

Documentation Related

The quick-start docs give the Gradle dependency as:

compile 'org.apache.rocketmq:rocketmq-client:5.5.0'

Gradle removed the compile configuration in 7.0, so this no longer works. Reproduced on Gradle 9.7.1 with an otherwise empty java project:

* What went wrong:
A problem occurred evaluating root project '...'.
> Could not find method compile() for arguments [org.apache.rocketmq:rocketmq-client:5.5.0] on object of type org.gradle.api.internal.artifacts.dsl.dependencies.DefaultDependencyHandler.

The error doesn't hint at the cause. Gradle's own suggestions are just --stacktrace / --info / --scan, and it fails while evaluating the project, so it reads like a method-name typo rather than a removed configuration. Swapping in implementation builds fine and resolves rocketmq-client:5.5.0 along with its transitive dependencies from Maven Central, so the coordinates and the version in the docs are correct and only the configuration name is stale.

Affected files:

  • docs/en/Example_Simple.md
  • docs/cn/Example_Simple_cn.md
  • docs/cn/RocketMQ_Example.md

The Maven blocks right above them are fine. Since the repo builds with Maven and Bazel only, no CI job ever looks at these snippets, which is probably how it drifted.

I checked the in-flight docs PRs first. #10436 and #10409 both touch these same lines, but they only bump the version number inside the snippet and keep compile, so this doesn't overlap with them.

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions