Skip to content

Commit f5885d5

Browse files
Copilotgewarren
andcommitted
Add breaking change documentation for dotnet list package audit source warning
Co-authored-by: gewarren <[email protected]>
1 parent e502dd9 commit f5885d5

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed

docs/core/compatibility/8.0.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ If you're migrating an app to .NET 8, the breaking changes listed here might aff
141141
| [Runtime-specific apps not self-contained](sdk/8.0/runtimespecific-app-default.md) | Source/binary incompatible |
142142
| [--arch option doesn't imply self-contained](sdk/8.0/arch-option.md) | Behavioral change |
143143
| ['dotnet restore' produces security vulnerability warnings](sdk/8.0/dotnet-restore-audit.md) | Behavioral change |
144+
| [New warning introduced in dotnet list package command](sdk/8.0/dotnet-list-package-audit-source-warning.md) | Behavioral change |
144145
| [SDK uses a smaller RID graph](sdk/8.0/rid-graph.md) | Behavioral change/Source incompatible |
145146
| [Setting DebugSymbols to false disables PDB generation](sdk/8.0/debugsymbols.md) | Behavioral change |
146147
| [Source Link included in the .NET SDK](sdk/8.0/source-link.md) | Source incompatible |
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "Breaking change: New warning introduced in dotnet list package command"
3+
description: "Learn about the breaking change in .NET 8 where dotnet list package --vulnerable emits a warning when audit sources don't support the VulnerabilityInfoResource."
4+
ms.date: 01/18/2025
5+
ai-usage: ai-assisted
6+
ms.custom: https://github.com/dotnet/docs/issues/42608
7+
---
8+
# New warning introduced in dotnet list package command
9+
10+
When using `dotnet list package --vulnerable`, if a configured `auditsources` does not support the `VulnerabilityInfoResource`, a warning is now shown to inform the user that the source does not provide vulnerability data.
11+
12+
## Version introduced
13+
14+
.NET 8
15+
16+
## Previous behavior
17+
18+
The command would silently skip `auditsource`s that lacked vulnerability information, because the command did not use `auditsources` as a source of vulnerability data.
19+
20+
## New behavior
21+
22+
The command now emits a warning:
23+
**`Audit source '{0}' did not provide any vulnerability data.`**
24+
This helps users understand why certain sources may not influence the reported vulnerabilities.
25+
26+
## Type of breaking change
27+
28+
This is a [behavioral change](../../categories.md#behavioral-change).
29+
30+
## Reason for change
31+
32+
This warning came as part of the work to allow customers to use `auditsources` when running the `dotnet list package` command. The warning helps users understand when configured audit sources are not providing the expected vulnerability information.
33+
34+
## Recommended action
35+
36+
Check the specified `auditsources` to ensure it supports the `VulnerabilityInfoResource`. If it doesn't, either update the source or replace it with one that provides vulnerability data.
37+
38+
## Affected APIs
39+
40+
None.

docs/core/compatibility/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,8 @@ items:
484484
href: sdk/8.0/dotnet-publish-config.md
485485
- name: "'dotnet restore' produces security vulnerability warnings"
486486
href: sdk/8.0/dotnet-restore-audit.md
487+
- name: New warning introduced in dotnet list package command
488+
href: sdk/8.0/dotnet-list-package-audit-source-warning.md
487489
- name: Duplicate output for -getItem, -getProperty, and -getTargetResult
488490
href: sdk/8.0/getx-duplicate-output.md
489491
- name: Implicit `using` for System.Net.Http no longer added

0 commit comments

Comments
 (0)