audit-labs/audit-tools

 1# For most projects, this workflow file will not need changing; you simply need
 2# to commit it to your repository.
 3#
 4# You may wish to alter this file to override the set of languages analyzed,
 5# or to provide custom queries or build logic.
 6#
 7# ******** NOTE ********
 8# We have attempted to detect the languages in your repository. Please check
 9# the `language` matrix defined below to confirm you have the correct set of
10# supported CodeQL languages.
11#
12name: "CodeQL Advanced"
13
14on:
15  push:
16    branches: [ "main" ]
17  pull_request:
18    branches: [ "main" ]
19
20jobs:
21  analyze:
22    name: Analyze (${{ matrix.language }})
23    # Runner size impacts CodeQL analysis time. To learn more, please see:
24    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
25    #   - https://gh.io/supported-runners-and-hardware-resources
26    #   - https://gh.io/using-larger-runners (GitHub.com only)
27    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
28    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
29    permissions:
30      # required for all workflows
31      security-events: write
32
33      # required to fetch internal or private CodeQL packs
34      packages: read
35
36      # only required for workflows in private repositories
37      actions: read
38      contents: read
39
40    strategy:
41      fail-fast: false
42      matrix:
43        include:
44        - language: python
45          build-mode: none
46        # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
47        # Use `c-cpp` to analyze code written in C, C++ or both
48        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
49        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
50        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
51        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
52        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
53        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
54    steps:
55    - name: Checkout repository
56      uses: actions/checkout@v4
57
58    # Add any setup steps before running the `github/codeql-action/init` action.
59    # This includes steps like installing compilers or runtimes (`actions/setup-node`
60    # or others). This is typically only required for manual builds.
61    # - name: Setup runtime (example)
62    #   uses: actions/setup-example@v1
63
64    # Initializes the CodeQL tools for scanning.
65    - name: Initialize CodeQL
66      uses: github/codeql-action/init@v3
67      with:
68        languages: ${{ matrix.language }}
69        build-mode: ${{ matrix.build-mode }}
70        # If you wish to specify custom queries, you can do so here or in a config file.
71        # By default, queries listed here will override any specified in a config file.
72        # Prefix the list here with "+" to use these queries and those in the config file.
73
74        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
75        # queries: security-extended,security-and-quality
76
77    # If the analyze step fails for one of the languages you are analyzing with
78    # "We were unable to automatically build your code", modify the matrix above
79    # to set the build mode to "manual" for that language. Then modify this step
80    # to build your code.
81    # ℹ️ Command-line programs to run using the OS shell.
82    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
83    - if: matrix.build-mode == 'manual'
84      shell: bash
85      run: |
86        echo 'If you are using a "manual" build mode for one or more of the' \
87          'languages you are analyzing, replace this with the commands to build' \
88          'your code, for example:'
89        echo '  make bootstrap'
90        echo '  make release'
91        exit 1
92
93    - name: Perform CodeQL Analysis
94      uses: github/codeql-action/analyze@v3
95      with:
96        category: "/language:${{matrix.language}}"