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