NAME

repomatic job-timings - Measure how long each runner image takes, from finished runs

SYNOPSIS

repomatic job-timings [OPTIONS]

DESCRIPTION

Report median whole-job wall-clock per runner image.

Runner choice is supposed to rest on measurement, and the measurement that matters is whole-job: this repository once kept a lean image for years on a benchmark that timed only the tool pass, where it looked near-parity, while end to end it was 20-56% slower. The jobs API reports start and end timestamps, so what this reads is whole-job by construction.

Only successful runs are sampled, because a failed run's jobs stop early and time where the failure landed rather than what the image costs. The figure is a median across several runs, which is what turns a queue stall into noise instead of a verdict.

OPTIONS

--workflow WORKFLOW: Workflow file whose runs to sample, from .github/workflows/.
[values: autofix.yaml, autolock.yaml, cancel-runs.yaml, changelog.yaml, debug.yaml, docs.yaml, labels.yaml, lint.yaml, metrics.yaml, release.yaml, self-maintenance.yaml, tests.yaml, unsubscribe.yaml]
--branch TEXT: Branch whose runs to sample.
--limit INTEGER: How many recent successful runs to sample.
--output FILE: Write the report as a Markdown table to this file, for documentation.
--sort-by [runner|jobs|median|slowest-job|slowest]: Sort table by this column. Repeat to set priority.
--help / -h: Show this message and exit.

ENVIRONMENT

JOB_TIMINGS_WORKFLOW: Workflow file whose runs to sample, from .github/workflows/.
JOB_TIMINGS_BRANCH: Branch whose runs to sample.
JOB_TIMINGS_LIMIT: How many recent successful runs to sample.
JOB_TIMINGS_OUTPUT: Write the report as a Markdown table to this file, for documentation.
JOB_TIMINGS_SORT_BY: Sort table by this column. Repeat to set priority.
JOB_TIMINGS__CLICK_DEFAULT_HELP: Show this message and exit.

EXIT STATUS

0: Success.
1: A runtime error, an aborted prompt (Ctrl-D), or a declined confirmation.
2: A usage error: unknown option, invalid value, missing operand, or an unparsable configuration file.
130: Interrupted with Ctrl-C: the process ends by SIGINT, reported as 130.

EXAMPLES

Which image is holding the matrix up

repomatic job\-timings

A wider sample, written out for documentation

repomatic job\-timings \-\-limit 10 \-\-output timings.md

AUTHORS

Kevin Deldycke