Skip to content

[Doc] Restore structured release notes — separate behavioral changes from dependency updates #2714

@sepe81

Description

@sepe81

Search before asking

Documentation Related

The release notes for v2.0.6 were well structured with dedicated sections for Bug Fixes, Improvements, and Dependency Updates, making it straightforward to assess the impact of an upgrade at a glance.

Starting with v2.1.0, the release notes collapsed into a single flat "What's Changed" list where behavioral changes are indistinguishable from many Dependabot bumps. This continued in v2.2.0, where the session ID rotation introduced in commit 92eb6fb — a meaningful behavioral change that can silently break downstream applications — is not called out anywhere in the release notes.

It would be wonderful if the structured format from v2.0.6 could be restored, ideally with an explicit "Notable behavioral changes" or "Migration notes" section for commits that change observable runtime behavior. This would make it much easier for downstream maintainers to catch breaking changes before upgrading.

Metadata

Metadata

Assignees

No one assigned

    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