Skip to content

Conversation

@yeshan333
Copy link

SARIF (Static Analysis Results Interchange Format) is an OASIS Standard that defines an output file format. The SARIF standard is used to streamline how static analysis tools share their results.

SARIF can be used by GitHub Code Scanning feature, which ill produce reports avaliable from the GitHub Security tab. I haven built a sample repository for the PR, you can use this sample repository to see the general effect.

In Security Tab: https://github.com/yeshan333/luacheck_sarif_report_demo/security/code-scanning

demo

In Pull Request: yeshan333/luacheck_sarif_report_demo#1

demo

Copy link
Member

@alerque alerque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding the SARIF output format sounds great. I'm sure there is legitimate uses for that ... I'm not convinced showing up in the "security" tab is what we want to have happen though. Most of the code lints luacheck produces are not likely to be security related.

Also a bit of a concern about deterministic testing...see code comments.

@yeshan333
Copy link
Author

SARIF is a Standard Static Analysis Results Interchange Format. There are tools such as megalinter that aggregate the scans of multiple tools into a single SARIF report that can be used in a variety of CI systems. It's a bit strange for Github to classify scan results in Security Tab.

@yeshan333 yeshan333 requested a review from alerque June 6, 2025 03:11
@myzhan
Copy link

myzhan commented Sep 11, 2025

It's awesome! I'm using megalinter in my project, which using multiple languages, including lua. So an united output format is needed.

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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants