[build] Ignore CA1305 in more projects #8110
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Commit 04e4bb1 turned `CA1305` into a build error for projects in the `src` directory, however the .NET analyzers that detect this issue only run by default on projects targeting .NET 5.0 or later. Sources that target `netstandard2.0` (including our build tasks) contain instances of `CA1305` that should be fixed, but these errors weren't being reported in our regular builds. Our nightly build managed to catch _some_ of these issues, as this build set an MSBuild property that would cause our sources to import the FxCop NuGet package. FxCop is deprecated, and it should be replaced by using the first-party .NET analyzers. These analyzers can be enabled for projects with older target frameworks by setting the [`$(EnableNETAnalyzers)`][0] property to `true`. This property is now set to true for all build types (pr, CI, nightly) and projects in xamarin-android. After enabling .NET analyzers on projects with older target frameworks, the following projects needed to suppress `CA1305` warnings as errors to fix the regular and nightly builds: * `src/Xamarin.Android.Build.Tasks/Tests/Xamarin.ProjectTools/Xamarin.ProjectTools.csproj` * `src/Xamarin.Android.Build.Tasks/Xamarin.Android.Build.Tasks.csproj` * `src/Xamarin.Android.Tools.Aidl/Xamarin.Android.Tools.Aidl.csproj` * `src/Xamarin.Android.Tools.JavadocImporter/Xamarin.Android.Tools.JavadocImporter.csproj` We should try to address the `CA1305` issues in these non-test projects in a future PR. [0]: https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#enablenetanalyzers
pjcollins
requested review from
jonpryor,
dellis1972 and
jonathanpeppers
as code owners
|
I filed #8109 to track future work for fixing more CA1305 instances. We will likely want to prioritize those in |
dellis1972
approved these changes
Jun 6, 2023
grendello
added a commit
to grendello/xamarin-android
that referenced
this pull request
Jun 7, 2023
* main: [ci] Shut down dotnet processes before retrying failed unit tests. (dotnet#8107) Bump to dotnet/installer@18dc2cf1 8.0.100-preview.6.23305.2 [Xamarin.Android.Build.Tasks] Ignore non-Android XML resources (dotnet#8091) [build] Ignore CA1305 in more projects (dotnet#8110)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commit 04e4bb1 turned
CA1305into a build error for projects in thesrcdirectory, however the .NET analyzers that detect this issue onlyrun by default on projects targeting .NET 5.0 or later. Sources that
target
netstandard2.0(including our build tasks) contain instances ofCA1305that should be fixed, but these errors weren't being reportedin our regular builds.
Our nightly build managed to catch some of these issues, as this build
set an MSBuild property that would cause our sources to import the FxCop
NuGet package.
FxCop is deprecated, and it should be replaced by using the first-party
.NET analyzers. These analyzers can be enabled for projects with older
target frameworks by setting the
$(EnableNETAnalyzers)propertyto
true. This property is now set to true for all build types (pr,CI, nightly) and projects in xamarin-android.
After enabling .NET analyzers on projects with older target frameworks,
the following projects needed to suppress
CA1305warnings as errors tofix the regular and nightly builds:
src/Xamarin.Android.Build.Tasks/Tests/Xamarin.ProjectTools/Xamarin.ProjectTools.csprojsrc/Xamarin.Android.Build.Tasks/Xamarin.Android.Build.Tasks.csprojsrc/Xamarin.Android.Tools.Aidl/Xamarin.Android.Tools.Aidl.csprojsrc/Xamarin.Android.Tools.JavadocImporter/Xamarin.Android.Tools.JavadocImporter.csprojWe should try to address the
CA1305issues in these non-test projectsin a future PR.