Skip to content

Quality and release (skill)

Applies the UASK Engineering Hub playbook quality.quality-release.

Download SKILL.md — the skill, as in the repository.

When to use

Use when a project needs its quality baseline (Definition of Ready and Done, test strategy, CI gate, changelog), when finishing a change, when preparing, deploying, verifying or rolling back a release, or when a released version needs a hotfix.

Quality and release

This skill tells an agent how to apply the playbook quality.quality-release. The rules live in the playbook and in the items it cites; this file only orders the work. Cite rules as quality.quality-release#R<n> and never restate them in the project’s files — link the Hub item instead.

Where the material is

What In the Hub repository In a project that vendors the Hub
Playbook content/playbooks/quality-release.md the same path under the vendored Hub copy (.uask/hub/)
Items it cites config.semantic-versioning, ops.backups, config.conventional-commits, process.definition-of-ready, process.definition-of-done, process.work-packages; around it process.deliver-a-release found by id: in their front matter
Templates templates/definition-of-ready.md, templates/definition-of-done.md, templates/test-strategy.md, templates/release-checklist.md, templates/changelog.md the same paths under the vendored copy

Read the playbook’s Rules section before acting. If the playbook and this skill ever disagree, the playbook wins.

Choose the mode

  1. Set-up — the project has no Definition of Done, test strategy, gate script or changelog.
  2. Change — a pull request is being finished.
  3. Release — main holds what should ship.
  4. Hotfix — a released version has a defect that cannot wait.

A release that is one of several work packages of a bigger piece of work, with a release spec and an appetite, runs under process.deliver-a-release; its stages 3 and 4 are the Change and Release modes below, and a fix runs only those two. There is no separate skill for it: the playbook is read next to this one.

Ask the owner only for what the repository cannot answer: the approver’s name, the deploy window, access to production, acceptance of a recorded risk.

Set-up

  1. Inspect the repository: existing CI configuration, test commands, test folders, release tags, changelog, contributing guide.
  2. Copy the five templates (the first two are the copy forms of the checklists process.definition-of-ready and process.definition-of-done) to the project root as DEFINITION-OF-READY.md, DEFINITION-OF-DONE.md, TEST-STRATEGY.md, CHANGELOG.md and a releases/ folder for checklists (or the place the project prefers).
  3. Fill the test strategy from what exists. Mark missing levels as gaps and open an issue for each gap instead of inventing tests the project does not run.
  4. Make one gate script that runs the G1 checks; call it from CI; make the gate block merging (playbook R5–R7).
  5. Cut the Definition of Done down to checks the project really performs.
  6. Open one pull request with these files. Output: the files, the gate run log, the list of gap issues.

Change

  1. Check the issue against the Definition of Ready; if it fails, say what is missing and stop.
  2. Write the lowest-level test that fails without the change; for a defect, this is the regression test (R8).
  3. Make the change; run the gate locally; fix until green.
  4. Add a user-facing line under Unreleased in CHANGELOG.md when users will notice the change.
  5. Open the pull request with evidence for every Definition of Done line, or “n/a” with a reason.

Release

  1. List changes since the last tag; choose the version by config.semantic-versioning; when unsure, MAJOR.
  2. Turn Unreleased into the release entry, written for users (R10).
  3. Copy templates/release-checklist.md to releases/vX.Y.Z.md; fill sections 1–5. Rollback triggers must be observable facts, not “if something goes wrong”.
  4. Tag a release candidate; let CI build artefacts; record checksums (R11). Deploy to staging and run G2; run the ecosystem’s dependency audit and compare findings with the CISA KEV catalogue (R16).
  5. Ask the named approver to approve against the checklist (R14). Do not deploy before the approval is recorded.
  6. Take and confirm the backup named in section 4 (R17), following ops.backups.
  7. Deploy in the window; log deviations; run post-release verification (R19).
  8. If a trigger fires, roll back as planned and report; do not start debugging on production first (R20).
  9. Complete sections 7–9, keep the record, open follow-up issues (R21).

Hotfix

  1. Confirm with the approver that the defect cannot wait.
  2. Fix on main first with a regression test, then cherry-pick to the release line, or branch from the released tag and merge back at once (R23).
  3. Release as a PATCH through the checklist’s hotfix lane; never shorten gate, backup, approval or verification (R22).
  4. If someone already changed production by hand, bring that change into the repository first (R24).

Report

At the end, report in five lines or fewer: mode, result (release version, pull request or tag), evidence (gate run, verification results), open risks or exceptions, decisions waiting for the owner.