https://github.com/zbazztian/codeql-debug

https://github.com/zbazztian/codeql-debug

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/zbazztian/codeql-debug
• Owner: zbazztian
• Created: 2021-03-12T13:26:39.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-26T12:56:44.000Z (over 2 years ago)
• Last Synced: 2024-02-15T15:34:27.004Z (7 months ago)
• Language: CodeQL
• Size: 2.2 MB
• Stars: 60
• Watchers: 1
• Forks: 11
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-codeql - codeql-debug - Add this action to an existing CodeQL analysis workflow to generate an html report (CodeQL Actions Helpers)
• awesome-hacking-lists - zbazztian/codeql-debug - (CodeQL)

README

        
# CodeQL Debug Action

Add this action to an existing CodeQL analysis workflow to generate an html report including

* recognized sources and sinks of the standard set of security queries,

* dependencies / frameworks used by the project,

* analysis performance statistics of previous analyses and

* generated log files from previous analyses.

## Example

```yaml

name: "CodeQL Debugging"

on: workflow_dispatch

jobs:

  debug:

    name: CodeQL Debug Job

    runs-on: ubuntu-latest

    strategy:

      fail-fast: false

      matrix:

        language: [ 'javascript' ]

    steps:

    - name: Checkout repository

      uses: actions/checkout@v2

    - name: Initialize CodeQL

      id: codeqlinit

      uses: github/codeql-action/init@v1

      with:

        languages: ${{ matrix.language }}

    - name: Perform CodeQL Analysis

      uses: github/codeql-action/analyze@v1

    - name: Debug Analysis

      uses: zbazztian/codeql-debug@master

      with:

        language: ${{ matrix.language }}

    - name: Upload loc as a Build Artifact

      uses: actions/[email protected]

      with:

        name: codeql-debug-results

        path: codeql-debug-results

        retention-days: 30

```

This will add the artifact `codeql-debug-results` which is an archive containing html file(s) for the language(s) that were analyzed.

## Parameters

* `language` (required): The language of the database to create the report for. The currently supported languages are `java`, `javascript` and `go`.

* `db-path` (optional): The path to the database. If omitted, the action will guess where the database is located.

* `codeql-path` (optional): The path to the CodeQL CLI executable. If omitted, the action will guess this path.