Skip to content

Use the services key in the pair-github-pr release-intent examples - #120

Merged
Noah-Tervalon-Nvidia merged 1 commit into
NVIDIA:developfrom
somtri:docs/release-intent-skill-services-key
Sep 28, 2026
Merged

Noah-Tervalon-Nvidia merged 1 commit into
NVIDIA:developfrom
somtri:docs/release-intent-skill-services-key

Conversation

@somtri

@somtri somtri commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Description

.cursor/skills/pair-github-pr/SKILL.md still uses the pre-#87 product bump key. The parser expects the keys in services/versions.json, where the suite version is services. The PR template and services/VERSIONING.md already use services.

Both example blocks in the skill fail the check on develop:

Bump keys must match services/versions.json exactly (missing keys: services; unknown keys: product)

This renames the key in the two examples, the key-list note, the severity rule, and one example heading. The severity rule also drops "product" from "UI-only product notes". No other wording changes.

Release intent

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

Scope

Included: .cursor/skills/pair-github-pr/SKILL.md only.

Excluded:

  • The skill's description order ("Summary → Test plan") differs from the current template. I left it alone because the skill puts the intent fence first on purpose, and the template does not.
  • services/nvpair-cluster-manager/spec.md and services/nvpair-job-scheduler/spec.md still mention a product bump. They are service specs, so I did not touch them here.

Validation

  • python scripts/release-intent/validate_pr.py --description-file <example> --skip-owned-files-check on each example block: exit 1 with the error above before this change, exit 0 after it.
  • The same command on this description: exit 0.
  • node scripts/spdx-headers.mjs: 1024 checked, 0 missing.
  • git diff --check: clean.

Risk

Documentation only. No code, build, or version file changes.

Checklist

  • I have read the Contributing Guidelines.
  • Every commit is signed off (git commit -s), certifying the Developer Certificate of Origin.
  • New or existing tests cover the change. Not applicable: documentation only. The Validation section lists the validate_pr.py runs on both examples.
  • Relevant documentation is updated.
  • I checked the diff, changed filenames, and commit messages for credentials, private data, internal URLs, internal issue identifiers, and generated artifacts.
  • I recorded the validation commands and results above.
  • I declared version bumps in the release-intent block above. services/versions.json is written by automation — do not edit it by hand.

The release-intent parser expects the keys in services/versions.json,
where the suite version is "services". The skill still told agents to
write "product", so both of its example blocks failed validate_pr.py.

Signed-off-by: Som Tripathi <somtri@iastate.edu>

@Noah-Tervalon-Nvidia Noah-Tervalon-Nvidia left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoops, not sure how I missed that. Thanks for catching it!

@Noah-Tervalon-Nvidia
Noah-Tervalon-Nvidia merged commit 6769d04 into NVIDIA:develop Sep 28, 2026
7 checks passed
@somtri
somtri deleted the docs/release-intent-skill-services-key branch September 29, 2026 17:46
Noah-Tervalon-Nvidia pushed a commit that referenced this pull request Oct 9, 2026
## Description

Adds two pages to the public docs: **Release Notes**, starting with
1.0.0, and an **Upgrade Guide** for updating from a version before
1.0.0. People who read the docs rather than GitHub had no release notes
to look at.

The 1.0.0 notes are adapted from the release notes master doc. The
Upgrade Guide starts from the fact that most machines need nothing
extra, then covers the few setups that need a small step:

- tidying up the old `PAIR.app` on macOS;
- an LM Studio that an earlier PAIR installed;
- browser clients affected by the CORS change.

<!-- 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 -->

## Scope

- `docs/release-notes.mdx` (new): the 1.0.0 notes, covering what's new,
compatibility notes, targeted bug fixes, community contributions with PR
links, and special thanks. Notes before 1.0.0 are linked on GitHub
Releases.
- `docs/upgrade-guide.mdx` (new). It opens by saying an update keeps
settings, cluster membership, and models, and that every machine in a
cluster should run the same version. Each section then says who it
applies to:
- **On macOS, tidy up the old app:** run the old app's
`uninstall-macos.sh` without `--purge`, then install `NVIDIA PAIR.app`.
0.1.0 and 0.1.1 both ship that script, and both keep data without
`--purge`.
- **If an earlier PAIR installed LM Studio for you:** it keeps working,
but it has no install marker (`installed-by-pair.json`), so Uninstall,
Reset app data, and uninstalling PAIR leave it. Steps to remove it while
keeping `models`, or to reinstall it so PAIR manages it.
- **If you use PAIR from a web page or browser extension:** which launch
option allows a site for each engine.
  - **Checking everything is working.**
- `fern/docs.yml`: both pages under Guides, after Getting Started.
- `README.md`, `docs/getting-started.mdx` ("Keeping PAIR Up to Date" and
"Learn More"), and `docs/known-issues.mdx`: link to the new pages.
`known-issues` gains an entry for the LM Studio limitation.

## Validation

- Each upgrade step was checked against the code:
`desktop/scripts/build/macos/uninstall.sh` at HEAD, `v0.1.0`, and
`v0.1.1`; `services/nvpair-engine-manager/install.go` and
`provenance.go`; `manifests/lmstudio.json`;
`desktop/docs/macos-privileged-helper.md`; and
`docs/engine-settings.mdx` for the CORS controls.
- Contributor PRs #27, #34, #37, #62, #80, #95, #120, #122, and #126
were checked for merge state and author.
- `node scripts/spdx-headers.mjs`
- `python3 scripts/release-intent/validate_pr.py --description-file
<this description> --skip-owned-files-check`

## Risk

Documentation only. No code, build, or versioned file changes.

Left for the product owner to confirm against the master doc:

- The app is named **NVIDIA PAIR** (`NVIDIA PAIR.app`).
- The macOS note does not say models could be lost, because models never
live inside the app.
- The bug-fix line names LM Studio only, because llama.cpp never shipped
publicly.
- `README.md` and `known-issues.mdx` still call Windows on ARM
experimental, beside the RTX Spark validation note.

## Checklist

- [x] I have read the [Contributing
Guidelines](https://github.com/NVIDIA/Personal-AI-Router/blob/main/CONTRIBUTING.md).
- [x] Every commit is signed off (`git commit -s`), certifying the
[Developer Certificate of Origin](https://developercertificate.org/).
- [ ] New or existing tests cover the change. (Documentation only.)
- [x] Relevant documentation is updated.
- [x] I checked the diff, changed filenames, and commit messages for
credentials, private data, internal URLs, internal issue identifiers,
and generated artifacts.
- [x] I recorded the validation commands and results above.
- [x] I declared version bumps in the release-intent block above.
`services/versions.json` is written by automation — do not edit it by
hand.

---------

Signed-off-by: Chris Kelsey <ckelsey@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants