From 6b9e6ddd4cb096fe7f5757a22f9cfadcae098775 Mon Sep 17 00:00:00 2001 From: Sebastian Schuberth Date: Tue, 3 Sep 2024 12:15:59 +0200 Subject: [PATCH] docs(gradle-inspector): Update the list of known limitations Format limitations as a list and add [1]. [1]: https://github.com/oss-review-toolkit/ort/issues/7995 Signed-off-by: Sebastian Schuberth --- plugins/package-managers/gradle-inspector/README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/plugins/package-managers/gradle-inspector/README.md b/plugins/package-managers/gradle-inspector/README.md index e8c42a0c96bd6..904406e2d756f 100644 --- a/plugins/package-managers/gradle-inspector/README.md +++ b/plugins/package-managers/gradle-inspector/README.md @@ -31,11 +31,13 @@ Execution of the Gradle plugin will be blocked until the remote debugger is atta ## Limitations -The retrieval of the checksum values for remote artifacts is currently done via plain OkHttp calls, which means it will not work out of the box for private repositories. -To work around this, credentials need to be configured in `.netrc` additionally to in Gradle. -This is similar to how the "legacy" [Gradle] analyzer required to additionally configure credentials in Maven. +Currently, the [GradleInspector] has the following known limitations: -Also, the `isModified` check which compares with artifacts of the same name in Maven Central is not implemented yet. +* The retrieval of the checksum values for remote artifacts is currently done via plain OkHttp calls, which means it will not work out of the box for private repositories. + To work around this, credentials need to be configured in `.netrc` additionally to in Gradle. + This is similar to how the "legacy" [Gradle] analyzer required to additionally configure credentials in Maven. +* The `isModified` check which compares with artifacts of the same name in Maven Central is not implemented yet. +* The implementation [cannot deal with classifiers and / or non-JAR artifacts]. [GradleInspector]: ./src/main/kotlin/GradleInspector.kt [several]: https://github.com/oss-review-toolkit/ort/issues/4694 @@ -46,3 +48,4 @@ Also, the `isModified` check which compares with artifacts of the same name in M [Gradle plugin]: ../gradle-plugin/src/main/kotlin/OrtModelPlugin.kt [OrtModelBuilder]: ../gradle-plugin/src/main/kotlin/OrtModelBuilder.kt [data model for Gradle projects]: ../gradle-model/src/main/kotlin/GradleModel.kt +[cannot deal with classifiers and / or non-JAR artifacts]: https://github.com/oss-review-toolkit/ort/issues/7995