hyperhive/.forgejo/workflows/coverage.yml
atlas 55eaebc9cf coverage: run nightly and keep the report as an artifact
The operator never received a coverage report. The job existed but was
`workflow_dispatch` only, so nothing had ever run it — "there is a CI job
for it" was true and produced nothing.

Its header argued against a schedule: an instrumented build roughly doubles
a test job, and a nightly number nobody reads is farm time for nothing. That
was a cost judgement, and it has been made differently. The comment changes
with the trigger rather than staying to contradict it.

The hour is deliberate: the runner's job capacity defaults to 1
(`services.hyperhive.deploy.forgejo.ci.concurrency`, applied as
`runner.capacity` in nix/host-modules/hive-ci.nix), so at that setting this
job holds the runner for its whole timeout and everything else queues.

`--summary-only` wrote into the run log, which is not a place anyone
receives anything. The summary is now teed to a file and uploaded, so a
scheduled run leaves a report to fetch. `if: always()` keeps the partial
output from a failed run.

`set -o pipefail` is load-bearing: without it the step's status is `tee`'s,
so a failed run would report success and upload an empty report. Verified
that shape rather than assuming it — without the guard a failing pipeline
exits 0, with it 1, and a succeeding one still exits 0.
2026-09-02 08:35:34 +02:00

49 lines
1.9 KiB
YAML

name: coverage
# Nightly plus manual dispatch. The report is uploaded as an artifact rather
# than printed into the run log, so a scheduled run leaves something to fetch.
#
# ⚠️ The hour is deliberate: at the default job capacity of 1
# (`services.hyperhive.deploy.forgejo.ci.concurrency`) this job holds the
# runner for its whole timeout and everything else queues behind it.
#
# Separate from ci.yml because a `workflow_dispatch` trigger there fires every
# job in that file, and this must not run per pull request.
on:
workflow_dispatch:
schedule:
- cron: "0 2 * * *"
jobs:
coverage:
name: cargo llvm-cov
runs-on: [hive-ci]
# Above the 30 min `nix flake check` allows, because instrumented
# builds are slower than the ordinary ones and this starts from a
# cache that the normal jobs never populate.
timeout-minutes: 60
steps:
- uses: actions/checkout@v3
- name: coverage
# No threshold and no `--fail-under-lines`: a coverage gate
# mostly teaches people to write assertion-free tests that
# execute lines. The report is the deliverable; the number is
# for a human to look at.
#
# `--workspace` because the interesting holes are in the crates
# nobody runs directly, and the per-crate default would hide
# exactly those behind a green summary for the one crate someone
# happened to name.
#
# `pipefail` or the step reports `tee`'s status, and a failed run
# uploads an empty report as a success.
run: |
set -o pipefail
nix develop -c cargo llvm-cov --workspace --summary-only | tee coverage-summary.txt
- name: keep the report
# `always()`: a failed run should still leave its partial output.
if: always()
uses: actions/upload-artifact@v3
with:
name: coverage-summary
path: coverage-summary.txt