/ .github / workflows / codeql.yml
codeql.yml
 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"
13  
14  on:
15    push:
16      branches: ["main"]
17    pull_request:
18      # The branches below must be a subset of the branches above
19      branches: ["main"]
20    schedule:
21      - cron: "0 0 * * 1"
22  
23  permissions:
24    contents: read
25  
26  jobs:
27    analyze:
28      name: Analyze
29      runs-on: ubuntu-latest
30      permissions:
31        actions: read
32        contents: read
33        security-events: write
34  
35      strategy:
36        fail-fast: false
37        matrix:
38          language: ["python"]
39          # CodeQL supports [ $supported-codeql-languages ]
40          # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
41  
42      steps:
43        - name: Harden Runner
44          uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1
45          with:
46            egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs
47  
48        - name: Checkout repository
49          uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v3.5.2
50  
51        # Initializes the CodeQL tools for scanning.
52        - name: Initialize CodeQL
53          uses: github/codeql-action/init@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
54          with:
55            languages: ${{ matrix.language }}
56            # If you wish to specify custom queries, you can do so here or in a config file.
57            # By default, queries listed here will override any specified in a config file.
58            # Prefix the list here with "+" to use these queries and those in the config file.
59  
60        # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
61        # If this step fails, then you should remove it and run the build manually (see below)
62        - name: Autobuild
63          uses: github/codeql-action/autobuild@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
64  
65        # â„šī¸ Command-line programs to run using the OS shell.
66        # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
67  
68        #   If the Autobuild fails above, remove it and uncomment the following three lines.
69        #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
70  
71        # - run: |
72        #   echo "Run, Build Application using script"
73        #   ./location_of_script_within_repo/buildscript.sh
74  
75        - name: Perform CodeQL Analysis
76          uses: github/codeql-action/analyze@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
77          with:
78            category: "/language:${{matrix.language}}"