roslyn-analyzers icon indicating copy to clipboard operation
roslyn-analyzers copied to clipboard

Check markdown links fails on new Analyzers

Open ynsehoornenborg opened this issue 1 year ago • 1 comments

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

ynsehoornenborg avatar Mar 04 '23 16:03 ynsehoornenborg

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?

bcollamore avatar Mar 08 '23 00:03 bcollamore