Repository navigation
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