Conversation
The GitHub Actions formatter includes the documentationUrl for a rule if it is defined, but some rules, such as the ones in the built-in oas ruleset, rely on a ruleset-level documentationUrl. This updates the GitHub Actions formatter to use the existing getDocumentationUrl resolver so that the documentationUrl will be included in GitHub Actions annotations whenever it is available.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The GitHub Actions formatter includes the documentationUrl for a rule if it is defined, but some rules, such as the ones in the built-in oas ruleset, rely on a ruleset-level documentationUrl.
This updates the GitHub Actions formatter to use the existing getDocumentationUrl resolver so that the documentationUrl will be included in GitHub Actions annotations whenever it is available.
Checklist
Does this PR introduce a breaking change?
Screenshots
If applicable, add screenshots or gifs to help demonstrate the changes. If not applicable, remove this screenshots section before creating the PR.
Additional context
Add any other context about the pull request here. Remove this section if there is no additional context.