Skip to content

pio check: emit SARIF #388

@rursprung

Description

@rursprung

pio check currently either emits text or JSON (with --json-output). it'd be great if it could emit SARIF files, so that they can be uploaded to GitHub which would show them as code scanning results on PRs & co.

in case it is not possible to emit SARIF then it would be nice if instead a GitHub action could be provided which can use the generated JSON to create a GitHub check result (though probably converting from JSON to SARIF might be easier?).
the advantage of emitting SARIF is that it isn't bound to GitHub: it is an open standard also supported by other tools, so users which are not hosting their code on GitHub would also profit from this.

the cicd-setup example should then be updated to use this (and maybe include an intentionally introduced warning just to show that it's being shown?)

EDIT: sorry, i just realised that i opened this in platformio-docs rather than platformio-core; could you please move the ticket?
(i initially started to open the ticket here to ask for documentation on how to do this, but then realised that most likely it simply isn't possible right now and thus wrote the ticket as a feature request against pio check rather than a simple docs update request)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions