Router that virtually distributes inference across connected devices in the home.
name: pair-github-pr description: >- Fills GitHub pull request descriptions with the required PAIR pair-release-intent:v1 block so the release-intent check passes. Use when opening, updating, or rewriting a PR description, when the user mentions release intent, version bumps, changelog for a PR, or when a workflow run fails on release-intent-check.
PAIR pull request release intent
.github/workflows/release-intent-check.yml runs on every pull request. A
missing or malformed intent block fails the check. Agents that create or
edit PR descriptions must include a valid block — do not invent a free-form
changelog section.
Canonical template (copy keys from here; keep the key set in sync with
services/versions.json):
.github/PULL_REQUEST_TEMPLATE.md
SemVer meaning: services/VERSIONING.md. Operational detail (truncation,
component add/remove): scripts/release-intent/README.md.
When opening or updating a pull request
- Push a feature branch only (never
developormain— seeno-push-to-main.mdc). - Build the description from the template structure: PAIR release intent fence first (truncation-safe), then Summary → Test plan.
- Decide release vs no-release (below).
- Do not edit
services/versions.jsonin the pull request unless you also add<!-- pair-release-intent-allow-owned-files -->(bootstrap/hotfix, or component add/remove).desktop/package.jsonversionis a manual release-cut carve-out and is not part of this block. - Before pushing the description, validate locally:
# Write the PR body to a file, then:
python3 scripts/release-intent/validate_pr.py \
--description-file /tmp/pr-description.md \
--skip-owned-files-check
In the workflow run, drop --skip-owned-files-check (CI enforces owned paths).
No release (most pull requests)
Every bump value is none. Changelog title and body are exactly n/a.
Use a Markdown bullet list for bumps (- key: value) so the rendered pull
request stays one key per line without a code fence.
<!-- pair-release-intent:v1 -->
### Changelog title
n/a
### Changelog body
n/a
### Bumps
- services: none
- nvpair-cluster-manager: none
- nvpair-engine-manager: none
- nvpair-errors: none
- nvpair-job-scheduler: none
- nvpair-manual-nodes: none
- nvpair-node-info: none
- nvpair-node-scanner: none
- nvpair-node-settings: none
- nvpair-proxy: none
- nvpair-tui: none
- nvpair-ui-broker: none
- nvpair-workload-manager: none
<!-- /pair-release-intent:v1 -->
If services/versions.json gained or lost a component, edit that file in the
pull request with <!-- pair-release-intent-allow-owned-files -->, and
regenerate the bump key list (services + sorted component names). Extra or
missing keys fail the check.
Shipping a product release
- Set each touched component to
patch,minor, ormajor(SemVer meaning inVERSIONING.md). Untouched components staynone. - Set
servicesto a severity ≥ the highest component bump. UI-only notes may bumpserviceswhile all components staynone. - Replace changelog title/body with real user-facing prose (not
n/a). Prefer bullets in the body. - Leave owned files alone —
release-intent-apply.ymlwrites them after the pull request merges.
Example (engine-manager feature + services minor):
<!-- pair-release-intent:v1 -->
### Changelog title
Model downloads show live progress
### Changelog body
- Pulling a model on this machine now shows a live percentage instead of a spinner.
### Bumps
- services: minor
- nvpair-cluster-manager: none
- nvpair-engine-manager: minor
- nvpair-errors: none
- nvpair-job-scheduler: none
- nvpair-manual-nodes: none
- nvpair-node-info: none
- nvpair-node-scanner: none
- nvpair-node-settings: none
- nvpair-proxy: none
- nvpair-tui: none
- nvpair-ui-broker: none
- nvpair-workload-manager: none
<!-- /pair-release-intent:v1 -->
Hard format rules (the check fails otherwise)
- Exact fences:
<!-- pair-release-intent:v1 -->…<!-- /pair-release-intent:v1 --> - Exact headings:
### Changelog title,### Changelog body,### Bumps - Enums only:
none|patch|minor|major(lowercase) - One bullet per key:
- key: value(plainkey: valuestill accepted) - HTML/
#comment lines inside the intent block are allowed and ignored - Any non-
nonebump ⇒ real changelog (notn/a) - All bumps
none⇒ both changelog fields exactlyn/a
Fixing a failed release-intent check
- Read the workflow log (it prints the parse error).
- Edit the pull request description (not a new commit) unless owned files were wrongly changed — then revert those file edits on the branch.
- Re-run the workflow if it does not re-run on description-only edits.
Out of scope
- Do not put internal issue identifiers or private tracker URLs in the changelog body. Describe user-visible behavior instead.