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

Use differential-shellcheck instead of action-shellcheck #106

Merged
merged 1 commit into from
Oct 17, 2023
Merged

Use differential-shellcheck instead of action-shellcheck #106

merged 1 commit into from
Oct 17, 2023

Conversation

jamacku
Copy link
Contributor

@jamacku jamacku commented Jun 28, 2023

This change doesn't change the core behavior of ShellCheck linting. Differential ShellCheck uses by default flag -X. It will also exclude all shell scripts located in tests/ from linting.

Some benefits of using differential ShellCheck Action

Differential ShellCheck is a GitHub Action that performs differential ShellCheck scans on shell scripts changed via PR and reports results directly in PR.

It 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 Changed tab, please see below.

image

image

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.

It performs differential ShellCheck scans and report results directly on GitHub.

documentation: https://github.com/redhat-plumbers-in-action/differential-shellcheck

Signed-off-by: Jan Macku <[email protected]>
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@say-paul
Copy link
Member

This looks cool!! do you have its as IDE-plugin(vs code) as static analysis tool?

@jamacku
Copy link
Contributor Author

jamacku commented Sep 11, 2023

This looks cool!! do you have its as IDE-plugin(vs code) as static analysis tool?

Unfortunately, no, but I believe you can use https://github.com/Microsoft/sarif-vscode-extension with this action. Once you link your GitHub account with sarif-vscode-extension, you should see the reports in your IDE.

Screenshot from 2023-09-11 15-30-22

Screenshot from 2023-09-11 15-30-57

@nullr0ute
Copy link
Member

LGTM

@nullr0ute nullr0ute merged commit ad64fb5 into fedora-iot:main Oct 17, 2023
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants