---
name: Draft Release Notes
slug: draft-release-notes-4
category: Writing
description: Draft Release Notes compares release branches and uses verified repository evidence to update the documentation-site release notes. Use it when preparing release summaries, checking changes between releases, or updating the current release pages.
github: "https://github.com/NVIDIA/NeMo-Relay/tree/main/.agents/skills/draft-release-notes"
language: Rust
stars: 165
forks: 67
install: "npx degit https://github.com/NVIDIA/NeMo-Relay/tree/main/.agents/skills/draft-release-notes ~/.claude/skills/draft-release-notes"
installs_to: ~/.claude/skills/draft-release-notes
source_path: .agents/skills/draft-release-notes/SKILL.md
collection_size: 25
category_size: 1361
collection_url: "https://dirskills.com/collections/NVIDIA/NeMo-Relay"
added: 2026-09-08T05:35:15.071Z
last_synced: 2026-09-08T05:35:15.071Z
canonical_url: "https://dirskills.com/skills/draft-release-notes-4"
---

# Draft Release Notes

Draft Release Notes compares release branches and uses verified repository evidence to update the documentation-site release notes. Use it when preparing release summaries, checking changes between releases, or updating the current release pages.

**Install:**

```bash
npx degit https://github.com/NVIDIA/NeMo-Relay/tree/main/.agents/skills/draft-release-notes ~/.claude/skills/draft-release-notes
```

## README

# Draft Release Notes

Draft the three documentation-site release-notes pages from verified repository
evidence. Keep complete, PR-by-PR release history in GitHub Releases.

## Gather Evidence

Run the read-only helper with explicit release refs and the target minor version:

```bash
python3 .agents/skills/draft-release-notes/scripts/collect_release_evidence.py \
  --previous release/<previous-major>.<previous-minor> \
  --current HEAD \
  --version <major>.<minor>
```

The report verifies both refs, compares their release-notes trees, identifies
version text currently present in those pages, and groups commits into review
candidates. Treat the groups as an evidence index, not publication-ready copy.

## Workflow

1. Confirm the target release version from the release branch and package
   metadata. Preserve unrelated working-tree changes.
2. Run the helper. It reports an absent prior release-notes directory without
   failing, which is expected for early release branches.
3. Verify each candidate claim in the changed public docs, API types, command
   help, or source before including it. Prioritize breaking changes, migrations,
   user-visible features, and ongoing support limitations.
4. Update only these pages unless the release changes their route or entry
   points:
   - `docs/about-nemo-relay/release-notes/index.mdx`
   - `docs/about-nemo-relay/release-notes/highlights.mdx`
   - `docs/about-nemo-relay/release-notes/known-issues.mdx`
5. Keep the existing page roles:
   - `index.mdx` gives the current-release summary, compatibility notes, scope,
     and curated feature links.
   - `highlights.mdx` groups notable changes by user-facing theme.
   - `known-issues.mdx` records current limitations, compatibility migrations,
     current-release fixes, and the complete fixed-item history recorded in
     earlier release-note pages. Preserve every prior fixed-item bullet under
     release-labelled subsections; do not summarize, deduplicate, or omit it.
     GitHub Releases remains the complete PR-by-PR history.
6. Preserve MDX front matter and the JSX SPDX comment. State the full history
   is available in GitHub Releases; do not create a changelog or GitHub Release
   body from this skill.

## Validate

Run the helper for the target release and for an early branch without release
notes when available. Review public claims, then run:

```bash
git diff --check
just docs
just docs-linkcheck
```

Check product names, commands, package names, support claims, and links against
the current repository before handing off the draft.