Repository navigation
Releases
v0.21.1
What's Changed
- Read a job entry with a conclusion and a completed_at as completed by @FlexOr2 in #874
- Pin gate.yml's tool refs to v0.21.1 by @FlexOr2 in #876
Full Changelog: v0.21.0...v0.21.1
v0.21.0
What turns red
locator-text: a test that looks up a catalog text as a literal is a red finding, with no baseline. Find the element by its key through the generated catalog module instead (docs/rules.md, LOCATOR).fleet-source: a uv.lock that resolves anovernightworks-*package from an index is refused (docs/rules.md, SOURCE).image.ymlpassesSERVICE_VERSION=<version>to every build and refuses a callerbuild-argsline that sets it (docs/release.md, IMAGE-19).
What v0.21.0's quality check files turns red in each app's origin/main on 16.11.2026:
| App | Commit | catalog text |
|---|---|---|
| songmaker | 67ad08fa1 | 6 |
| hopin | 65cc5f3 | 6 |
| skat | e94d6d58 | 2 |
| presentator | 8923e7e2 | 0 |
No app's uv.lock resolves a fleet package from an index.
What's Changed
- Add the locator-text rule for catalog texts in Python test locators by @FlexOr2 in #864
- Read TypeScript and JavaScript test files in the locator-text rule by @FlexOr2 in #867
- Bake the release version into every image build as SERVICE_VERSION by @FlexOr2 in #871
- Refuse a fleet package a uv.lock resolves from an index by @FlexOr2 in #872
- Name v0.21.0 as locator-text's and fleet-source's first release and pin gate.yml to it by @FlexOr2 in #873
Full Changelog: v0.20.0...v0.21.0
v0.20.0
v0.19.0
Moving to v0.19.0
v0.19.0 moves the scanners the gate runs: zizmor 1.32.0, lizard 1.25.1, ruff 0.17.4, and the actions quality's workflows use. No covered repository turns red:
- zizmor 1.32.0 found 0 findings on the 18 gate callers and on quality, under 1.31.1 and 1.32.0 alike, over the same file set (#851).
- ruff 0.17.4 changes no
SorT20rule, the codespython-securityselects. - lizard 1.25 changes no Python cyclomatic complexity or function length, so no ceiling entry moves.
Pin form
uses: overnightworks/quality/.github/workflows/gate.yml@4fe26b24d60e131396278382692757d9056596ab # v0.19.0codeql.yml,release-gate.yml,image.ymlandrelease-tag.ymltake the same pin, with the same comment.- A repository below v0.18.0 reads the earlier pages first.
What changed
- Polish the merge door's tests and runbook after #825 by @FlexOr2 in #850
- Bump the actions group across 1 directory with 6 updates by @dependabot[bot] in #738
- Bump ruff from 0.17.3 to 0.17.4 by @dependabot[bot] in #822
- Bump lizard from 1.24.3 to 1.25.1 by @dependabot[bot] in #737
- Bump zizmor from 1.31.1 to 1.32.0 by @dependabot[bot] in #736
- Pin gate.yml's tool checkouts to v0.19.0 by @FlexOr2 in #853
Full Changelog: v0.18.0...v0.19.0
v0.18.0
Moving to v0.18.0
v0.18.0 changes only quality merge, the operator's door past a red gate. No check rule changes, so a covered app sees no new row.
Pin form
uses: overnightworks/quality/.github/workflows/gate.yml@505b0df999b4bab932aba53f3e3dea044066debe # v0.18.0codeql.yml,release-gate.yml,image.ymlandrelease-tag.ymltake the same pin, with the same comment.- A repository below v0.17.0 reads the earlier pages first.
What changed
The merge door checks the base branch's live tip (#825)
- Behind refused:
quality mergereads the base branch's live tip and compares it with the head. A head that lacks that tip is refused with abaserow. Itsnext:line namesgh pr update-branch, then a rerun once the checks are green (MERGE-103 to MERGE-105). - Verdict bound: the verdict's base side and the base-commit fetch use the tip that was compared, not the stale
pull.base.sha(MERGE-106). - Second read: after
yes, the door reads the base again before it touches the gate (MERGE-107). - Direct merge: the door merges by
PUT repos/<r>/pulls/<pr>/mergewith the head sha, the method and the message. It reportsmergedonly onmerged: trueand reads any other answer back (MERGE-30).
A repository whose base uses a merge queue is not yet read before the merge (#833).
What's Changed
- Let agents dispatch quality's release once review and CI are green by @FlexOr2 in #845
- The merge door refuses a head behind its base's tip and merges by a direct request by @FlexOr2 in #846
- Pin gate.yml's tool checkouts to v0.18.0 by @FlexOr2 in #849
Full Changelog: v0.17.0...v0.18.0
v0.17.0
Moving to v0.17.0
v0.17.0 adds the rule render-pass to the workflows area. It applies to a covered app with two or more catalogs: that app must name the CI job that renders each page once per language, and that job must be one of its mandatory jobs. An app with one catalog or none sees no change.
Pin form
uses: overnightworks/quality/.github/workflows/gate.yml@853a9545c26aaa884896223b87a2505d2b918e31 # v0.17.0codeql.yml,release-gate.yml,image.ymlandrelease-tag.ymltake the same pin, with the same comment.- A repository below v0.16.0 reads the earlier pages first.
What changed
render-pass: a named, mandatory render job
A covered repository with two or more catalogs must meet three conditions (RENDER-1 to RENDER-3):
- It declares the job in
quality/config.toml, in the table[languages]under the keyrender_pass, for examplerender_pass = "Render pages". The value is the job'sname:, or its id if it has no name. This is the same form[gate] mandatory_jobsuses. - A tracked workflow holds a job with that name.
[gate] mandatory_jobslists the same name.
A catalog is a tracked .po file directly in design's catalogs directory: [tool.design-catalogs] catalogs in the root pyproject.toml, else frontend/src/lib/catalogs.
The rule reports the first condition that fails as missing, at quality/config.toml:
N catalogs and no render pass declaredrender pass "x" is no job of a tracked workflowrender pass "x" is not a mandatory job
quality judges only that the job exists and gates the merge, never what it does. The checks inside the job (no key shown as text, the page's lang matches its language, no overflow) stay the app's own test.
The fleet matrix reads the cell from v0.17.0 on (FLEET-99). It is enforced where the app declares design's catalogs, and no catalogs declaration where it does not. Below v0.17.0 it reads not in <tag>.
Known gaps
- A render job split into a matrix cannot be green yet. The workflow file names the job
render, but the run lists one check per leg, such asrender (de). - A job in a called workflow has the same problem: the run lists it as
caller / job.
Both gaps wait for an app that needs them.
Order matters: bump and declare in one pull request
A release older than v0.17.0 refuses the table [languages] as an unknown table, which exits 2. v0.17.0 itself turns an app with two catalogs red until the table is there. So the pin bump and the declaration go in the same pull request.
What an app with two catalogs changes at its bump
This applies to presentator and skat. As of this release, neither has a per-language render job.
- Move the pins to the v0.17.0 commit, each with the
# v0.17.0comment. - Find the job that renders each page once per language. If no such job exists yet, add it first, as design's languages standard describes. Until it exists, the pin stays at v0.16.0: the bump would only turn the app red.
- Add
[languages]withrender_pass = "<that job's name>"toquality/config.toml, and add the same name to[gate] mandatory_jobs. - Run
quality check workflowsand confirm that there is norender-passrow.
hopin and songmaker hold one catalog each. They move their pins and change nothing else.
What's Changed
- Add the render-pass rule: two catalogs need a named, mandatory render job by @FlexOr2 in #840
- Name v0.17.0 as render-pass's first release and pin gate.yml to it by @FlexOr2 in #842
Full Changelog: v0.16.0...v0.17.0
v0.16.0
Moving to v0.16.0
v0.16.0 lets a covered app record a ceiling for the literal texts of its Svelte pages. Once the table is recorded, literal-text is enforced. Without the table, nothing changes: the rule only measures, as in v0.13.0 to v0.15.0, so the bump by itself turns nothing red.
Pin form
uses: overnightworks/quality/.github/workflows/gate.yml@24c8484f86eccd5da41f9e7177ebabe52ccf3fd1 # v0.16.0codeql.yml,release-gate.yml,image.ymlandrelease-tag.ymltake the same pin, with the comment.- A repository below v0.15.0 reads the earlier pages first.
What changed
literal-text: the [literal_text] table switches it on
quality/baseline.toml takes a [literal_text] table: one count per Svelte page, the path relative to the root as the key (LITERAL-5). Its presence is the switch, as [clones] is for clone. With the table:
- A page above its count is
grew, and a page with text and no entry isnew debt. Both are red. - A page below its count, or an entry whose page is gone, is
can fall.quality check --fixlowers it and never raises (LITERAL-6, LITERAL-7). - A renamed page carries its entry (LITERAL-13).
quality verdictreads a first table as an adoption. A removed table, or a raised or added entry, is a declared loosening (LITERAL-8).
The fleet matrix reads the cell as on main from v0.16.0 on (FLEET-102): enforced with the table, report-only without it.
Order matters: bump first
A release older than v0.16.0 refuses a ceiling file that holds [literal_text] (UnknownTable, exit 2, BASELINE-25). Its hint, "run the quality release your gate pins", points at the release that refused. So move every pin to v0.16.0 before the table is committed.
What a covered app changes at its bump
This applies to hopin, presentator, skat and songmaker.
- Move the pins to the v0.16.0 commit, each with the
# v0.16.0comment. - Run
quality check debt --fixwith v0.16.0. It records the measured counts as[literal_text](recorded K literal texts on P pages), or an empty table where no page holds a text. Commitquality/baseline.toml. - Run
quality checkand confirm the debt row readsliteral-textenforced, with no red row.
What's Changed
- The ceiling file holds a literal_text table, judged by check, lowered by --fix and held by the verdict by @FlexOr2 in #836
- Name v0.16.0 as the release of literal-text's switch and pin gate.yml to it by @FlexOr2 in #838
Full Changelog: v0.15.0...v0.16.0
v0.15.0
Moving to v0.15.0
v0.15.0 adds one optional input to codeql.yml and changes nothing else. No rule changes its behaviour or printed words, so a bump turns nothing red.
Pin form
uses: overnightworks/quality/.github/workflows/gate.yml@f3857b5e71a16a6ab88a628257c635086ddfff86 # v0.15.0codeql.yml,release-gate.yml,image.ymlandrelease-tag.ymltake the same pin, with the comment.- A repository below v0.13.0 reads v0.13.0's page first for the rules it meets there.
What changed
codeql.yml: an optional config-file
codeql.yml takes config-file (default empty), a path in the caller's checkout that it hands to codeql-action/init (CODEQL-3, docs/codeql.md). Empty, the run uses CodeQL's defaults, as before. A CodeQL exception lives in that file with its reason in a comment beside it, in the narrowest form: paths-ignore for the one file, not a directory and not a query across the repository.
What a caller changes at its bump
- Move the pins to the v0.15.0 commit, each with the
# v0.15.0comment. - Only for a reasoned CodeQL exception: add the config file and pass
config-file: <its path>to thecodeql.ymlcall.
What's Changed
- codeql.yml takes an optional config-file input and hands it to init by @FlexOr2 in #831
- Name v0.15.0 as the release of codeql.yml's config-file input and pin gate.yml to it by @FlexOr2 in #834
Full Changelog: v0.14.0...v0.15.0
v0.14.0
Moving to v0.14.0
v0.14.0 adds one optional input to image.yml and changes nothing else. No rule changes its behaviour or printed words, so a bump turns nothing red.
Pin form
uses: overnightworks/quality/.github/workflows/gate.yml@eb140c397e83b8ec4e9ee849453d14efeef4e787 # v0.14.0codeql.yml,release-gate.yml,image.ymlandrelease-tag.ymltake the same pin, with the comment.- A repository below v0.13.0 reads v0.13.0's page first for the rules it meets there.
What changed
image.yml: an optional runner
image.yml takes runner (default ubuntu-latest), and its image job runs on it, so a caller can build an image that a standard runner's disk cannot hold on a larger GitHub-hosted runner (IMAGE-18, docs/release.md). Permissions, steps, the attestation and the 60-minute job timeout are unchanged.
What a caller changes at its bump
- Move the pins to the v0.14.0 commit, each with the
# v0.14.0comment. - Only for an image too large for a standard runner: pass
runner: <your larger runner's label>to that image job.
What's Changed
- image.yml takes an optional runner for an image a standard runner cannot hold by @FlexOr2 in #827
- Name v0.14.0 as the release of image.yml's runner input and pin gate.yml to it by @FlexOr2 in #829
Full Changelog: v0.13.0...v0.14.0
v0.13.0
Moving to v0.13.0
v0.13.0 turns catalog-check from a note into an enforcing rule, and it is the first release of literal-text. The first can turn a repository red at its bump: a repository that declares overnightworks-design[catalogs] and whose pull-request workflows never call design-catalogs --check now gets a finding and exit 1. The second only measures and never turns anything red. A repository that does not declare overnightworks-design[catalogs] sees neither.
Pin form
uses: overnightworks/quality/.github/workflows/gate.yml@0880614da1ac00ef3063ec63a8f1bc6b23640e59 # v0.13.0codeql.ymltakes the same pin.- The comment is load-bearing: it must name the tag of the commit before it.
- Release workflows (
release-gate.yml,image.yml,release-tag.yml) pinned below v0.13.0 move to the same commit, with the comment. - A repository that has not yet moved to v0.12.0 moves straight to v0.13.0 and reads v0.12.0's page for the rules it meets there (
job-timeout,runtime-install, the widerpytest-workers).
What changed
catalog-check: enforcing, and it reads a call through make
Area workflows. The rule shipped in v0.12.0 as a note; v0.13.0 is the release of its switch. It is described in docs/rules.md. No configuration switches it off.
-
Covered. A repository is covered when its tracked root
pyproject.tomldeclaresovernightworks-designwith the extracatalogs, in[project] dependencies, a group of[project.optional-dependencies]or a group of[dependency-groups]. Any other repository sees no row and no workflow is read. A rootpyproject.tomlthat is not UTF-8 TOML is exit 2 naming the file. -
A call counts when a
run:step of a workflow that a pull request triggers callsdesign-catalogswith--check, directly or throughmake. A step withcontinue-on-error: trueor aworking-directoryother than.does not count. Any counted call makes the rule clean. -
A call through
makeis read. A counted step'smakegoal counts when it reaches a recipe line of the tracked rootMakefilethat calls the check. The reading is closed: literal goal words only, nomakeflag at all (so no-C,-for-j), and amakecall with no goal is not followed. A form it does not follow reads asmissing, or asinvalidwhen a command word is a make variable. AMakefilethat is not UTF-8, or a symlink that resolves outside the repository, is exit 2 naming the file when a counted step has amakegoal and no step calls the check directly. -
A word in an
echo, a script,tox,nox, a composite action or a reusable workflow called throughuses:is no call. -
The findings, exit 1, each with the fix
add a step to a pull-request workflow, or a make target that make lint runs: uv run design-catalogs --check, from the repository root:Event Where Fact missing.github/workflows, no lineno workflow step runs design-catalogs --check on a pull request, directly or through makeinvalidworkflow or Makefile, with a linecommand cannot be read to its endinvalidworkflow or Makefile, with a linecommand is built at run time, design-catalogs --check cannot be readAn unreadable or run-time-built command is
invalid; otherwise a covered repository with no call gets the onemissingrow. -
Named gaps are in
docs/rules.md. Among them: a repository that runs the generator without declaring it (uvx --from 'overnightworks-design[catalogs]' design-catalogs --check) is not covered; a call behindcd sub &&, in a step with anif:, or ending in|| truereads as a counting call. -
What a caller changes: a covered repository whose pull-request workflow already runs the check, directly or through a
makegoal as read above, changes nothing. One that does not adds a stepuv run design-catalogs --checkto a pull-request workflow, or amaketarget that the workflow calls.
literal-text: the debt row counts literal texts, measured only
New rule, area debt, first released here. It never turns a run red. No configuration switches it off. It is described in docs/rules.md.
- Covered as for
catalog-check. A repository that is not covered sees no row and no new verdict. - What it reads. Every tracked
*.sveltefile. A.vue,.jsx,.tsxor.htmlfile is not read. - What counts, once per text node and once per attribute value: the text nodes of a page, the values of
title,placeholder,aria-label,alt,label,aria-description,aria-roledescriptionandaria-valuetext, avalueon a submit, button or reset<input>and on a<button>of type submit or none, andcontenton<meta name="description">. There is no exemption mechanism. - The row. The
debtrow of a covered repository adds the count and the mode. Without a ceiling file:N entries over the thresholds, K literal texts in F files · measured only. With a ceiling file that has no[clones]table:M clone pairs, K literal texts in F files · partly measured only. With one that has it:K literal texts in F files · partly measured only. A repository with no Svelte file reads0 literal texts in 0 files, and one text reads1 literal text in 1 file.quality check --fixrecords none of the literal texts, so thefix:line prints only where it can record something else: it stays while the clone pairs are unrecorded and is gone once the[clones]table exists. - Exit 2 names the page for a page that is not UTF-8, for a
<script>,<style>,<textarea>,<title>,<iframe>,<xmp>,<noembed>or<noframes>opened and never closed, and for a{hole never closed. Thedebtarea then refuses with that fact. - A malformed
pyproject.tomlnow also refusesdebt. A covered-repository check reads the rootpyproject.tomlfordebtas it does forworkflows, so a rootpyproject.tomlthat cannot be read makesquality check debtalone exit 2 where it was exit 0 (for an uncovered repository this is the one change). - Named gaps are in
docs/rules.md: a literal inside a larger expression, a component prop outside the attribute list and a string in a<script>are not counted. - What a caller changes: nothing. The count is a number to read; a ceiling for it ships in a later release.
Fleet matrix
On a gate pinned at v0.13.0 the literal-text cell reads report-only and the catalog-check cell reads the enforcing state; on a gate pinned below v0.13.0 the literal-text cell reads not in <tag>.
What a caller changes at its bump
- Move the pin in the
gate.ymlcaller and in thecodeql.ymlcaller to the v0.13.0 commit, each with the# v0.13.0comment. - Move the pins of
release-gate.yml,image.ymlandrelease-tag.ymlto the same commit, with the comment. - Run
quality checkat the new pin and read theworkflowsanddebtrows. -
catalog-check, only if the repository declaresovernightworks-design[catalogs]: make sure arun:step of a pull-request workflow callsuv run design-catalogs --check, directly or through amakegoal that the workflow calls with no flag and a literal goal word, from the repository root and withoutcontinue-on-error. -
catalog-checkthrough a script: a call inside a shell script,tox,nox, a composite action or a reusable workflow is no call; add the direct step or themakegoal. -
literal-text: read the new count on thedebtrow; nothing to fix. - A root
pyproject.tomlthat is not valid UTF-8 TOML now refusesdebtas well asworkflows; repair it.
What is not in it
literal-textdoes not turn red and has no ceiling table; that is a later release.render-passis not in this release.- No other rule changes its behaviour or printed words, and
image.yml,release.ymlandcodeql.ymlare unchanged.
Older pins
A gate pinned below v0.13.0 reads a call through make not at all and does not enforce catalog-check (it prints the note of v0.12.0 where a covered repository has no direct call), and it has no literal-text count on the debt row.
What's Changed
- Read a call through make in catalog-check, and name the note's fact in full by @FlexOr2 in #816
- catalog-check is red when a covered repository's pull requests never call design-catalogs --check by @FlexOr2 in #818
- Count a covered repository's literal Svelte texts on the debt row, measured only by @FlexOr2 in #820
- Name v0.13.0 as the release of catalog-check's switch and literal-text's first, and pin gate.yml to it by @FlexOr2 in #824
Full Changelog: v0.12.0...v0.13.0