Skip to content

Commit 6028809

Browse files
committed
Add documentation for Nuget Inspector Enhancement
1 parent 725ac23 commit 6028809

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

documentation/src/main/markdown/currentreleasenotes.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
### New features
1515

16-
*
16+
* (IDETECT-2437, IDETECT-4547) Added support for ArtifactsPath and BaseIntermediateOutputPath properties in [detect_product_long] Nuget Inspector.
1717

1818
### Changed features
1919

@@ -22,3 +22,7 @@
2222
### Resolved issues
2323

2424
*
25+
26+
### Dependency updates
27+
28+
* Released and Upgraded Nuget Inspector to version 2.1.0.

documentation/src/main/markdown/packagemgrs/nuget.md

+9
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ This property supports exclusion of dependencies in projects that use PackageRef
3030
A project might be using a dependency purely as a development harness and you might not want to expose that to projects that will consume the package. You can use the PrivateAssets metadata to control this behavior. [detect_product_short] looks for the PrivateAssets attribute used within PackageReference tags to identify a development dependency. [detect_product_short] will ignore the contents of the tag and only observe the presence of these PrivateAssets to exclude those development related dependencies.
3131
For packages.config file, [detect_product_short] will look for developmentDependency tags to determine whether to include or exclude a dependency.
3232

33+
## Nuget Artifacts Path and Base Intermediate Output Path
34+
[detect_product_short] supports the ArtifactsPath and BaseIntermediateOutputPath properties provided by Nuget to customise the path in which build artifacts are stored. The default location for storing the artifacts is \obj folder under each project directory in which xml file for the project such as csproj is present.
35+
36+
To simplify the output paths and gather all the artifacts in a common location, the above properties were introduced. To support these properties, [detect_product_short] introduced a property [detect.nuget.artifacts.path](../properties/detectors/nuget.md#nuget-artifacts-path) which you can provide to look for project.assets.json in a custom location.
37+
38+
<note type="note">[detect_product_short] is aware that these properties can be found in Directory.Build.props file, but to solve the problem of .NET 6 requirement to get the resolved artifacts path, it is required that users provide with appropriate permissions in which artifacts are stored via this property.</note>
39+
40+
[detect_product_short] will crawl through all the directories in the provided path to find the project.assets.json file for the project being scanned.
41+
3342
### [detect_product_short] NuGet Inspector downloads
3443

3544
[detect_product_short] jar execution will automatically download any required binaries not located in the cache.

0 commit comments

Comments
 (0)