From afd01cdd1b1ed5455364f761ee1d5b3cf2bdfa21 Mon Sep 17 00:00:00 2001 From: Zvi Grinberg Date: Mon, 5 Aug 2024 08:58:32 +0300 Subject: [PATCH] docs: add documentation for gradle Signed-off-by: Zvi Grinberg --- README.md | 26 ++++++++++++++++++++++++-- src/main/resources/META-INF/plugin.xml | 2 ++ 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4802c5e7..6aea2e56 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ Dependency Analytics only accesses your manifest files to analyze your applicati vulnerability report. **IMPORTANT:** -
Currently, Dependency Analytics only supports projects that use Maven (`mvn`), Node (`npm`), Golang (`go mod`) and -Python (`pip`) ecosystems, and base images in `Dockerfile`. +
Currently, Dependency Analytics only supports projects that use Maven (`mvn`), Node (`npm`), Golang (`go mod`), +Python (`pip`) and Gradle (`gradle`) ecosystems, and base images in `Dockerfile`. In future releases, Red Hat plans to support other programming languages. ##### Table of Contents @@ -110,6 +110,12 @@ according to your preferences. specified in the manifest file will be ignored, and dependency versions will be resolved dynamically instead (this feature cannot be enabled when `Strictly match package version` is selected). +- **Gradle** : +
Set the full path of the Gradle executable, which allows Exhort to locate and execute the `gradle` command to resolve + dependencies for Gradle projects. +
By not setting a path to the gradle binary, IntelliJ IDEA uses its default path environment to locate the file. + + - **Image** :
Set the full path of the Syft executable, which allows Exhort to locate and execute the `syft` command to generate Software Bill of Materials for the base images. @@ -220,6 +226,13 @@ according to your preferences. ```text requests==2.28.1 # exhortignore ``` + If you want to ignore vulnerabilities for a dependency in a `build.gradle` file, you must add `exhortignore` as a + comment against the dependency in the manifest file. + For example: + ```text + implementation "log4j:log4j:1.2.17" // exhortignore + implementation group: 'log4j', name: 'log4j', version: '1.2.17' // exhortignore + ``` - **Excluding developmental or test dependencies**
Red Hat Dependency Analytics does not analyze dependencies marked as `dev` or `test`, these dependencies are @@ -288,8 +301,17 @@ Read our [privacy statement](https://developers.redhat.com/article/tool-data-col This plugin respects the settings of the `Telemetry by Red Hat` plugin, which you can learn more about [here](https://plugins.jetbrains.com/plugin/16209-telemetry-by-red-hat). + ## Support, feedback & questions +The Red Hat Dependency Analytics plugin for IntelliJ IDEA in current version, supports the following IntelliJ IDEA versions: + - 2022.1 + - 2022.2 + - 2022.3 + - 2023.1 + - 2023.2 + - 2023.3 + There are two ways you can contact us: - You can reach out to us at `rhda-support@redhat.com` with any questions, feedback, and general support. diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml index 1309b245..8c2aa98e 100644 --- a/src/main/resources/META-INF/plugin.xml +++ b/src/main/resources/META-INF/plugin.xml @@ -364,6 +364,8 @@ ]]> 1.1.0

+

Added support for Gradle manifest files.

1.0.0

Added support for base image vulnerability scanning in Dockerfiles.

Bumped Telemetry plugin to 1.1.0.