https://github.com/advanced-security/codeql-summarize

CodeQL Summary Generator
https://github.com/advanced-security/codeql-summarize

Last synced: 3 months ago
JSON representation

CodeQL Summary Generator

• Host: GitHub
• URL: https://github.com/advanced-security/codeql-summarize
• Owner: advanced-security
• License: mit
• Created: 2022-07-14T17:40:18.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-20T10:47:24.000Z (6 months ago)
• Last Synced: 2024-05-20T11:53:03.188Z (6 months ago)
• Language: Python
• Size: 229 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md
  • Support: SUPPORT.md

Awesome Lists containing this project

• awesome-codeql - codeql-summarize - CodeQL Summary Generator to generate Models as Data (MaD) from CodeQL databases. (CodeQL Customizations)

README

        
# CodeQL Summarize

This is the GitHub CodeQL Summarize project and Actions which allows users to generate Models as Data (MaD) from CodeQL databases.

## Run

### Actions

The main use case for `codeqlsummarize` is to run it as an Action so the purposes of automating this process.

```yml

- name: Generate CodeQL Summaries

  uses: advanced-security/codeql-summarize@v1

  with:

    # This file defines the projects you want to make sure to get the latest and greatest

    # summaries from.

    projects: ./projects.json

    # Token needs access to download the CodeQL databases you want to create summaries for

    token: ${{ secrets.CODEQL_SUMMARY_GENERATOR_TOKEN }}

```

### GH CLI

You can install this tool as part of the GitHub CLI using the following commands:

```bash

gh extensions install advanced-security/gh-codeql-summarize

gh codeql-summarize --help

```

### Manual Command Line

```bash

git clone https://github.com/advanced-security/gh-codeql-summarize.git && cd gh-codeql-summarize

python3 -m codeqlsummarize --help

```

## License

This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE.txt) for the full terms.

## Maintainers 

[CODEOWNERS](./.github/CODEOWNERS) file.

## Support

Please create issues for any feature requests, bugs, or documentation problems.

## Acknowledgement

- @GeekMasher - Author

- @zbazztian - Major contributor