Skip to content

Commit b35967a

Browse files
committed
docs: update readme and change-notes.
Signed-off-by: Chao Wang <[email protected]>
1 parent 51e3b0b commit b35967a

File tree

2 files changed

+35
-10
lines changed

2 files changed

+35
-10
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,16 @@
1313
Red Hat Dependency Analytics (RHDA) plugin gives you awareness to security concerns within your software supply chain
1414
while you build your application.
1515

16-
<br >Dependency Analytics only supports the following project ecosystems:
17-
- Maven
18-
- Node
19-
- Golang
20-
- Python
21-
- Gradle
16+
<br>Dependency Analytics supports multiple package managers:
17+
- Maven (mvn)
18+
- NPM (npm)
19+
- PNPM (pnpm)
20+
- Yarn Berry and Classic (yarn)
21+
- Gradle Kotlin and Groovy (gradle)
22+
- Golang (go mod)
23+
- Python (pip) ecosystems, and base images in Dockerfile.
24+
25+
In future releases, Red Hat plans to support other package managers.
2226

2327
<br >**NOTE:**
2428
The Red Hat Dependency Analytics plugin is an online service hosted and maintained by Red Hat.

src/main/resources/META-INF/plugin.xml

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,15 @@
2020
displaying the vulnerability report.
2121
<p>
2222
<b>IMPORTANT:</b>
23-
<br>Currently, Dependency Analytics only supports projects that use Maven (<code>mvn</code>), and Node
24-
(<code>npm</code>, <code>pnpm</code> or <code>yarn</code>), Golang (<code>go mod</code>) and Python (<code>pip</code>) ecosystems, and base images in
25-
<code>Dockerfile</code>.
26-
<br>In future releases, Red Hat plans to support other programming languages.
23+
<br>Dependency Analytics supports multiple package managers:
24+
<li>Maven (mvn)</li>
25+
<li>NPM (npm)</li>
26+
<li>PNPM (pnpm)</li>
27+
<li>Yarn Berry and Classic (yarn)</li>
28+
<li>Gradle Kotlin and Groovy (gradle)</li>
29+
<li>Golang (go mod)</li>
30+
<li>Python (pip) ecosystems, and base images in Dockerfile.</li>
31+
<br>In future releases, Red Hat plans to support other package managers.</br>
2732
<p>
2833
2934
<h2>Quick Start</h2>
@@ -42,6 +47,9 @@
4247
<li>For Python projects, analyzing a <code>requirements.txt</code> file, you must have the <code>python3</code> and
4348
<code>pip3</code> binaries in your IDE's <code>PATH</code> environment.
4449
</li>
50+
<li>
51+
For Gradle projects, analyzing a <code>build.gradle</code> file, you must have the <code>gradle</code> binary in your system's <code>PATH</code> environment.
52+
</li>
4553
<li>For base images, analyzing a <code>Dockerfile</code>, you must have the <code><a
4654
href="https://github.com/anchore/syft?tab=readme-ov-file#installation" rel="noopener noreferrer"
4755
target="_blank">syft</a></code> and
@@ -142,6 +150,13 @@
142150
dynamically instead. This feature cannot be enabled when <code>Strictly match package version</code> is
143151
selected.
144152
</li>
153+
<li>
154+
<b>Gradle</b>:
155+
<br>Set the full path of the Gradle executable, which allows Exhort to locate and run the <code>gradle</code>
156+
command to resolve dependencies for Gradle projects.
157+
<br>By not setting a path to the gradle binary, IntelliJ IDEA uses its default path environment to locate
158+
the file.
159+
</li>
145160
<li>
146161
<b>Image</b>:
147162
<br>Set the full path of the Syft executable, which allows Exhort to locate and execute the <code>syft</code>
@@ -376,6 +391,12 @@
376391
<change-notes><![CDATA[
377392
<p><b>1.1.0</b></p>
378393
<p>Added support for Gradle manifest files.</p>
394+
<p>Added support for Yarn.</p>
395+
<p>Added support for PNPM.</p>
396+
<p>Added support for Proxy setting.</p>
397+
<p>Enable using the Maven Wrapper.</p>
398+
<p>No restart needed after installation.</p>
399+
<p>Opening and analysing a single package.json file in editor is not supposed anymore.</p>
379400
<p><b>1.0.0</b></p>
380401
<p>Added support for base image vulnerability scanning in Dockerfiles.</p>
381402
<p>Bumped Telemetry plugin to 1.1.0.</p>

0 commit comments

Comments
 (0)