Skip to content

fix(notes): drop an entry's own refs from LLM-rewritten descriptions - #747

Merged
goosewobbler merged 2 commits into
mainfrom
fix/llm-duplicate-refs
Oct 23, 2026
Merged

goosewobbler merged 2 commits into
mainfrom
fix/llm-duplicate-refs

Conversation

@goosewobbler

@goosewobbler goosewobbler commented Oct 23, 2026 •

Copy link
Copy Markdown
Owner

Description

The model sometimes copies an entry's reference into its rewritten description. The built-in renderer strips it (neutralizeDescriptionRefs), but templates print the description and then append the entry's refs, so #614's notes showed (#608) (#608).

  • New core helper removeDescriptionRefs: removes the given refs from a description and leaves every other ref (and inline code) as written. Escaping and linking stay with the renderers.
  • enhance and enhance-and-categorize now remove the entry's own refs (issueIds and prNumber) from the description the model returns, so every renderer gets a clean description.

Related Issue(s)

Closes #719

Type of Change

  • feat — New feature
  • fix — Bug fix
  • docs — Documentation change
  • refactor — Code refactoring
  • test — Adding or updating tests
  • chore — Maintenance, dependencies, tooling
  • Breaking change — Requires major version bump

Scope

  • @releasekit/version
  • @releasekit/notes
  • @releasekit/publish
  • @releasekit/release
  • @releasekit/config
  • @releasekit/core
  • CI / workflows
  • Root / monorepo

Checklist

  • Lint passes (pnpm lint)
  • Tests pass (pnpm test)
  • Typecheck passes (pnpm typecheck)
  • Documentation updated (if applicable)
  • Breaking changes noted in description

Testing Notes

  • Core unit test: own refs are removed (parenthesised and bare); other refs and inline-code refs stay.
  • Core and notes typecheck and unit tests pass, and lint is clean.
  • Still to add: a notes test through enhanceAndCategorize with a model reply whose description ends in the entry's own (#N).

🤖 Generated with Claude Code

RetriggerView in GreptileConfidence Score: 5/5

The PR appears safe to merge; no actionable defects were found.

Summary

Removes an entry’s own issue and pull-request references from model-rewritten descriptions before renderers receive them.

  • Rewritten release notes no longer repeat an entry's own references.

Acknowledged follow-up: goosewobbler states that a notes-level regression test through enhanceAndCategorize is still to add.

Reviews (1) · Last reviewed commit: "fix(notes): drop an entry's own refs fro..." · Reviewed by Greptile

The model sometimes copies an entry's reference into its rewrite, and
templates then append it again: "(#608) (#608)". The enhance tasks now
remove the entry's own refs from the description they return.

Closes #719

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Standing release PR: #730 · v0.42.1 queued (4 packages) · open 40m · ✅ ready to merge

Release Preview — v0.42.0 → v0.42.1

Note: Labels on this PR are advisory in standing-pr mode. Bumps come from conventional commits in the standing PR; override by editing labels on the standing PR itself. Add release:immediate to bypass the standing PR and release this PR directly.

These changes will be added to the release PR (#730) when merged:

Changelog

monorepo 0.42.0 → 0.42.1

Changed

  • assert enhance-and-categorize strips duplicate refs (notes)

Fixed

  • drop an entry's own refs from LLM-rewritten descriptions (notes) (#719)

All packages → 0.42.1 (sync versioning)

  • @releasekit/version
  • @releasekit/notes
  • @releasekit/publish
  • @releasekit/release

After merge — predicted release

No version escalation — this PR's changes will be included in the queued release without affecting the projected versions.

Package Standing PR This PR After merge
monorepo 0.42.1 0.42.1 0.42.1

Updated automatically by ReleaseKit

Co-authored-by: Cursor <cursoragent@cursor.com>
@goosewobbler
goosewobbler merged commit 2789c9b into main Oct 23, 2026
30 checks passed
@goosewobbler
goosewobbler deleted the fix/llm-duplicate-refs branch October 23, 2026 19:31
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.

LLM-enhanced release notes can repeat an entry's reference: (#608) (#608)

1 participant