vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

ci: split an error-only vale check out of the full prose-lint job

Browse source 
mara, on #4128: add a CI step (separate from the existing one) that
only flags error-level vale hits, so it can be made a required check
without also gating merges on the pre-existing warning/suggestion
backlog. The full job stays as-is, advisory, for that backlog.

Also brought docs/scheduler/ci.md's CI-checks table back in sync with
reality (it was missing the doc-pointer lint job already; now lists
both vale jobs and their required-check status).
This commit is contained in:
iris 2026-09-09 21:08:31 +02:00 • committed by mara
commit c13499c839
2 changed files with 43 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

31
.forgejo/workflows/ci.yml
View file

@ -80,10 +80,29 @@ jobs:
# `Packages` line) are fetched fresh from the Vale Package Hub each # `Packages` line) are fetched fresh from the Vale Package Hub each
# run rather than vendored, so this job always lints against # run rather than vendored, so this job always lints against
# upstream's current rules. Failing red on a hit is intentional -- # upstream's current rules. Failing red on a hit is intentional --
# the existing docs/ tree has a real backlog against these rules # the existing docs/ tree has a standing backlog of warning- and
# (663 hits as of this writing), so this job starts out red on # suggestion-level rule hits, so this job stays red on unrelated
# unrelated PRs until that backlog is worked down. Not (yet) wired # PRs until that backlog is worked down (tracked separately from
# into branch protection as a required check, so a red result here # #4128, which was scoped to error-level hits only). Not wired
# doesn't block a merge -- opting it into required-check status is # into branch protection -- see the sibling job below for the
# a separate, later call. # error-only slice that is.
run: XDG_DATA_HOME="$PWD/.vale-data" nix shell nixpkgs#vale --command sh -c 'vale sync && vale docs' run: XDG_DATA_HOME="$PWD/.vale-data" nix shell nixpkgs#vale --command sh -c 'vale sync && vale docs'
prose-lint-errors:
name: prose lint (vale, errors)
runs-on: [hive-ci]
# Own `vale sync` rather than reusing the sibling job's: each job gets
# a fresh checkout/environment, so there is nothing to share between
# them without an artifact-upload step this doesn't need.
timeout-minutes: 5
steps:
- uses: actions/checkout@v3
- name: lint
# The error-level-only slice of the sibling job above.
# `--minAlertLevel=error` changes what vale both reports AND exits
# non-zero on, so this job's pass/fail tracks only error-severity
# rule hits, not the warning/suggestion backlog the sibling job
# carries. Split out (#4128) so this one alone can be a required
# check (forge branch protection) without blocking merges on the
# pre-existing backlog the sibling job still surfaces.
run: XDG_DATA_HOME="$PWD/.vale-data" nix shell nixpkgs#vale --command sh -c 'vale sync && vale --minAlertLevel=error docs'

26
docs/scheduler/ci.md
View file

@ -31,16 +31,24 @@ writeup.
## CI checks ## CI checks
Three jobs run on every PR (and on `workflow_dispatch` for manual re-triggers), Several jobs run on every PR (and on `workflow_dispatch` for manual
defined in [`.forgejo/workflows/ci.yml`](../../.forgejo/workflows/ci.yml). All re-triggers), defined in
three are required checks (forge branch protection) — a hit on any of them [`.forgejo/workflows/ci.yml`](../../.forgejo/workflows/ci.yml). The first four
blocks merge. below are required checks (forge branch protection) — a hit on any of them
blocks merge. The two vale jobs split a single check in two (#4128): the
error-only one exists so it _can_ become a required check without also
gating on the full job's standing warning/suggestion backlog, but flipping
that switch on the forge is a separate operator action, not something this
table can assert ahead of it happening.
| Job | What it runs | | Job | What it runs | Required? |
| ---------------------- | --------------------------------------------------------------------------------- | | ----------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------- |
| **nix flake check** | treefmt formatting, `cargo clippy -D warnings`, `cargo test`, module evaluation | | **nix flake check** | treefmt formatting, `cargo clippy -D warnings`, `cargo test`, module evaluation | yes |
| **tracker-tag lint** | flags `#NNN` issue tags in source and comments (`scripts/check-issue-refs.sh`) | | **tracker-tag lint** | flags `#NNN` issue tags in source and comments (`scripts/check-issue-refs.sh`) | yes |
| **comment-block lint** | flags contiguous comment blocks over 30 lines (`scripts/check-comment-blocks.sh`) | | **comment-block lint** | flags contiguous comment blocks over 30 lines (`scripts/check-comment-blocks.sh`) | yes |
| **doc-pointer lint** | flags `docs/…md` paths and relative markdown links that no longer resolve (`scripts/check-doc-refs.sh`) | yes |
| **prose lint (vale, errors)** | vale, `docs/` tree, error-severity rule hits only | not yet — intended to be |
| **prose lint (vale)** | vale, `docs/` tree, full severity range (warnings + suggestions too) | no — advisory, standing backlog |
`hive-forge ci-rerun --pr N` dispatches a `workflow_dispatch` retrigger `hive-forge ci-rerun --pr N` dispatches a `workflow_dispatch` retrigger
without an empty commit. without an empty commit.