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

Add setting to conclude check with "neutral" instead of "success" when warnings are present #188

Closed
inket opened this issue Apr 2, 2021 · 1 comment · Fixed by #192
Closed
Labels
enhancement New feature or request

Comments

@inket
Copy link
Contributor

inket commented Apr 2, 2021

Hi there. First of all, thanks for this awesome project! It really cut down the amount of work necessary to achieve linting through GitHub Actions.

This is a feature request/suggestion with a following pull request if you approve of such addition.

Basically, when linters finish with only warning annotations as a result, the GitHub "Check" will have the conclusion attribute set to success. This causes GitHub to collapse the checks section (since all the checks are green checkmarks) and might cause developers to miss that the linter actually found some warnings!

As you can see, the checks section here is collapsed
⬇️
Screen Shot 2021-04-02 at 2 36 45 PM

But upon expanding it, our linter actually found a couple of warnings! Some people might easily miss these annotations.
⬇️
Screen Shot 2021-04-02 at 2 36 52 PM

My suggestion to this is to add a setting to mark such cases as neutral instead.
⬇️
Screen Shot 2021-04-02 at 2 18 13 PM

neutral is also the only status that doesn't look like a success/failure. (success would encourage developers to ignore it; failure would be too strict and should be reserved to actual errors)
⬇️

Would you be interested in adding such a feature? I'm already running a fork that changes the logic directly and it's working fine for SwiftLint. An actual pull request would have this as a setting instead of hardcoded of course.

Thanks.

@ocean90
Copy link
Member

ocean90 commented Apr 7, 2021

Hey there, thanks for detailed issue! I think this is a great idea, please feel free to submit a PR.

@ocean90 ocean90 added the enhancement New feature or request label Apr 7, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants