ci.yml

name: tests

on: [push, pull_request]

# Nothing here reads an issue, writes a comment or publishes anything. Say so,
# rather than inheriting whatever the repository default happens to be.
permissions:
  contents: read

# Pushing twice in a minute should not leave the first run burning a runner.
# Not on main, though: cancelling there leaves the commit that was superseded
# with a cancelled check against it forever, which reads like a failure in the
# commit list.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

jobs:
  host-suites:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      # Nothing to install: the suites are plain host C++ built against the stub
      # headers in test/stubs/. The Teensy firmware image is deliberately not
      # built here - nothing in this repo has ever been built for a Teensy, and
      # pretending otherwise in CI would be the fastest way to make this file a
      # lie. No CXX override either, so this is the same command the README
      # tells you to run, on the runner's own g++.
      - name: Run the host test suites
        run: ./run_tests.sh

  sanitizers:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      # The same five suites rebuilt under ASan and UBSan. A separate job rather
      # than an extra step on the one above: it answers a different question, and
      # a memory or arithmetic fault should get its own line in the checks list
      # instead of hiding at the bottom of a build that otherwise passed.
      - name: Run the host test suites under ASan and UBSan
        run: ./run_tests.sh --sanitize