Skip to content

Commit 665e868

Browse files
committed
CI: suppress XML doc comment warnings and cosmetic build noise
NumSharp generates ~7,600 noisy build warnings that get picked up by GitHub Actions' MSBuild problem matcher and displayed as annotations, drowning out real issues. This adds -p:NoWarn to all build/pack steps via a centralized DOTNET_NOWARN env var. Uses %3B (URL-encoded semicolons) because MSBuild CLI treats raw ; and , as property separators — a known MSBuild quoting issue. Suppressed warning categories: XML doc warnings (~7,200 instances — 83% of all warnings): - CS1570: Badly formed XML in doc comments - CS1571: Duplicate param tag - CS1572: Param tag for non-existent parameter - CS1573: Missing param tag - CS1574: Unresolvable cref - CS1587: XML comment not placed on valid element - CS1591: Missing XML comment on public type/member - CS1711: Typeparam for non-existent param - CS1734: Paramref refers to non-existent param Other cosmetic noise: - CS8981: Type name only contains lowercase chars (360 instances) — intentional for NumPy API compatibility (class 'np') - NU5048: PackageIconUrl deprecated (2 instances) Preserved warnings (still visible in CI): - CS0162: Unreachable code (860) - CS0168/CS0219: Unused variables (128) - CA1416: Platform compatibility (380) - CS0109/CS0628/CS0659/CS0661/CS0693: Miscellaneous code issues
1 parent 5cb2fa9 commit 665e868

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

.github/workflows/build-and-release.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ on:
1111
permissions: write-all
1212

1313
env:
14+
# Suppress noisy build warnings that clutter CI annotations.
15+
# Uses %3B (URL-encoded semicolon) because MSBuild CLI treats raw ; and , as property separators.
16+
# XML doc warnings (CS15xx, CS17xx): ~7,200 of ~8,700 total — malformed/missing doc comments
17+
# CS8981: 'np' only contains lowercase chars — intentional for NumPy API compat
18+
# NU5048: PackageIconUrl deprecated — cosmetic NuGet warning
19+
DOTNET_NOWARN: CS1570%3BCS1571%3BCS1572%3BCS1573%3BCS1574%3BCS1587%3BCS1591%3BCS1711%3BCS1734%3BCS8981%3BNU5048
20+
1421
# Exclude known-failing test classes and specific test methods from CI.
1522
# These are pre-existing bugs tracked in OpenBugs.cs and related test files.
1623
# When a bug is fixed, remove its exclusion here so CI catches regressions.
@@ -60,7 +67,7 @@ jobs:
6067
dotnet-quality: 'preview'
6168

6269
- name: Build
63-
run: dotnet build test/NumSharp.UnitTest/NumSharp.UnitTest.csproj --configuration Release
70+
run: dotnet build test/NumSharp.UnitTest/NumSharp.UnitTest.csproj --configuration Release -p:NoWarn=${{ env.DOTNET_NOWARN }}
6471

6572
- name: Test
6673
run: dotnet test test/NumSharp.UnitTest/NumSharp.UnitTest.csproj --configuration Release --no-build --verbosity normal --logger trx --filter "${{ env.TEST_FILTER }} ${{ matrix.extra_filter }}"
@@ -105,6 +112,7 @@ jobs:
105112
run: |
106113
dotnet build src/NumSharp.Core/NumSharp.Core.csproj \
107114
--configuration Release \
115+
-p:NoWarn=${{ env.DOTNET_NOWARN }} \
108116
-p:Version=${{ steps.version.outputs.VERSION }} \
109117
-p:AssemblyVersion=${{ steps.version.outputs.ASSEMBLY_VERSION }} \
110118
-p:FileVersion=${{ steps.version.outputs.ASSEMBLY_VERSION }} \
@@ -113,6 +121,7 @@ jobs:
113121
114122
dotnet build src/NumSharp.Bitmap/NumSharp.Bitmap.csproj \
115123
--configuration Release \
124+
-p:NoWarn=${{ env.DOTNET_NOWARN }} \
116125
-p:Version=${{ steps.version.outputs.VERSION }} \
117126
-p:AssemblyVersion=${{ steps.version.outputs.ASSEMBLY_VERSION }} \
118127
-p:FileVersion=${{ steps.version.outputs.ASSEMBLY_VERSION }} \
@@ -127,6 +136,7 @@ jobs:
127136
--configuration Release \
128137
--no-build \
129138
--output artifacts/nuget \
139+
-p:NoWarn=${{ env.DOTNET_NOWARN }} \
130140
-p:Version=${{ steps.version.outputs.VERSION }} \
131141
-p:AssemblyVersion=${{ steps.version.outputs.ASSEMBLY_VERSION }} \
132142
-p:FileVersion=${{ steps.version.outputs.ASSEMBLY_VERSION }} \
@@ -136,6 +146,7 @@ jobs:
136146
--configuration Release \
137147
--no-build \
138148
--output artifacts/nuget \
149+
-p:NoWarn=${{ env.DOTNET_NOWARN }} \
139150
-p:Version=${{ steps.version.outputs.VERSION }} \
140151
-p:AssemblyVersion=${{ steps.version.outputs.ASSEMBLY_VERSION }} \
141152
-p:FileVersion=${{ steps.version.outputs.ASSEMBLY_VERSION }} \

0 commit comments

Comments
 (0)