Skip to content

publish: write edited notes to the committed release-notes file, not only the GitHub Release #784

Open

Description

@goosewobbler

This was generated by AI during triage.

Found while reviewing #761.

Agent Brief

Category: bug
Summary: When a notes region has been edited, the per-version release-notes file committed to main must contain the same text as the GitHub Release body.

Current behavior:
At standing-PR publish, the notes step regenerates release notes and writes the per-version files (notes.releaseNotes.file.dir), which are committed so that, in the code's words, "main matches the GitHub release body". Edited regions from the PR body are applied afterwards, and only to the notes passed to the GitHub-release step. With an edited region, the GitHub Release shows the edit while release-notes/<version>.md on main keeps the regenerated text. This applied to package-keyed edits before #761 and now applies to sync too.

Desired behavior:

  • For every key with an edited region, the committed per-version notes file contains exactly the text published as that package's GitHub Release body.
  • The draft-then-dispatch flow behaves the same way.
  • With no edits, behaviour is unchanged.

Key interfaces:

  • publishFromManifest: the notes-generation, notes-file commit and edited-notes merge order.
  • publishFromDraft and the editedNotes it passes to runRelease.
  • The per-version notes file writer.

Acceptance criteria:

  • Through publishFromManifest with an edited region and releaseNotes.file.dir set, the committed file's content equals the release body passed to publish (sync and per-package cases).
  • The same holds through publishFromDraft.
  • Publish without edits commits the same files as before.

Out of scope:

Activity

  1. added this to the 0.43.0 milestone on Oct 24, 2026
  2. added
    type:bugSomething isn't working
    priority:lowLow priority issue or PR
    status:agent-readyDefined and ready for an autonomous (AFK) agent to pick up
    on Oct 24, 2026
  3. modified the milestones: 0.43.0, 0.46.0 on Oct 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority:lowLow priority issue or PRstatus:agent-readyDefined and ready for an autonomous (AFK) agent to pick uptype:bugSomething isn't working

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions