Skip to content

Releases

v0.21.1

Choose a tag to compare

@github-actions github-actions released this 16 Nov 00:49
Immutable release. Only release title and notes can be modified.
dc9f4e6

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

Choose a tag to compare

@github-actions github-actions released this 16 Nov 00:05
Immutable release. Only release title and notes can be modified.
915acb8

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 an overnightworks-* package from an index is refused (docs/rules.md, SOURCE).
  • image.yml passes SERVICE_VERSION=<version> to every build and refuses a caller build-args line 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

Choose a tag to compare

@github-actions github-actions released this 15 Nov 18:00
Immutable release. Only release title and notes can be modified.
07196e5

What's Changed

  • Name held job limits in the clean debt row by @FlexOr2 in #856
  • Turn every literal page text into a finding and drop the [literal_text] table by @FlexOr2 in #858
  • Name v0.20.0 as literal-text's switch and pin gate.yml to it by @FlexOr2 in #861

Full Changelog: v0.19.0...v0.20.0

v0.19.0

Choose a tag to compare

@github-actions github-actions released this 15 Nov 11:58
Immutable release. Only release title and notes can be modified.
4fe26b2

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 S or T20 rule, the codes python-security selects.
  • 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.0
  • codeql.yml, release-gate.yml, image.yml and release-tag.yml take the same pin, with the same comment.
  • A repository below v0.18.0 reads the earlier pages first.

What changed

Full Changelog: v0.18.0...v0.19.0

v0.18.0

Choose a tag to compare

@github-actions github-actions released this 14 Nov 16:07
Immutable release. Only release title and notes can be modified.
505b0df

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.0
  • codeql.yml, release-gate.yml, image.yml and release-tag.yml take 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 merge reads the base branch's live tip and compares it with the head. A head that lacks that tip is refused with a base row. Its next: line names gh 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>/merge with the head sha, the method and the message. It reports merged only on merged: true and 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

Choose a tag to compare

@github-actions github-actions released this 14 Nov 09:57
Immutable release. Only release title and notes can be modified.
853a954

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.0
  • codeql.yml, release-gate.yml, image.yml and release-tag.yml take 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 key render_pass, for example render_pass = "Render pages". The value is the job's name:, or its id if it has no name. This is the same form [gate] mandatory_jobs uses.
  • A tracked workflow holds a job with that name.
  • [gate] mandatory_jobs lists 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 declared
  • render pass "x" is no job of a tracked workflow
  • render 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 as render (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.0 comment.
  • 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] with render_pass = "<that job's name>" to quality/config.toml, and add the same name to [gate] mandatory_jobs.
  • Run quality check workflows and confirm that there is no render-pass row.

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

Choose a tag to compare

@github-actions github-actions released this 13 Nov 23:39
Immutable release. Only release title and notes can be modified.
24c8484

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.0
  • codeql.yml, release-gate.yml, image.yml and release-tag.yml take 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 is new debt. Both are red.
  • A page below its count, or an entry whose page is gone, is can fall. quality check --fix lowers it and never raises (LITERAL-6, LITERAL-7).
  • A renamed page carries its entry (LITERAL-13).
  • quality verdict reads 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.0 comment.
  • Run quality check debt --fix with 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. Commit quality/baseline.toml.
  • Run quality check and confirm the debt row reads literal-text enforced, 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

Choose a tag to compare

@github-actions github-actions released this 13 Nov 21:40
Immutable release. Only release title and notes can be modified.
f3857b5

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.0
  • codeql.yml, release-gate.yml, image.yml and release-tag.yml take 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.0 comment.
  • Only for a reasoned CodeQL exception: add the config file and pass config-file: <its path> to the codeql.yml call.

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

Choose a tag to compare

@github-actions github-actions released this 13 Nov 18:17
Immutable release. Only release title and notes can be modified.
eb140c3

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.0
  • codeql.yml, release-gate.yml, image.yml and release-tag.yml take 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.0 comment.
  • 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

Choose a tag to compare

@github-actions github-actions released this 13 Nov 12:42
Immutable release. Only release title and notes can be modified.
0880614

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.0
  • codeql.yml takes 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 wider pytest-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.toml declares overnightworks-design with the extra catalogs, 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 root pyproject.toml that 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 calls design-catalogs with --check, directly or through make. A step with continue-on-error: true or a working-directory other than . does not count. Any counted call makes the rule clean.

  • A call through make is read. A counted step's make goal counts when it reaches a recipe line of the tracked root Makefile that calls the check. The reading is closed: literal goal words only, no make flag at all (so no -C, -f or -j), and a make call with no goal is not followed. A form it does not follow reads as missing, or as invalid when a command word is a make variable. A Makefile that is not UTF-8, or a symlink that resolves outside the repository, is exit 2 naming the file when a counted step has a make goal and no step calls the check directly.

  • A word in an echo, a script, tox, nox, a composite action or a reusable workflow called through uses: 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 line no workflow step runs design-catalogs --check on a pull request, directly or through make
    invalid workflow or Makefile, with a line command cannot be read to its end
    invalid workflow or Makefile, with a line command is built at run time, design-catalogs --check cannot be read

    An unreadable or run-time-built command is invalid; otherwise a covered repository with no call gets the one missing row.

  • 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 behind cd sub &&, in a step with an if:, or ending in || true reads as a counting call.

  • What a caller changes: a covered repository whose pull-request workflow already runs the check, directly or through a make goal as read above, changes nothing. One that does not adds a step uv run design-catalogs --check to a pull-request workflow, or a make target 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 *.svelte file. A .vue, .jsx, .tsx or .html file 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-roledescription and aria-valuetext, a value on a submit, button or reset <input> and on a <button> of type submit or none, and content on <meta name="description">. There is no exemption mechanism.
  • The row. The debt row 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 reads 0 literal texts in 0 files, and one text reads 1 literal text in 1 file. quality check --fix records none of the literal texts, so the fix: 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. The debt area then refuses with that fact.
  • A malformed pyproject.toml now also refuses debt. A covered-repository check reads the root pyproject.toml for debt as it does for workflows, so a root pyproject.toml that cannot be read makes quality check debt alone 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.yml caller and in the codeql.yml caller to the v0.13.0 commit, each with the # v0.13.0 comment.
  • Move the pins of release-gate.yml, image.yml and release-tag.yml to the same commit, with the comment.
  • Run quality check at the new pin and read the workflows and debt rows.
  • catalog-check, only if the repository declares overnightworks-design[catalogs]: make sure a run: step of a pull-request workflow calls uv run design-catalogs --check, directly or through a make goal that the workflow calls with no flag and a literal goal word, from the repository root and without continue-on-error.
  • catalog-check through 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 the make goal.
  • literal-text: read the new count on the debt row; nothing to fix.
  • A root pyproject.toml that is not valid UTF-8 TOML now refuses debt as well as workflows; repair it.

What is not in it

  • literal-text does not turn red and has no ceiling table; that is a later release.
  • render-pass is not in this release.
  • No other rule changes its behaviour or printed words, and image.yml, release.yml and codeql.yml are 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