Ensure we log what the HTTP error message is if we get a failure #78418
Conversation
This file contains hidden or 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
Just because one is missing doesn't mean we should skip validating the rest; that way you can see if there's a single one missing or a bunch missing.
ghost
added
Area-Infrastructure
untriaged
jasonmalinowski
commented
May 2, 2025
src/RoslynAnalyzers/Tools/GenerateDocumentationAndConfigFiles/Program.cs
Show resolved
Hide resolved
jasonmalinowski
commented
May 2, 2025
src/RoslynAnalyzers/Tools/GenerateDocumentationAndConfigFiles/Program.cs
Outdated
Show resolved
Hide resolved
jasonmalinowski
commented
May 2, 2025
| await Console.Error.WriteLineAsync($"Missing entry in {fileWithPath}").ConfigureAwait(false); | ||
| await Console.Error.WriteLineAsync(line).ConfigureAwait(false); | ||
| // The file is missing an entry. Mark it as invalid and break the loop as there is no need to continue validating. |
There was a problem hiding this comment.
Stopping further validation seems odd, because it means you might not necessarily know the extent of a potential problem.
dibarbet
reviewed
May 2, 2025
| { | ||
| try | ||
| { | ||
| if (!Uri.TryCreate(helpLink, UriKind.Absolute, out var uri)) | ||
| { | ||
| return false; | ||
| // TODO: why would we not fail this if the URI is invalid? | ||
| return (HttpStatusCode.OK, null); |
There was a problem hiding this comment.
I feel like this should definitely fail (it did before as well) and not return ok
| { | ||
| // Rule with valid documentation link | ||
| if (string.IsNullOrWhiteSpace(helpLinkUri)) | ||
| continue; |
There was a problem hiding this comment.
unless I am misreading this, we will now pass validation if the help link is missing, which isn't what we did before. seems like a missing link should fail validation
There was a problem hiding this comment.
Yep, you're right. Will fix.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.