codeql.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: [ "main" ]
  pull_request:
    # The branches below must be a subset of the branches above
    branches: [ "main" ]
  schedule:
    - cron: '23 10 * * 6'

jobs:
  analyze:
    name: Analyze
    runs-on: ubuntu-latest
    permissions:
      actions: read
      contents: read
      security-events: write

    strategy:
      fail-fast: false
      matrix:
        language: [ 'go', 'javascript', 'python' ]
        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
        # Use only 'java' to analyze code written in Java, Kotlin or both
        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
        # 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#, Go, 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}}"
    - name: Setup Node.js environment

   uses: actions/setup-node@v3.6.0

  with:

    # Set always-auth in npmrc.

    always-auth: # optional, default is false

    # Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.

    node-version: # optional

    # File containing the version Spec of the version to use.  Examples: .nvmrc, .node-version, .tool-versions.

    node-version-file: # optional

    # Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.

    architecture: # optional

    # Set this option if you want the action to check for the latest available version that satisfies the version spec.

    check-latest: # optional

    # Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file, and set up auth to read in from env.NODE_AUTH_TOKEN.

    registry-url: # optional

    # Optional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/).

    scope: # optional

    # Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.

    token: # optional, default is ${{ github.server_url == 'https://github.com' && github.token || '' }}

    # Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm.

    cache: # optional

    # Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc. Supports wildcards or a list of file names for caching multiple dependencies.

    cache-dependency-path: # optional
    
    - name: Cache

  uses: actions/cache@v2.1.8

  with:

    # A list of files, directories, and wildcard patterns to cache and restore

    path: 

    # An explicit key for restoring and saving the cache

    key: 

    # An ordered list of keys to use for restoring the cache if no cache hit occurred for key

    restore-keys: # optional

    # The chunk size used to split up large files during upload, in bytes

    upload-chunk-size: # optional
    
    - name: Setup Node.js environment

  uses: actions/setup-node@v3.6.0

  with:

    # Set always-auth in npmrc.

    always-auth: # optional, default is false

    # Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.

    node-version: # optional

    # File containing the version Spec of the version to use.  Examples: .nvmrc, .node-version, .tool-versions.

    node-version-file: # optional

    # Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.

    architecture: # optional

    # Set this option if you want the action to check for the latest available version that satisfies the version spec.

    check-latest: # optional

    # Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file, and set up auth to read in from env.NODE_AUTH_TOKEN.

    registry-url: # optional

    # Optional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/).

    scope: # optional

    # Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.

    token: # optional, default is ${{ github.server_url == 'https://github.com' && github.token || '' }}

    # Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm.

    cache: # optional

    # Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc. Supports wildcards or a list of file names for caching multiple dependencies.

    cache-dependency-path: # optional
    
    - name: Upload a Build Artifact

  uses: actions/upload-artifact@v3.1.2

  with:

    # Artifact name

    name: # optional, default is artifact

    # A file, directory or wildcard pattern that describes what to upload

    path: 

    # The desired behavior if no files are found using the provided path.

Available Options:

  warn: Output a warning but do not fail the action

  error: Fail the action with an error message

  ignore: Do not output any warnings or errors, the action does not fail

    if-no-files-found: # optional, default is warn

    # Duration after which artifact will expire in days. 0 means using default retention.

Minimum 1 day. Maximum 90 days unless changed from the repository settings page.

    retention-days: # optional
    
    - name: Setup Go environment

  uses: actions/setup-go@v4.0.0

  with:

    # The Go version to download (if necessary) and use. Supports semver spec and ranges.

    go-version: # optional

    # Path to the go.mod or go.work file.

    go-version-file: # optional

    # Set this option to true if you want the action to always check for the latest available version that satisfies the version spec

    check-latest: # optional

    # Used to pull node distributions from go-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.

    token: # optional, default is ${{ github.server_url == 'https://github.com' && github.token || '' }}

    # Used to specify whether caching is needed. Set to true, if you'd like to enable caching.

    cache: # optional, default is true

    # Used to specify the path to a dependency file - go.sum

    cache-dependency-path: # optional

    # Target architecture for Go to use. Examples: x86, x64. Will use system architecture by default.

    architecture: # optional
    
    - name: Download a Build Artifact

  uses: actions/download-artifact@v2.1.1

  with:

    # Artifact name

    name: # optional

    # Destination path

    path: # optional