Skip to content

Commit e83568d

Browse files
committed
feat: add feature descritpion and examples to README.md and plugin.xml
Signed-off-by: Chao Wang <[email protected]>
1 parent 5fffb5d commit e83568d

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,10 @@ according to your preferences.
150150
- **Proxy Configuration** :
151151
<br >From IntelliJ IDEA Appearance & Behavior > System Settings > HTTP Proxy, you can configure a static proxy for all HTTP requests made by the plugin. This is useful when your environment requires going through a proxy to access external services. For example:`http://proxy.example.com:8080`
152152

153+
- **Manifest Exclusion Patterns** :
154+
<br >You can exclude manifest files from component analysis using glob patterns. This is useful for excluding third-party dependencies, test files, or other manifests that should not be analyzed.
155+
<br >Enter one pattern per line. Examples: `**/node_modules/**/package.json` to exclude all package.json files in node_modules directories, or `test/**/pom.xml` to exclude all Maven files in test directories.
156+
153157
## Features
154158

155159
- **Component analysis**
@@ -294,6 +298,18 @@ according to your preferences.
294298
You can create an alternative file to `requirements.txt`, for example, a `requirements-dev.txt` or
295299
a `requirements-test.txt` file where you can add the development or test dependencies there.
296300

301+
302+
- **Excluding manifest files with patterns**
303+
<br >You can exclude specific manifest files from component analysis using configurable glob patterns. This feature allows you to avoid analyzing third-party dependencies, test files, or other manifests that are not relevant to your security analysis.
304+
<br >Patterns are configured in the plugin settings under **Tools > Red Hat Dependency Analytics > Manifest Exclusion Patterns**.
305+
<br >Examples of exclusion patterns:
306+
- `**/node_modules/**/package.json` - Excludes all package.json files in node_modules directories
307+
- `test/**/pom.xml` - Excludes all Maven pom.xml files in test directories
308+
- `vendor/**/*.go.mod` - Excludes all go.mod files in vendor directories
309+
- `**/build.gradle` - Excludes all Gradle build files
310+
<br >Right-click on any manifest file and select **Exclude from Component Analysis** to quickly add an exclusion pattern for that specific file.
311+
312+
297313
- **Red Hat Dependency Analytics report**
298314
<br >The Red Hat Dependency Analytics report is a temporary HTML file that exist if the **Red Hat Dependency Analytics
299315
Report** tab remains open.

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,14 @@
186186
<br>You can set the vulnerability severity alert level to <code>Error</code> or <code>Warning</code> for inline
187187
notifications of detected vulnerabilities.
188188
</li>
189+
<li>
190+
<b>Manifest Exclusion Patterns</b>:
191+
<br>You can exclude manifest files from component analysis using glob patterns. This is useful for excluding
192+
third-party dependencies, test files, or other manifests that should not be analyzed.
193+
<br>Enter one pattern per line. Examples: <code>**/node_modules/**/package.json</code> to exclude all
194+
package.json files in node_modules directories, or <code>test/**/pom.xml</code> to exclude all Maven files
195+
in test directories.
196+
</li>
189197
</ul>
190198
<p>
191199
@@ -344,6 +352,18 @@
344352
Analytics Report</b> tab remains open.
345353
<br>Closing the tab removes the temporary HTML file.
346354
</li>
355+
<li>
356+
<b>Excluding manifest files with patterns</b>
357+
<br>You can exclude specific manifest files from component analysis using configurable glob patterns. This
358+
feature allows you to avoid analyzing third-party dependencies, test files, or other manifests that are not
359+
relevant to your security analysis.
360+
<br>Patterns are configured in the plugin settings under <b>Tools > Red Hat Dependency Analytics > Manifest
361+
Exclusion Patterns</b>.
362+
<br>Examples: <code>**/node_modules/**/package.json</code>, <code>test/**/pom.xml</code>,
363+
<code>vendor/**/*.go.mod</code>
364+
<br>Right-click on any manifest file and select <b>Exclude from Component Analysis</b> to quickly add an
365+
exclusion pattern for that specific file.
366+
</li>
347367
</ul>
348368
<p>
349369

0 commit comments

Comments
 (0)