CodeQL workflow (pikepdf/pikepdf)

The CodeQL workflow from pikepdf/pikepdf, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, 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: pikepdf/pikepdf.github/workflows/codeql-analysis.ymlLicense MPL-2.0View source

What it does

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

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

The workflow

workflow (.yml)

# SPDX-FileCopyrightText: 2023 James R. Barlow
# SPDX-License-Identifier: MPL-2.0

name: "CodeQL"

on:
  push:
    branches: ["main", "codeql"]
  pull_request:
    branches: ["main"]
  schedule:
    - cron: "30 14 * * 1"

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

    strategy:
      fail-fast: false
      matrix:
        language: ["cpp", "python"]

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: "0"

      - uses: actions/setup-python@v5
        name: Install Python
        with:
          python-version: "3.10"

      - name: Install tomli and read environment from pyproject.toml
        run: |
          python -m pip install tomli
          python build-scripts/environ-from-pyproject.py >> $GITHUB_ENV

      - name: Install apt packages
        run: |
          sudo apt-get update
          sudo apt-get install -y libjpeg-dev

      - name: Download and build QPDF source and libraries
        run: |
          build-scripts/posix-download-qpdf.bash $QPDF_VERSION
          echo "/usr/local/lib" | sudo tee /etc/ld.so.conf.d/local-lib.conf
          build-scripts/posix-build-sdist-deps.bash

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

      - name: Build wheel under CodeQL analysis
        run: |
          python -m pip install --upgrade pip
          python -m pip install --upgrade setuptools wheel build
          python -m build --wheel

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

The same workflow, on Latchkey

Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.

# SPDX-FileCopyrightText: 2023 James R. Barlow
# SPDX-License-Identifier: MPL-2.0
 
name: "CodeQL"
 
on:
  push:
    branches: ["main", "codeql"]
  pull_request:
    branches: ["main"]
  schedule:
    - cron: "30 14 * * 1"
 
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: ["cpp", "python"]
 
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: "0"
 
      - uses: actions/setup-python@v5
        name: Install Python
        with:
          cache: 'pip'
          python-version: "3.10"
 
      - name: Install tomli and read environment from pyproject.toml
        run: |
          python -m pip install tomli
          python build-scripts/environ-from-pyproject.py >> $GITHUB_ENV
 
      - name: Install apt packages
        run: |
          sudo apt-get update
          sudo apt-get install -y libjpeg-dev
 
      - name: Download and build QPDF source and libraries
        run: |
          build-scripts/posix-download-qpdf.bash $QPDF_VERSION
          echo "/usr/local/lib" | sudo tee /etc/ld.so.conf.d/local-lib.conf
          build-scripts/posix-build-sdist-deps.bash
 
      - name: Initialize CodeQL
        uses: github/codeql-action/init@v3
        with:
          languages: ${{ matrix.language }}
 
      - name: Build wheel under CodeQL analysis
        run: |
          python -m pip install --upgrade pip
          python -m pip install --upgrade setuptools wheel build
          python -m build --wheel
 
      - name: Perform CodeQL Analysis
        uses: github/codeql-action/analyze@v3
        with:
          category: "/language:${{matrix.language}}"

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.
Cache dependency installs on the setup step so they are served from cache.
Add a job timeout so a hung step cannot burn hours of runner time.

What Latchkey heals here

This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:

Dependency installs

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

actions/checkout actions/setup-python github/codeql-action