From ffd114f10cd2b560bd6ca9a552e98909dc65aa74 Mon Sep 17 00:00:00 2001 From: "Andoni A." <14891798+andoniaf@users.noreply.github.com> Date: Fri, 10 Apr 2026 10:55:42 +0200 Subject: [PATCH] docs(sdk): remove GitHub Code Scanning workflow examples from SARIF docs --- docs/user-guide/cli/tutorials/reporting.mdx | 16 -------- docs/user-guide/cookbooks/cicd-pipeline.mdx | 39 ------------------- .../providers/iac/getting-started-iac.mdx | 6 +-- 3 files changed, 3 insertions(+), 58 deletions(-) diff --git a/docs/user-guide/cli/tutorials/reporting.mdx b/docs/user-guide/cli/tutorials/reporting.mdx index 934373b764..a0cf2348bc 100644 --- a/docs/user-guide/cli/tutorials/reporting.mdx +++ b/docs/user-guide/cli/tutorials/reporting.mdx @@ -392,22 +392,6 @@ The SARIF output includes: * **Results:** Only failed (non-muted) findings are included, with file paths and line numbers for precise annotation. * **Severity mapping:** Prowler severities map to SARIF levels (`critical`/`high` → `error`, `medium` → `warning`, `low`/`informational` → `note`). -#### GitHub Code Scanning Integration - -To upload SARIF results to GitHub Code Scanning, use the `github/codeql-action/upload-sarif` action in a GitHub Actions workflow: - -```yaml -- name: Run Prowler IaC Scan - run: prowler iac --scan-repository-url ${{ github.server_url }}/${{ github.repository }} -M sarif - -- name: Upload SARIF to GitHub Security - uses: github/codeql-action/upload-sarif@v3 - with: - sarif_file: output/ -``` - -Findings appear natively in the repository's Security tab as code scanning alerts, with annotations pointing to the exact file and line. - ## V4 Deprecations Some deprecations have been made to unify formats and improve outputs. diff --git a/docs/user-guide/cookbooks/cicd-pipeline.mdx b/docs/user-guide/cookbooks/cicd-pipeline.mdx index 595de068a1..9dffd5049c 100644 --- a/docs/user-guide/cookbooks/cicd-pipeline.mdx +++ b/docs/user-guide/cookbooks/cicd-pipeline.mdx @@ -231,45 +231,6 @@ prowler aws --push-to-cloud -M csv,html -o /tmp/prowler-reports This produces CSV and HTML files locally while also pushing OCSF findings to Prowler Cloud. The local files can be stored as CI/CD artifacts for archival purposes. -### IaC Scanning with GitHub Code Scanning - -To scan Infrastructure as Code and upload findings to GitHub's Security tab as code scanning alerts: - -```yaml -name: Prowler IaC Scan - -on: - push: - branches: [main] - pull_request: - branches: [main] - -permissions: - contents: read - security-events: write - -jobs: - prowler-iac: - runs-on: ubuntu-latest - steps: - - name: Install Prowler - run: pip install prowler - - - name: Run Prowler IaC Scan - run: | - prowler iac --scan-repository-url ${{ github.server_url }}/${{ github.repository }} -M sarif - - - name: Upload SARIF to GitHub Security - uses: github/codeql-action/upload-sarif@v3 - if: always() - with: - sarif_file: output/ -``` - - -The `security-events: write` permission is required to upload SARIF results. The `if: always()` condition ensures findings are uploaded even when Prowler exits with a non-zero code due to failing checks. - - ### Scanning Multiple AWS Accounts To scan multiple accounts sequentially in a single job, use [role assumption](/user-guide/providers/aws/role-assumption): diff --git a/docs/user-guide/providers/iac/getting-started-iac.mdx b/docs/user-guide/providers/iac/getting-started-iac.mdx index e7870bfa9f..67a8cf3e9f 100644 --- a/docs/user-guide/providers/iac/getting-started-iac.mdx +++ b/docs/user-guide/providers/iac/getting-started-iac.mdx @@ -146,14 +146,14 @@ Use the standard Prowler output options. The IaC provider also supports [SARIF]( prowler iac --scan-path ./iac --output-formats csv json-ocsf html ``` -#### SARIF Output for GitHub Code Scanning +#### SARIF Output -To generate SARIF output compatible with GitHub Code Scanning: +To generate SARIF output for integration with SARIF-compatible tools: ```sh prowler iac --scan-repository-url https://github.com/user/repo -M sarif ``` -The SARIF file can be uploaded to GitHub's Security tab using the `github/codeql-action/upload-sarif` action. Findings appear as code scanning alerts with file and line annotations. See the [SARIF reporting documentation](/user-guide/cli/tutorials/reporting#sarif-iac-only) for details. +See the [SARIF reporting documentation](/user-guide/cli/tutorials/reporting#sarif-iac-only) for details on the format and severity mapping.