Skip to content

devops: replace shared changelog edits with validated fragments #10965

Description

@gustavovalverde

Parent

What to build

Replace edits to shared CHANGELOG.md files in ordinary source PRs with component-tagged fragments that are reviewed alongside each change. Validate fragments on source PRs and render the root and crate changelogs during release preparation.

Prototype Changie against Zebra's multiple changelogs and release-plz workflow before making fragments the required authoring path.

This issue covers decision 14 from the delivery-lifecycle review.

Acceptance criteria

  • Define which changes require a fragment and which component and audience metadata each fragment contains.
  • Prototype Changie with the root changelog, crate changelogs, and release-plz.
  • Validate fragment syntax, component names, and required content on source PRs.
  • Render only the affected changelogs during release preparation.
  • Preserve operator-focused root notes and crate-consumer-focused crate notes.
  • Demonstrate that fragments avoid conflicts between concurrent user-visible PRs.
  • Preserve compatibility with the existing /changelog assistance while the migration is in progress.
  • Stop requiring ordinary source PRs to edit shared [Unreleased] sections only after the renderer is proven.
  • Update contributor and release documentation for the final authoring model.

Blocked by

None - the prototype can start immediately.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-devopsArea: Pipelines, CI/CD and DockerfilesC-enhancementCategory: This is an improvement

    Type

    No type

    Fields

    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