MISRA C Compliance Report GitHub Action

This GitHub Action generates MISRA compliance reports, offering a structured Guideline Compliance Summary for projects adhering to MISRA C standards. It's designed to parse the output from static code analysis tools and produce a comprehensive report detailing compliance with MISRA C 2012 guidelines.

Important

This action is a proof of concept and under development. It is currently tailored to work with Cppcheck MISRA C 2012 ruleset and our particular environment. We may refactor the action to be more generic and configurable in the future.

Inputs

`GITHUB_TOKEN`

Required GitHub token for authentication. This is necessary for the action to access repository information and create check runs.

`parser`

Required Specifies the analysis tool output parser to use.
Default: Cppcheck
Options: [Cppcheck, PC-lint]

`results`

Required Path to the analysis tool's results.

`rules`

Required Path to the file containing the list of MISRA rules.

`suppressions`

Required Path to the file containing the list of suppressions.

`files`

Required Path to the file containing the list of analyzed files.

`project`

Required Name of the project to generate the compliance report for.

This action also uploads a PDF with the rendered report to google cloud. The link to the PDF is available in the check run output.

Runs

This action runs on Node.js 20 and executes the dist/index.js script as its main entry point.

Example Usage

This example demonstrates how to configure the MISRA C Compliance Report GitHub Action in your workflow to generate a compliance report based on the results from Cppcheck.

  - name: Generate MISRA Compliance Report
    if: always()
    id: misra-compliance-report
    uses: Biglup/misra-compliance-github-action@v0.1
    with:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      project: 'libcardano-c'
      parser: 'Cppcheck'
      results: './scripts/misra/.results/results'
      rules: './scripts/misra/misra2012'
      suppressions: './scripts/misra/suppressions'
      files: './scripts/misra/.results/files.txt'