Skip to content

[REQ] Java client: Generated README.md file refers to deprecated 'compile' task #10526

@sebastien-rosset

Description

@sebastien-rosset

Is your feature request related to a problem? Please describe.

The generated README.md file for the Java client has the following text:

compile "{{{groupId}}}:{{{artifactId}}}:{{{artifactVersion}}}"

As indicated at https://docs.gradle.org/6.5/userguide/java_plugin.html and https://tomgregory.com/gradle-implementation-vs-compile-dependencies/, the compile task is deprecated. It is superseded by implementation. We should not recommend using deprecated features.

Describe the solution you'd like

How about generating a README file with the following content?

  // Your build.gradle should specify the repositories where the '{{{artifactId}}}' jar has been published.
  repositories {
    mavenCentral()    // Needed if the '{{{artifactId}}}' jar has been published to maven central.
    mavenLocal()       // Needed if the ''{{{artifactId}}}'' jar has been published to the local maven repo.
  }
  dependencies {
     implementation "{{{groupId}}}:{{{artifactId}}}:{{{artifactVersion}}}"
  }

Describe alternatives you've considered

Additional context

Dependency Management for Java projects in gradle:
https://docs.gradle.org/current/userguide/java_plugin.html#sec:java_plugin_and_dependency_management

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions