Skip to content

review remediation: reconcile CHANGELOG [Unreleased] against develop at the next release cut #2958

@bpamiri

Description

@bpamiri

Problem

CHANGELOG.md:21-61 lists 17 PRs under [Unreleased], but there are 43 merges since v4.0.2 (CHANGELOG.md:62) — 34 have no entry, several user-facing:

This confirms and quantifies the ongoing "Unreleased drift" tracked in project memory (entries cite issue numbers, not merge-PR numbers).

Impact

Users reading the changelog at the next release will miss material fixes, including a broken-then-fixed PostgreSQL FK migration path and a CLI exit-code behavior change. The drift compounds every wave-2 PR.

Suggested approach

Reconcile [Unreleased] against git log v4.0.2..develop at the next release cut — doing it mid-campaign guarantees instant re-staleness and merge conflicts with every in-flight wave-2 PR (this is why it is filed as an issue, not fixed now). Consider adding a PR-template or bot check requiring user-facing fix/feat PRs to touch CHANGELOG.md.

Acceptance criteria

  • At the next release cut, every user-facing merge in v4.0.2..develop has a [Unreleased] entry.
  • Entries reference merge-PR numbers consistently.
  • A guard (PR template note or bot check) discourages future drift.

Source

Internal multi-agent framework review 2026-06-09, wave 2 (issues phase). Findings: followups D4, upgrade-docs D4.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions