codeql-analysis.yml

# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"

on:
 push:
 branches: [ "master" ]
 pull_request:
 # The branches below must be a subset of the branches above
 branches: [ "master" ]
 schedule:
 - cron: '17 16 * * 4'

# select correct state for repository
env:
 # state: private
 state: public

jobs:
 public-or-private-repo:
 runs-on: ubuntu-latest
 outputs:
 repostate: ${{ steps.repo-state.outputs.repostate }}
 steps:

 - name: Repo state
 id: repo-state
 run: echo "repostate=${{env.state}}" >> $GITHUB_OUTPUT
 - name: Repo public?
 if: "${{ env.state == 'public' }}"
 run: echo "Workflow has repo set as public. If this is incorrect, uncomment line 25."
 - name: Repo private?
 if: "${{ env.state == 'private' }}"
 run: echo "Workflow has repo set as private. If this is incorrect, uncomment line 26."

# REMEMBER TO CHECK `LANGUAGE` MATRIX FOR CORRECT LANGUAGE SETTINGS
 analyze:
 needs: public-or-private-repo
 if: needs.public-or-private-repo.outputs.repostate == 'public'
 name: Analyze
 runs-on: ubuntu-latest
 permissions:
 actions: read
 contents: read
 security-events: write

 strategy:
 fail-fast: false
 matrix:
 language: [ 'python' ]
 # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
 # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

 steps:
 - name: Checkout repository
 uses: actions/checkout@v3

 # Initializes the CodeQL tools for scanning.
 - name: Initialize CodeQL
 uses: github/codeql-action/init@v2
 with:
 languages: ${{ matrix.language }}
 # If you wish to specify custom queries, you can do so here or in a config file.
 # By default, queries listed here will override any specified in a config file.
 # Prefix the list here with "+" to use these queries and those in the config file.
 
 # 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
 # queries: security-extended,security-and-quality

 
 # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
 # If this step fails, then you should remove it and run the build manually (see below)
 - name: Autobuild
 uses: github/codeql-action/autobuild@v2

 # ℹ️ Command-line programs to run using the OS shell.
 # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

 # If the Autobuild fails above, remove it and uncomment the following three lines. 
 # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

 # - run: |
 # echo "Run, Build Application using script"
 # ./location_of_script_within_repo/buildscript.sh

 - name: Perform CodeQL Analysis
 uses: github/codeql-action/analyze@v2
 with:
 category: "/language:${{matrix.language}}"