mirror of
https://github.com/kuhyx/testsAndMisc.git
synced 2026-11-22 22:12:26 +01:00
ci: split pre-commit into hook groups, uv installs, xdist, parallel shell jobs
Some checks are pending
dependency freshness / dependencies on newest stable (push) Waiting to run
md-naming / markdown naming convention (push) Waiting to run
Pre-commit checks / pre-commit (${{ matrix.group }}) (mypy, mypy) (push) Waiting to run
Pre-commit checks / pre-commit (${{ matrix.group }}) (pylint, pylint) (push) Waiting to run
Pre-commit checks / pre-commit (${{ matrix.group }}) (rest, ) (push) Waiting to run
Pre-commit checks / pre-commit (${{ matrix.group }}) (shellcheck, shellcheck) (push) Waiting to run
Python tests / test (push) Waiting to run
Shell tests / shell-tests (push) Waiting to run
Shell tests / lib-tests (push) Waiting to run
Shell tests / arch-tests (push) Waiting to run
Some checks are pending
dependency freshness / dependencies on newest stable (push) Waiting to run
md-naming / markdown naming convention (push) Waiting to run
Pre-commit checks / pre-commit (${{ matrix.group }}) (mypy, mypy) (push) Waiting to run
Pre-commit checks / pre-commit (${{ matrix.group }}) (pylint, pylint) (push) Waiting to run
Pre-commit checks / pre-commit (${{ matrix.group }}) (rest, ) (push) Waiting to run
Pre-commit checks / pre-commit (${{ matrix.group }}) (shellcheck, shellcheck) (push) Waiting to run
Python tests / test (push) Waiting to run
Shell tests / shell-tests (push) Waiting to run
Shell tests / lib-tests (push) Waiting to run
Shell tests / arch-tests (push) Waiting to run
Target: every push workflow <= 60 s. No check removed or weakened. - Pre-commit checks (164 s): mypy, pylint and shellcheck each get a matrix job, everything else runs in `rest` with SKIP=<those three> (pytest-coverage stays skipped everywhere, as before). The full requirements.txt install (49 s, plus the SDL headers for a pygame source build) is replaced by `pre-commit pyyaml packaging` -- the only third-party imports of the language: system hooks. Per-group pre-commit cache with same-interpreter restore-keys; SDL headers only on a pylint env rebuild; zsh only in rest; shellcheck only in its group. - Python tests (87 s): setup-uv with a cached wheel store instead of pip, pytest -n auto -q -p no:sugar (2051 tests, 100.00% under xdist locally across three seeds), apt install tried before `apt-get update`. - Shell tests (63 s): the lib/tests runner loop moves to its own job so it overlaps with bats and the side-effect-free tests; runners still run sequentially within it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KFwA9nymhUdTrVF65kigTV
This commit is contained in:
parent
8f8a1d8059
commit
c50be1ee7f
158
.github/workflows/pre-commit.yml
vendored
158
.github/workflows/pre-commit.yml
vendored
@ -11,14 +11,39 @@ on:
|
|||||||
workflow_dispatch: {}
|
workflow_dispatch: {}
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
# mypy (~24 s), shellcheck (~24 s) and pylint (~18 s) each walk the whole
|
||||||
|
# repo and made up most of a single ~82 s hook step; every other hook
|
||||||
|
# together is ~15 s. Each heavy hook gets its own runner and the rest share a
|
||||||
|
# fourth, so the workflow takes as long as the slowest group rather than the
|
||||||
|
# sum. The four groups together run exactly the hook set the single job ran.
|
||||||
pre-commit:
|
pre-commit:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- group: mypy
|
||||||
|
hooks: mypy
|
||||||
|
- group: pylint
|
||||||
|
hooks: pylint
|
||||||
|
- group: shellcheck
|
||||||
|
hooks: shellcheck
|
||||||
|
- group: rest
|
||||||
|
hooks: ""
|
||||||
|
name: pre-commit (${{ matrix.group }})
|
||||||
env:
|
env:
|
||||||
# The md-naming / file-length hooks are thin shims that exec the shared
|
# The md-naming / file-length hooks are thin shims that exec the shared
|
||||||
# gate out of the utils repo. A runner has no ~/src/utils, so without this
|
# gate out of the utils repo. A runner has no ~/src/utils, so without this
|
||||||
# checkout they fail with "shared gate not found" -- which is exactly
|
# checkout they fail with "shared gate not found" -- which is exactly
|
||||||
# how this workflow went red on 2026-08-24.
|
# how this workflow went red on 2026-08-24.
|
||||||
UTILS_ROOT: ${{ github.workspace }}/.utils
|
UTILS_ROOT: ${{ github.workspace }}/.utils
|
||||||
|
# SKIP=pytest-coverage: the Python tests workflow already runs the
|
||||||
|
# whole suite with the same 100% coverage gate, so running it again
|
||||||
|
# here doubled the cost of this job for no extra signal. It is the
|
||||||
|
# only hook skipped, and it is skipped because it is DUPLICATED, not
|
||||||
|
# because it is slow -- if that workflow is ever removed, drop this.
|
||||||
|
# `rest` also skips the three hooks that run in their own group above.
|
||||||
|
SKIP: ${{ matrix.group == 'rest' && 'pytest-coverage,mypy,pylint,shellcheck' || 'pytest-coverage' }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
@ -28,33 +53,83 @@ jobs:
|
|||||||
repository: kuhyx/utils
|
repository: kuhyx/utils
|
||||||
path: .utils
|
path: .utils
|
||||||
|
|
||||||
|
# No `cache: pip` any more: it restored a 367 MB pip cache for the full
|
||||||
|
# requirements.txt, which this job no longer installs.
|
||||||
- uses: actions/setup-python@v5
|
- uses: actions/setup-python@v5
|
||||||
id: setup-python
|
id: setup-python
|
||||||
with:
|
with:
|
||||||
python-version: "3.x"
|
python-version: "3.x"
|
||||||
# See the note in python-tests.yml: caches the pip download cache,
|
- uses: astral-sh/setup-uv@v10.2.0
|
||||||
# keyed on the real meta/ path rather than the root symlink.
|
|
||||||
cache: pip
|
|
||||||
cache-dependency-path: meta/requirements.txt
|
|
||||||
|
|
||||||
# zsh backs the zsh-syntax hook. apt does not let a patch release be
|
# Every hook brings its own environment except the `language: system`
|
||||||
# selected, so this is pinned only to what the runner image provides;
|
# ones, and of those only dependency-freshness imports third-party code
|
||||||
# the version is echoed so a jump shows up in the log rather than as a
|
# (pyyaml, packaging); check_requirements_sync.py, the evidence/contract
|
||||||
# mystery parse difference. Local machines compare on major.minor only.
|
# validators and the session_autopsy mutation hook are stdlib-only. The
|
||||||
- name: Install system dependencies
|
# full requirements.txt (~90 packages, a pygame source build included)
|
||||||
|
# used to be installed here for nothing: 49 s of every run.
|
||||||
|
- name: Install pre-commit and the system hooks' imports
|
||||||
|
run: uv pip install --system pre-commit pyyaml packaging
|
||||||
|
|
||||||
|
# pre-commit builds a virtualenv per hook repo on first use, which is
|
||||||
|
# slower than the pip install itself. Keyed on the hook definitions, so
|
||||||
|
# it invalidates exactly when a hook's repo or rev changes.
|
||||||
|
# The interpreter goes in the key, resolved rather than typed. A
|
||||||
|
# `language: python` hook env is built by whichever Python pre-commit ran
|
||||||
|
# under, and restoring one built by a different release is silent: the
|
||||||
|
# hooks keep working right up to the first syntax the old interpreter
|
||||||
|
# cannot parse. This key said `py3.12` as a literal while the job had
|
||||||
|
# moved to `3.x`, so 3.14-only source (PEP 758's `except A, B:`) reached
|
||||||
|
# pylint and the debug-statement hook running on a cached 3.12.14 and
|
||||||
|
# came back as "multiple exception types must be parenthesized" -- a
|
||||||
|
# failure with no local reproduction, since developer caches were built
|
||||||
|
# on 3.14. `steps.setup-python.outputs.python-version` cannot drift from
|
||||||
|
# what was actually installed.
|
||||||
|
#
|
||||||
|
# One cache per group: a shared key would hold whichever group saved
|
||||||
|
# first, and the others would rebuild their hook envs on every run. The
|
||||||
|
# restore-keys fall back to any env set built by the SAME interpreter
|
||||||
|
# (this group's older config first, then any group's), so a config
|
||||||
|
# change rebuilds only the hooks whose rev moved.
|
||||||
|
- uses: actions/cache@v4
|
||||||
|
id: cache
|
||||||
|
with:
|
||||||
|
path: ~/.cache/pre-commit
|
||||||
|
key: >-
|
||||||
|
pre-commit-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ matrix.group }}-${{ hashFiles('.pre-commit-config.yaml') }}
|
||||||
|
restore-keys: |
|
||||||
|
pre-commit-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ matrix.group }}-
|
||||||
|
pre-commit-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-
|
||||||
|
|
||||||
|
# zsh backs the zsh-syntax hook, which only the rest group runs. apt
|
||||||
|
# does not let a patch release be selected, so this is pinned only to
|
||||||
|
# what the runner image provides; the version is echoed so a jump shows
|
||||||
|
# up in the log rather than as a mystery parse difference. Local
|
||||||
|
# machines compare on major.minor only.
|
||||||
|
#
|
||||||
|
# The runner image ships apt lists, so the install is tried against
|
||||||
|
# them first; `apt-get update` (~14 s) runs only if that fails.
|
||||||
|
- name: Install system dependencies (zsh)
|
||||||
|
if: matrix.group == 'rest'
|
||||||
run: |
|
run: |
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
sudo apt-get update
|
pkgs=(zsh)
|
||||||
# The SDL headers are for pygame. 2.6.1 is the newest release and its
|
sudo apt-get install -y "${pkgs[@]}" ||
|
||||||
# wheels stop at cp313, so on newest-stable Python pip falls back to a
|
{ sudo apt-get update && sudo apt-get install -y "${pkgs[@]}"; }
|
||||||
# source build -- which dies on a missing `sdl-config` unless these are
|
|
||||||
# here. Every repo runs exactly one Python and it is the newest, so the
|
|
||||||
# build gets what it needs rather than the job being held back.
|
|
||||||
sudo apt-get install -y zsh librsvg2-bin \
|
|
||||||
libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev \
|
|
||||||
libfreetype6-dev libportmidi-dev
|
|
||||||
zsh --version
|
zsh --version
|
||||||
rsvg-convert --version
|
|
||||||
|
# The SDL headers are for pygame, one of pylint's additional_dependencies.
|
||||||
|
# 2.6.1 is the newest release and its wheels stop at cp313, so on
|
||||||
|
# newest-stable Python pip falls back to a source build -- which dies on
|
||||||
|
# a missing `sdl-config` unless these are here. Only a pylint env BUILD
|
||||||
|
# needs them, so an exact cache hit skips the step.
|
||||||
|
- name: Install pygame build headers (pylint env build only)
|
||||||
|
if: matrix.group == 'pylint' && steps.cache.outputs.cache-hit != 'true'
|
||||||
|
run: |
|
||||||
|
set -euo pipefail
|
||||||
|
pkgs=(libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev
|
||||||
|
libfreetype6-dev libportmidi-dev)
|
||||||
|
sudo apt-get install -y "${pkgs[@]}" ||
|
||||||
|
{ sudo apt-get update && sudo apt-get install -y "${pkgs[@]}"; }
|
||||||
|
|
||||||
# Pin shellcheck instead of inheriting whatever ubuntu-latest ships.
|
# Pin shellcheck instead of inheriting whatever ubuntu-latest ships.
|
||||||
#
|
#
|
||||||
@ -69,6 +144,7 @@ jobs:
|
|||||||
# Keep SHELLCHECK_VERSION in step with the version developers install;
|
# Keep SHELLCHECK_VERSION in step with the version developers install;
|
||||||
# the verification below fails loudly rather than silently drifting.
|
# the verification below fails loudly rather than silently drifting.
|
||||||
- name: Install shellcheck (pinned)
|
- name: Install shellcheck (pinned)
|
||||||
|
if: matrix.group == 'shellcheck'
|
||||||
env:
|
env:
|
||||||
SHELLCHECK_VERSION: v0.11.0
|
SHELLCHECK_VERSION: v0.11.0
|
||||||
SHELLCHECK_SHA256: 8c3be12b05d5c177a04c29e3c78ce89ac86f1595681cab149b65b97c4e227198
|
SHELLCHECK_SHA256: 8c3be12b05d5c177a04c29e3c78ce89ac86f1595681cab149b65b97c4e227198
|
||||||
@ -96,8 +172,10 @@ jobs:
|
|||||||
# the expected version of every `language: system` tool, and so a future
|
# the expected version of every `language: system` tool, and so a future
|
||||||
# workflow that does run them inherits the pin instead of re-deriving
|
# workflow that does run them inherits the pin instead of re-deriving
|
||||||
# it. Their real divergence risk is between developers: both REWRITE
|
# it. Their real divergence risk is between developers: both REWRITE
|
||||||
# files, so two versions reformat the repo back and forth.
|
# files, so two versions reformat the repo back and forth. Installed in
|
||||||
|
# one group only; the other three would be paying for it twice over.
|
||||||
- name: Install prettier and shfmt (pinned)
|
- name: Install prettier and shfmt (pinned)
|
||||||
|
if: matrix.group == 'rest'
|
||||||
env:
|
env:
|
||||||
PRETTIER_VERSION: 3.9.5
|
PRETTIER_VERSION: 3.9.5
|
||||||
SHFMT_VERSION: v3.13.1
|
SHFMT_VERSION: v3.13.1
|
||||||
@ -125,36 +203,12 @@ jobs:
|
|||||||
fi
|
fi
|
||||||
echo "prettier ${prettier_installed} and shfmt ${shfmt_installed} pinned and on PATH"
|
echo "prettier ${prettier_installed} and shfmt ${shfmt_installed} pinned and on PATH"
|
||||||
|
|
||||||
# pre-commit builds a virtualenv per hook repo on first use, which is
|
- name: pre-commit run (${{ matrix.group }})
|
||||||
# slower than the pip install itself. Keyed on the hook definitions, so
|
run: pre-commit run ${{ matrix.hooks }} --all-files --show-diff-on-failure
|
||||||
# it invalidates exactly when a hook's repo or rev changes.
|
|
||||||
# The interpreter goes in the key, resolved rather than typed. A
|
|
||||||
# `language: python` hook env is built by whichever Python pre-commit ran
|
|
||||||
# under, and restoring one built by a different release is silent: the
|
|
||||||
# hooks keep working right up to the first syntax the old interpreter
|
|
||||||
# cannot parse. This key said `py3.12` as a literal while the job had
|
|
||||||
# moved to `3.x`, so 3.14-only source (PEP 758's `except A, B:`) reached
|
|
||||||
# pylint and the debug-statement hook running on a cached 3.12.14 and
|
|
||||||
# came back as "multiple exception types must be parenthesized" -- a
|
|
||||||
# failure with no local reproduction, since developer caches were built
|
|
||||||
# on 3.14. `steps.setup-python.outputs.python-version` cannot drift from
|
|
||||||
# what was actually installed.
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: ~/.cache/pre-commit
|
|
||||||
key: >-
|
|
||||||
pre-commit-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('.pre-commit-config.yaml') }}
|
|
||||||
|
|
||||||
- name: Install dependencies
|
# A cache restored through restore-keys is saved again under this
|
||||||
run: |
|
# group's key, so without this the envs of every hook rev ever used
|
||||||
python -m pip install --upgrade pip
|
# would ride along forever. gc drops the ones the config no longer names.
|
||||||
pip install -r requirements.txt
|
- name: Prune stale hook envs before the cache is saved
|
||||||
pip install pre-commit
|
if: steps.cache.outputs.cache-hit != 'true'
|
||||||
|
run: pre-commit gc
|
||||||
- name: Run pre-commit hooks
|
|
||||||
# SKIP=pytest-coverage: the Python tests workflow already runs the
|
|
||||||
# whole suite with the same 100% coverage gate, so running it again
|
|
||||||
# here doubled the cost of this job for no extra signal. It is the
|
|
||||||
# only hook skipped, and it is skipped because it is DUPLICATED, not
|
|
||||||
# because it is slow -- if that workflow is ever removed, drop this.
|
|
||||||
run: SKIP=pytest-coverage pre-commit run --all-files --show-diff-on-failure
|
|
||||||
|
|||||||
40
.github/workflows/python-tests.yml
vendored
40
.github/workflows/python-tests.yml
vendored
@ -43,25 +43,33 @@ jobs:
|
|||||||
- uses: actions/setup-python@v5
|
- uses: actions/setup-python@v5
|
||||||
with:
|
with:
|
||||||
python-version: "3.x"
|
python-version: "3.x"
|
||||||
# Cache the pip DOWNLOAD cache, keyed on the requirements file, so a
|
# uv with a cached wheel store replaces pip + setup-python's pip cache.
|
||||||
# run that changes nothing about dependencies reuses the wheels
|
# Keyed on meta/requirements-test.txt, not the root requirements.txt
|
||||||
# instead of re-fetching ~80 packages from PyPI. Points at
|
# symlink: the key is hashed from the file at this path, and hashing a
|
||||||
# meta/requirements.txt, not the root symlink: the cache key is
|
# symlink is not the same as hashing its target.
|
||||||
# hashed from the file at this path, and hashing a symlink is not
|
- uses: astral-sh/setup-uv@v10.2.0
|
||||||
# the same as hashing its target.
|
with:
|
||||||
cache: pip
|
enable-cache: true
|
||||||
cache-dependency-path: meta/requirements-test.txt
|
cache-dependency-glob: meta/requirements-test.txt
|
||||||
|
# The runner image ships apt lists, so the install is tried against them
|
||||||
|
# first; `apt-get update` (~14 s of a 31 s step) runs only if that fails.
|
||||||
- name: Install system dependencies
|
- name: Install system dependencies
|
||||||
run: |
|
run: |
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
sudo apt-get update && sudo apt-get install -y librsvg2-bin
|
sudo apt-get install -y librsvg2-bin ||
|
||||||
|
{ sudo apt-get update && sudo apt-get install -y librsvg2-bin; }
|
||||||
rsvg-convert --version
|
rsvg-convert --version
|
||||||
|
# The TEST subset, not the full requirements.txt. This job runs pytest
|
||||||
|
# and nothing else, so the ~62 linters and formatters in the full list
|
||||||
|
# were pure install time. See meta/requirements-test.txt.
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: uv pip install --system -r meta/requirements-test.txt
|
||||||
python -m pip install --upgrade pip
|
# -n auto spreads the suite over every runner core (pytest-xdist is in
|
||||||
# The TEST subset, not the full requirements.txt. This job runs
|
# requirements-test.txt; pytest-cov merges the workers' coverage):
|
||||||
# pytest and nothing else, so the ~62 linters and formatters in the
|
# 26.8 s -> 13.8 s locally, same 2051 tests, same 100.00%. -q cancels
|
||||||
# full list were pure install time. See meta/requirements-test.txt.
|
# the -v in pyproject's addopts, so 2000+ PASSED lines are not streamed
|
||||||
pip install -r meta/requirements-test.txt
|
# to the log; -p no:sugar keeps pytest-sugar's redraws out of it too.
|
||||||
- name: Run pytest with coverage
|
- name: Run pytest with coverage
|
||||||
run: pytest --cov=python_pkg --cov-branch --cov-report=term-missing --cov-fail-under=100
|
run: >-
|
||||||
|
pytest -n auto -q -p no:sugar
|
||||||
|
--cov=python_pkg --cov-branch --cov-report=term-missing --cov-fail-under=100
|
||||||
|
|||||||
16
.github/workflows/shell-tests.yml
vendored
16
.github/workflows/shell-tests.yml
vendored
@ -12,8 +12,12 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
# The runner image ships apt lists, so the install is tried against them
|
||||||
|
# first; `apt-get update` runs only if that fails.
|
||||||
- name: Install bats
|
- name: Install bats
|
||||||
run: sudo apt-get update && sudo apt-get install -y bats
|
run: |
|
||||||
|
sudo apt-get install -y bats ||
|
||||||
|
{ sudo apt-get update && sudo apt-get install -y bats; }
|
||||||
|
|
||||||
- name: Run bats suites
|
- name: Run bats suites
|
||||||
run: bats linux_configuration/tests/*.bats
|
run: bats linux_configuration/tests/*.bats
|
||||||
@ -45,6 +49,16 @@ jobs:
|
|||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Split out of shell-tests, which ran it after the bats/side-effect-free
|
||||||
|
# steps: the ~39 s of runners was the whole job's critical path (59 s).
|
||||||
|
# On its own runner it overlaps with them instead. The runners themselves
|
||||||
|
# still run one after another -- some count execve calls or depend on
|
||||||
|
# timing, so running them concurrently would trade speed for flakes.
|
||||||
|
lib-tests:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
# The lib/tests/ suites that came out of the 250-line-cap splits. These
|
# The lib/tests/ suites that came out of the 250-line-cap splits. These
|
||||||
# are DISCOVERED rather than listed: every split adds another
|
# are DISCOVERED rather than listed: every split adds another
|
||||||
# lib/tests/run_all.sh, and a hardcoded list silently leaves each new
|
# lib/tests/run_all.sh, and a hardcoded list silently leaves each new
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user