ci(lint): add shell linter - Differential ShellCheck #739
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
It performs differential ShellCheck scans and report results directly in pull request. documentation: https://github.com/redhat-plumbers-in-action/differential-shellcheck Signed-off-by: Jan Macku <[email protected]>
|
Thanks for the detail in the PR. This project has zero ShellCheck warnings for the main shell script, albeit with some selective disabling. So no need to use a differential process which requires a token. There isn't currently any automation though. The regression tests and ShellCheck are run manually. I'll look at adding a ShellCheck automation, prompted by this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Pull Request
Differential ShellCheck is a GitHub action that performs differential ShellCheck scans on shell scripts changed via PR and reports results directly in PR. The beauty of differential scans is that you will get reports only about newly added defects.
Since this repository has many shell scripts, I think you might find some value in having a shell linter. Differential ShellCheck action is able to produce reports in SARIF format. GitHub understands this format and is able to display it nicely as a PR comment, and on the
Files Changedtab, please see below.Documentation is available at @redhat-plumbers-in-action/differential-shellcheck. Let me know If you are missing some feature or setting. I'm always happy to extend functionality.
Problem
ShellCheck is a powerful linter for shell scripts, but it can be very verbose. It can be issue for projects that didn't use it from the beginning. When introducing ShellCheck later on it requires a lot of work beforehand to disable checks or mask existing "defects". This process could mean for some project risk of introducing regressions when fixing some defects that aren't defects.
Solution
Using differential scan for ShellCheck allows you to introduce ShellCheck linter faster with minimal work, so you can lint incoming PRs. And later on you can focus on improving existing code if needed.
ChangeLog
This probably doesn'ŧ have to be mentioned in CHANGELOG.