search

philips-software / roslyn-analyzers

Roslyn Diagnostic Analyzers are customized compiler errors providing real-time feedback to C# developers. Each Analyzer optionally includes an automatic Code Fixer.
MIT License
48 stars 11 forks source link

Check markdown links fails on new Analyzers #511

Open ynsehoornenborg opened 1 year ago

ynsehoornenborg commented 1 year ago

When introducing a new analyzer, the link to its source code file is not (yet) on the main branch.

For example: FILE: ./Documentation/Diagnostics/PH2140.md [✓] https://www.nuget.org/packages/Philips.CodeAnalysis.MaintainabilityAnalyzers [✓] ../Maintainability.md [✖] https://github.com/philips-software/roslyn-analyzers/blob/master/Philips.CodeAnalysis.MaintainabilityAnalyzers/Maintainability/PreferReadOnlyParametersAnalyzer.cs [✓] https://learn.microsoft.com/en-us/dotnet/api/system.collections.immutable.immutablearray?view=net-7.0 [✓] https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/suppress-warnings

5 links checked.

ERROR: 1 dead links found! [✖] https://github.com/philips-software/roslyn-analyzers/blob/master/Philips.CodeAnalysis.MaintainabilityAnalyzers/Maintainability/PreferReadOnlyParametersAnalyzer.cs → Status: 404

bcollamore commented 1 year ago

Hmm... maybe we make the workflow's status check not Required? We'll generally see when it fails, and sanity check whether or not we're comfortable proceeding?