CodeQL workflow (sanic-org/sanic)

The CodeQL workflow from sanic-org/sanic, explained and optimized by Latchkey.

What it does

This is the CodeQL workflow from the sanic-org/sanic 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

name: "CodeQL"

on:
  push:
    branches:
      - main
      - current-release
      - "*LTS"
  pull_request:
    branches:
      - main
      - current-release
      - "*LTS"
    types: [opened, synchronize, reopened, ready_for_review]
  schedule:
    - cron: '25 16 * * 0'

jobs:
  analyze:
    if: github.event.pull_request.draft == false
    name: Analyze
    runs-on: ubuntu-latest

    strategy:
      fail-fast: false
      matrix:
        language: [ 'python' ]

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

    - name: Initialize CodeQL
      uses: github/codeql-action/init@v1
      with:
        languages: ${{ matrix.language }}

    - name: Autobuild
      uses: github/codeql-action/autobuild@v1

    - name: Perform CodeQL Analysis
      uses: github/codeql-action/analyze@v1

The same workflow, on Latchkey

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

name: "CodeQL"
 
on:
  push:
    branches:
      - main
      - current-release
      - "*LTS"
  pull_request:
    branches:
      - main
      - current-release
      - "*LTS"
    types: [opened, synchronize, reopened, ready_for_review]
  schedule:
    - cron: '25 16 * * 0'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  analyze:
    timeout-minutes: 30
    if: github.event.pull_request.draft == false
    name: Analyze
    runs-on: latchkey-small
 
    strategy:
      fail-fast: false
      matrix:
        language: [ 'python' ]
 
    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
 
    - name: Initialize CodeQL
      uses: github/codeql-action/init@v1
      with:
        languages: ${{ matrix.language }}
 
    - name: Autobuild
      uses: github/codeql-action/autobuild@v1
 
    - name: Perform CodeQL Analysis
      uses: github/codeql-action/analyze@v1
 

What changed

• Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. This example uses latchkey-small; pick the runner size that fits the job.
• Cancel superseded runs when a branch or PR gets a newer push.
• Add a job timeout so a hung step cannot burn hours of runner time.

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

Actions used in this workflow