Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docs for NuGetAuditSuppress #3309

Merged
merged 3 commits into from
Jun 22, 2024
Merged

Add docs for NuGetAuditSuppress #3309

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9829c91
Add NuGetAuditSuppress
advay26 Jun 19, 2024
1b5cb3f
nit: wording
advay26 Jun 19, 2024
3ae2e1c
address feedback
advay26 Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/concepts/Auditing-Packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,21 @@ We recommend that audit is configured at a repository level.

### Excluding advisories

There is no support for excluding individual advisories at this time.
You can choose to exclude specific advisories from the audit report by adding a new `NuGetAuditSuppress` MSBuild item for each advisory.
Define a `NuGetAuditSuppress` item with the `Include=` metadata set to the advisory URL you wish to suppress.

```xml
<ItemGroup>
<NuGetAuditSuppress Include="https://github.com/advisories/XXXX" />
zivkan marked this conversation as resolved.
Show resolved Hide resolved
</ItemGroup>
```

Similar to the other NuGet audit configuration properties, `NuGetAuditSuppress` items can be defined at the project or repository level.

`NuGetAuditSuppress` is available for PackageReference projects starting from NuGet 6.11, Visual Studio 17.11, and the .NET 8.0.400 SDK.
It is not currently available for packages.config projects.

Additionally, you have the option to suppress warnings based on their severity.
You can use `<NoWarn>` to suppress `NU1901`-`NU1904` warnings or use the `<NuGetAuditLevel>` functionality to ensure your audit reports are useful to your workflow.

### Warning codes
Expand Down