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