Skip to content
Latchkey

CodeQL workflow (PowerDNS-Admin/PowerDNS-Admin)

The CodeQL workflow from PowerDNS-Admin/PowerDNS-Admin, explained and optimized by Latchkey.

C

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →
Source: PowerDNS-Admin/PowerDNS-Admin.github/workflows/codeql-analysis.ymlLicense MITView source

What it does

This is the CodeQL workflow from the PowerDNS-Admin/PowerDNS-Admin repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.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:
  workflow_dispatch:
  push:
    branches:
      - 'dev'
      - 'main'
      - 'master'
      - 'dependabot/**'
      - 'feature/**'
      - 'issue/**'
    paths-ignore:
      - .github/**
      - deploy/**
      - docker/**
      - docker-test/**
      - docs/**
      - powerdnsadmin/static/assets/**
      - powerdnsadmin/static/custom/css/**
      - powerdnsadmin/static/img/**
      - powerdnsadmin/swagger-spec.yaml
      - .dockerignore
      - .gitattributes
      - .gitignore
      - .lgtm.yml
      - .whitesource
      - .yarnrc
      - docker-compose.yml
      - docker-compose-test.yml
      - LICENSE
      - package.json
      - README.md
      - requirements.txt
      - SECURITY.md
      - yarn.lock
  pull_request:
    # The branches below must be a subset of the branches above
    branches:
      - 'dev'
      - 'main'
      - 'master'
      - 'dependabot/**'
      - 'feature/**'
      - 'issue/**'
    paths-ignore:
      - .github/**
      - deploy/**
      - docker/**
      - docker-test/**
      - docs/**
      - powerdnsadmin/static/assets/**
      - powerdnsadmin/static/custom/css/**
      - powerdnsadmin/static/img/**
      - powerdnsadmin/swagger-spec.yaml
      - .dockerignore
      - .gitattributes
      - .gitignore
      - .lgtm.yml
      - .whitesource
      - .yarnrc
      - docker-compose.yml
      - docker-compose-test.yml
      - LICENSE
      - package.json
      - README.md
      - requirements.txt
      - SECURITY.md
      - yarn.lock
  schedule:
    - cron: '45 2 * * 2'

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

    strategy:
      fail-fast: false
      matrix:
        language: [ 'javascript', '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

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

---
# 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:
  workflow_dispatch:
  push:
    branches:
      - 'dev'
      - 'main'
      - 'master'
      - 'dependabot/**'
      - 'feature/**'
      - 'issue/**'
    paths-ignore:
      - .github/**
      - deploy/**
      - docker/**
      - docker-test/**
      - docs/**
      - powerdnsadmin/static/assets/**
      - powerdnsadmin/static/custom/css/**
      - powerdnsadmin/static/img/**
      - powerdnsadmin/swagger-spec.yaml
      - .dockerignore
      - .gitattributes
      - .gitignore
      - .lgtm.yml
      - .whitesource
      - .yarnrc
      - docker-compose.yml
      - docker-compose-test.yml
      - LICENSE
      - package.json
      - README.md
      - requirements.txt
      - SECURITY.md
      - yarn.lock
  pull_request:
    # The branches below must be a subset of the branches above
    branches:
      - 'dev'
      - 'main'
      - 'master'
      - 'dependabot/**'
      - 'feature/**'
      - 'issue/**'
    paths-ignore:
      - .github/**
      - deploy/**
      - docker/**
      - docker-test/**
      - docs/**
      - powerdnsadmin/static/assets/**
      - powerdnsadmin/static/custom/css/**
      - powerdnsadmin/static/img/**
      - powerdnsadmin/swagger-spec.yaml
      - .dockerignore
      - .gitattributes
      - .gitignore
      - .lgtm.yml
      - .whitesource
      - .yarnrc
      - docker-compose.yml
      - docker-compose-test.yml
      - LICENSE
      - package.json
      - README.md
      - requirements.txt
      - SECURITY.md
      - yarn.lock
  schedule:
    - cron: '45 2 * * 2'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  analyze:
    timeout-minutes: 30
    name: Analyze
    runs-on: latchkey-small
    permissions:
      actions: read
      contents: read
      security-events: write
 
    strategy:
      fail-fast: false
      matrix:
        language: [ 'javascript', '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
 

What changed

This workflow runs 1 job (2 with the matrix expanded) per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow