Repository navigation
rfc(pnpr): release notes details from the client implementation - #63
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review.
|
| Layer / File(s) | Summary |
|---|---|
Publication metadata pnpr/text/0000-release-notes.md |
The example adds an absolute-path publication-note URL and explains that the initial digest remains unchanged after edits or deletion. |
pnpm publishing notes pnpr/text/0000-release-notes.md |
The text clarifies changelog section boundaries, the single-package --release-notes case, note source reporting, and delivery to pnpr registries. |
Version note composition pnpr/text/0000-release-notes.md |
The text describes how pnpm version -r --release-notes supplies hand-written summaries before the composed publication note, or the version note for a single-package release. It states that pnpm retains composed notes until publish. |
Estimated code review effort: 1 (Trivial) | ~4 minutes
Possibly related PRs
- pnpm/rfcs#56: Defines the release-notes contracts that this PR revises.
- pnpm/rfcs#60: Covers related release-note publication metadata and immutable initial-digest semantics.
Merge Risk: 
Minimal · up to 5b7d5
-
The RFC consistently defines publication-note URLs and version-time summary composition. No actionable merge-blocking issue remains.
Pre-merge checks: 
5
-
Full details: Title check
-
Explanation
The title names the RFC for pnpr release notes and says the details come from the client implementation. The raw summary and objectives match this. The PR revises the release-notes RFC: it moves the publication-note summary to pnpm version -r --release-notes, adds a note url to publication entries, removes version headings, and replaces example initialDigest values. The title is specific and accurate enough to pass, although it does not name the individual changes.
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
-
Finishing Touches
-
Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
A rabbit reads the notes at dawn,
And finds the route where notes are drawn.
The first-text hash stays as it was,
Through edits, pauses, and because.
Hand-written lines join notes in flight,
Then wait for publish, tucked in tight.
PR Summary by QodoClarify release-note composition and publication URLs in the RFC
AI Description
Diagram
High-Level Assessment
Files changed (1)
|
Summary
Implementing pnpm's side of release notes (pnpm/pnpm#17558) found these problems in the merged RFC:
pnpm publish --release-notes, added above the composed text at publish time. A laterpnpm version -rcannot recompute that note's initial digest, so once the note is edited, the intents it covers are never deleted. The summary is now given topnpm version -r --release-notes, and pnpm composes every note when versioning runs (as it already composes the changelog section) and keeps it until publish, so each published note is known in full and its digest can be checked.--release-notesfor one package in versioning mode replaced the composed note, which would block intent deletion forever. It now goes above the composed text; outside versioning it still gives the version note.CHANGELOG.md, since the route names the version.publicationentry in<name>/-/notesnow carries the note'surl, as the version route'sLinkheader does.initialDigestwas the SHA-256 of the empty string; the digests are now placeholders.Written by an agent (Claude Code, claude-opus-5-5).
🤖 Generated with Claude Code
Summary by CodeRabbit
--release-notesapplies, reporting note sources, and sending notes only to pnpr registries.