Skip to content

Add v1.6 breaking-change ledger + CLAUDE.md tracking rule - #8260

Merged
Aaronontheweb merged 1 commit into
akkadotnet:devfrom
Aaronontheweb:docs/v1.6-breaking-changes
Jun 12, 2026
Merged

Aaronontheweb merged 1 commit into
akkadotnet:devfrom
Aaronontheweb:docs/v1.6-breaking-changes

Conversation

@Aaronontheweb

Copy link
Copy Markdown
Member

Summary

Adds a process for tracking breaking changes during the v1.6 development cycle.

  • BREAKING_CHANGES_V1.6.md (new, repo root) — a living ledger of every breaking behavior, wire-format, or public-API change merged to dev ahead of a stable v1.6.0. Includes the definition of "breaking", lifecycle rules (recorded in the same PR; retired once v1.6.0 ships), an entry-format template, and a Status column so an in-flight change can be listed as Planned and flipped to Merged when it lands.
  • CLAUDE.md — new step in "Making Changes" plus a "Tracking Breaking Changes (v1.6 cycle)" subsection making the ledger mandatory for breaking changes until v1.6.0 ships.

The ledger is seeded with the first known entry (status Planned): the upcoming Source.ActorRef<T> migration off the legacy ActorPublisher, which drops PoisonPill/Kill-as-completion behavior.

Why

During the v1.6 run-up there will be several intentional breaking changes. Capturing them in one place as they land — rather than reconstructing them at release time — keeps the eventual upgrade guide accurate and gives reviewers a single spot to weigh each break.

Docs-only / process change; no source or test impact.

Introduces BREAKING_CHANGES_V1.6.md to record every breaking behavior,
wire-format, or public-API change merged to dev during the v1.6 cycle,
and adds a CLAUDE.md rule requiring such changes to be logged there in
the same PR until a stable v1.6.0 ships. Seeds the ledger with the
planned Source.ActorRef PoisonPill/Kill behavior change.
@Aaronontheweb
Aaronontheweb enabled auto-merge (squash) June 12, 2026 20:25
@Aaronontheweb
Aaronontheweb disabled auto-merge June 12, 2026 20:25
@Aaronontheweb
Aaronontheweb merged commit 5df67ea into akkadotnet:dev Jun 12, 2026
5 of 10 checks passed
@Aaronontheweb
Aaronontheweb deleted the docs/v1.6-breaking-changes branch June 12, 2026 20:27
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.

1 participant