clang-tidy-sarif

此软件包提供了一种命令行工具，用于将 clang-tidy 诊断输出转换为 SARIF。

最新的 文档 可在此找到。

clang-tidy 是一个流行的 C++ 代码检查/静态分析工具。更多信息可以在官方页面找到： http://clang.llvm.net.cn/extra/clang-tidy/

SARIF 或静态分析结果交换格式是静态分析工具输出的一种行业标准格式。更多信息可以在官方网站找到： https://sarifweb.azurewebsites.net/

安装

clang-tidy-sarif 可以通过 cargo 安装

cargo install clang-tidy-sarif

通过 cargo-binstall

cargo binstall clang-tidy-sarif

或直接从 Github Releases 下载

# make sure to adjust the target and version (you may also want to pin to a specific version)
curl -sSL https://github.com/psastras/sarif-rs/releases/download/clang-tidy-sarif-latest/clang-tidy-sarif-x86_64-unknown-linux-gnu -o clang-tidy-sarif

用法

对于大多数情况，只需运行 clang-tidy 并将结果通过管道传递给 clang-tidy-sarif。

示例

 clang-tidy -checks=cert-* -warnings-as-errors=* main.cpp -- | clang-tidy-sarif

如果您使用 Github Actions，SARIF 对于与 Github 高级安全 (GHAS) 集成非常有用，这可以在您的存储库的 "安全" 选项卡中显示代码警报。

将 clang-tidy-sarif 输出上传到 Github 后，clang-tidy 诊断将在 GHAS 中可用。

示例

on:
  workflow_run:
    workflows: ["main"]
    branches: [main]
    types: [completed]

name: sarif

jobs:
  upload-sarif:
    runs-on: ubuntu-latest
    if: ${{ github.ref == 'refs/heads/main' }}
    steps:
      - uses: actions/checkout@v2
      - uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: stable
          override: true
      - uses: Swatinem/rust-cache@v1
      - run: cargo install clang-tidy-sarif sarif-fmt
      - run: clang-tidy -checks=cert-* -warnings-as-errors=* main.cpp -- | tee
          results.sarif | sarif-fmt
      - name: Upload SARIF file
        uses: github/codeql-action/upload-sarif@v1
        with:
          sarif_file: results.sarif

许可证：MIT