Here’s a quick, practical path to make your scanner’s findings show up in GitHub’s **Code scanning** UI with almost no integration work: emit **SARIF 2.1.0** and upload it. --- ### What SARIF is (and what GitHub expects) * **SARIF** = Static Analysis Results Interchange Format, a JSON standard for static-analysis results. GitHub Code Scanning accepts a **subset** of **SARIF 2.1.0** and turns it into alerts in the Security tab. ([GitHub Docs][1]) --- ### Three upload options (pick one) 1. **GitHub Actions**: add a step that uploads your SARIF file(s). ```yaml # .github/workflows/upload-sarif.yml name: Upload SARIF on: push: schedule: [{cron: "0 3 * * 1"}] # optional weekly recrawl jobs: sarif: runs-on: ubuntu-latest permissions: security-events: write # required to publish code scanning alerts contents: read steps: - uses: actions/checkout@v4 - name: Run your scanner run: ./your_scanner --format sarif --out results.sarif - name: Upload SARIF to Code Scanning uses: github/codeql-action/upload-sarif@v3 with: sarif_file: results.sarif category: your-scanner ``` This uses GitHub’s official **upload-sarif** action and is the easiest route. ([GitHub Docs][2]) 2. **REST API**: gzip + base64 your SARIF and POST to `code-scanning/sarifs` (needs `security_events` scope for private repos). Useful if you run scans outside Actions. ([GitHub Docs][3]) 3. **CodeQL CLI**: `codeql github upload-results --sarif-file results.sarif` (also needs proper token). Handy if you’re already using the CLI in your CI. ([GitHub Docs][4]) --- ### Minimal SARIF you should emit At minimum, include: * `version: "2.1.0"` * one `run` with your `tool.driver` (name, version) * `results[]` with each finding’s `ruleId`, `message.text`, and at least one `location` (file/region) so GitHub can anchor it to code. (Empty or missing locations often breaks uploads.) ([GitHub Docs][1]) Skeleton: ```json { "version": "2.1.0", "$schema": "https://json.schemastore.org/sarif-2.1.0.json", "runs": [{ "tool": { "driver": { "name": "StellaOps Scanner", "version": "1.0.0" } }, "results": [{ "ruleId": "STELLA001", "message": { "text": "Vulnerability XYZ in package foo@1.2.3" }, "locations": [{ "physicalLocation": { "artifactLocation": { "uri": "src/app/foo.js" }, "region": { "startLine": 42 } } }] }] }] } ``` (Full schema: OASIS SARIF 2.1.0.) ([OASIS Open][5]) --- ### Gotchas (save yourself time) * **One tool/category per run**: GitHub is deprecating combining multiple runs with the same tool+category in a single upload; by **June 2025** such uploads will fail. Keep runs distinct or separate files. ([The GitHub Blog][6]) * **Partial fingerprints**: If you don’t provide them, the upload action can compute them (prevents duplicate alerts) when source is present. ([GitHub Docs][2]) * **Permissions**: in Actions, grant `security-events: write`. For API/CLI, use tokens with the right scopes. ([GitHub Docs][3]) * **PRs from forks**: public API uploads have restrictions; the `upload-sarif` action is the usual workaround in PR contexts. ([GitHub][7]) --- ### Why this helps your rollout * **Zero custom UI**: GitHub draws findings, file annotations, and PR decorations for you. ([GitHub Docs][1]) * **Fits any CI**: Emit SARIF once, then upload via Actions, REST, or CLI—works for GitHub-hosted or external runners. ([GitHub Docs][2]) If you want, I can tailor a ready-to-drop workflow for one of your Stella Ops repos (mono-repo vs multi-repo, language mix, and desired categories). [1]: https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning?utm_source=chatgpt.com "SARIF support for code scanning" [2]: https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github?utm_source=chatgpt.com "Uploading a SARIF file to GitHub" [3]: https://docs.github.com/en/rest/code-scanning?utm_source=chatgpt.com "REST API endpoints for code scanning" [4]: https://docs.github.com/en/code-security/codeql-cli/codeql-cli-manual/github-upload-results?utm_source=chatgpt.com "github upload-results" [5]: https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html?utm_source=chatgpt.com "Static Analysis Results Interchange Format (SARIF) Version ..." [6]: https://github.blog/changelog/2024-05-06-code-scanning-will-stop-combining-runs-from-a-single-upload/?utm_source=chatgpt.com "Code Scanning will stop combining runs from a single upload" [7]: https://github.com/orgs/community/discussions/54013?utm_source=chatgpt.com "Uploading SARIF files for pull requests #54013"