Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RulesVerifier should ensure that at least one of Recommendation or Description is filled in a Rule #531

Open
gfs opened this issue May 24, 2023 · 1 comment

Comments

@gfs
Copy link
Contributor

gfs commented May 24, 2023

Github's sarif upload feature requires the Text property of the Help property of each Rule to be populated. This field is a plaintext representation of the message shown to a user when an issue is found. Some rules have neither of these fields and thus result in an empty text property which fails to be uploaded to github, see #530.

The rulesverifier should require that at least one of the description or the recommendation is set, and the standard rules should all have descriptions/recommendations.

@gfs
Copy link
Contributor Author

gfs commented May 24, 2023

See microsoft/ApplicationInspector#544 for a PR to require the Description field. Recommendation is a DevSkim only field and would require additional work to implement in the DevSkim verifier, but as long as there is a Description field it should resolve the original issue in #530 more cleanly than the backup message.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant