github / github/codeql

Implement CodeQL SARIF file improvements suggested by Microsoft SARIF SDK tool

Offen
#18,477 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
question
Vorherrschende Sprache
CodeQL
Sterne
10.1k
Forks
2.1k
Ø Merge
2 T. 15 Std.
Gemergte PRs (30 T.)
141

Beschreibung

Microsoft has a nice SARIF SDK tool which allows you to a bunch of stuff with SARIF files.

It's repo is here: https://github.com/microsoft/sarif-sdk, and there is a basic explanation of how to use it here: https://github.com/microsoft/sarif-sdk/blob/main/docs/multitool-usage.md.

You can easily install it like so:
- npm i -g @microsoft/sarif-multitool (requires Node.js (e.g., npm and node)

And then run it on CodeQL generated SARIF files like so:
- npx @microsoft/sarif-multitool validate Some_CODEQL.sarif --max-file-size-in-kb=some_number_if_needed

When I ran it on a recently generated codeQL SARIF file it generated LOTS of suggested improvements to the SARIF file generated by CodeQL.

I suggest you look at/implement the suggestions that make sense to you, and you might want to build in this 'SARIF validate' function into your maintenance process, to continually maintain/improve the SARIF files generated by CodeQL.

Not urgent, but certainly I think a useful/good maintenance aide for this project.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Installieren Sie @microsoft/sarif-multitool mit npm und führen Sie den Befehl validate für eine kürzlich generierte CodeQL-SARIF-Datei aus. Prüfen Sie die gemeldeten Verbesserungen, bestimmen Sie, welche Vorschläge für dieses Projekt angemessen sind, und prüfen Sie, ob die SARIF-Validierung in den Wartungsprozess aufgenommen werden sollte. Die Aufgabe ist abgeschlossen, wenn die sinnvollen Verbesserungen implementiert und der Validierungsansatz dokumentiert oder integriert ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
node.js
Bereich
security, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.