Skip to content

Commit f598c3c

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

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
@@ -146,6 +146,10 @@ according to your preferences.
146146
- **Proxy Configuration** :
147147
<br >From IntelliJ IDEA Appearance & Behavior > System Settings > HTTP Proxy, you can configure a 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`
148148

149+
- **Manifest Exclusion Patterns** :
150+
<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.
151+
<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.
152+
149153
## Features
150154

151155
- **Component analysis**
@@ -290,6 +294,18 @@ according to your preferences.
290294
You can create an alternative file to `requirements.txt`, for example, a `requirements-dev.txt` or
291295
a `requirements-test.txt` file where you can add the development or test dependencies there.
292296

297+
298+
- **Excluding manifest files with patterns**
299+
<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.
300+
<br >Patterns are configured in the plugin settings under **Tools > Red Hat Dependency Analytics > Manifest Exclusion Patterns**.
301+
<br >Examples of exclusion patterns:
302+
- `**/node_modules/**/package.json` - Excludes all package.json files in node_modules directories
303+
- `test/**/pom.xml` - Excludes all Maven pom.xml files in test directories
304+
- `vendor/**/*.go.mod` - Excludes all go.mod files in vendor directories
305+
- `**/build.gradle` - Excludes all Gradle build files
306+
<br >Right-click on any manifest file and select **Exclude from Component Analysis** to quickly add an exclusion pattern for that specific file.
307+
308+
293309
- **Red Hat Dependency Analytics report**
294310
<br >The Red Hat Dependency Analytics report is a temporary HTML file that exist if the **Red Hat Dependency Analytics
295311
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
@@ -170,6 +170,14 @@
170170
<br>You can set the vulnerability severity alert level to <code>Error</code> or <code>Warning</code> for inline
171171
notifications of detected vulnerabilities.
172172
</li>
173+
<li>
174+
<b>Manifest Exclusion Patterns</b>:
175+
<br>You can exclude manifest files from component analysis using glob patterns. This is useful for excluding
176+
third-party dependencies, test files, or other manifests that should not be analyzed.
177+
<br>Enter one pattern per line. Examples: <code>**/node_modules/**/package.json</code> to exclude all
178+
package.json files in node_modules directories, or <code>test/**/pom.xml</code> to exclude all Maven files
179+
in test directories.
180+
</li>
173181
</ul>
174182
<p>
175183
@@ -328,6 +336,18 @@
328336
Analytics Report</b> tab remains open.
329337
<br>Closing the tab removes the temporary HTML file.
330338
</li>
339+
<li>
340+
<b>Excluding manifest files with patterns</b>
341+
<br>You can exclude specific manifest files from component analysis using configurable glob patterns. This
342+
feature allows you to avoid analyzing third-party dependencies, test files, or other manifests that are not
343+
relevant to your security analysis.
344+
<br>Patterns are configured in the plugin settings under <b>Tools > Red Hat Dependency Analytics > Manifest
345+
Exclusion Patterns</b>.
346+
<br>Examples: <code>**/node_modules/**/package.json</code>, <code>test/**/pom.xml</code>,
347+
<code>vendor/**/*.go.mod</code>
348+
<br>Right-click on any manifest file and select <b>Exclude from Component Analysis</b> to quickly add an
349+
exclusion pattern for that specific file.
350+
</li>
331351
</ul>
332352
<p>
333353

0 commit comments

Comments
 (0)