feat(changelog): resolve Lisa's review on #789 — versions, amend reconciler, backport rule - #3939
Merged
Conversation
lcawl
reviewed
Aug 26, 2026
Member
Author
|
Terminology can do a re-eval for sure roughly: release -> bundle
1 or more A release entry is a single entry in the release that will be displayed as a single unit. |
…nciler, backport rule - Obsoletes `target` on entry/note schema; `versions` (note-only, plural) replaces it - Adds `NoteAmendReconciler`: Lambda auto-generates `.amend-notes.yaml` sidecars for notes that arrive after their release bundle has shipped; one aggregate sidecar per parent bundle, rebuilt from state on every reconcile (idempotent) - `bundle_seq` on `NoteIndexEntry` (0/1/2) reports shipped state per note per version - Backport collision rule in `ChangelogBundlingService`: same-leaf note on multiple branches at one version → prefer main/master, warn on discards, ordinal-first otherwise - `AmendDocumentBuilder`: pure static helper factored out of `ChangelogBundleAmendService` so the Lambda reconciler can build amend documents without a filesystem dependency - Widens `.amend-notes` as a reserved suffix in `BundleAmendMerger.IsAmendFile` and `ChangelogBundleAmendService`; `GetNextAmendNumber` skips it - Drops `branch` from `NoteIndexEntry` (derivable from `path`, no standalone value) - `NotesIndexKey` parameter renamed `target` → `version` (vocabulary only, key shape unchanged) - Docs: new `cmd-note.md`, updated `cmd-add.md` / `cmd-bundle-amend.md` / `changelog-fields.md` / `changelog-bundle-registry.md`; CLI schema regenerated - Filed follow-up issues elastic/docs-eng-team#790–#794 Closes elastic/docs-eng-team#789 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Mpdreamz
force-pushed
the
feature/rn-continued
branch
from
August 27, 2026 09:06
2d1a259 to
b632051
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves the four points Lisa raised on elastic/docs-eng-team#789.
targetobsoleted on entry/note schema.versions(note-only, plural list) replaces it. Nothing writestargetany more; readers still accept it for existing pool objects.BundledProduct.Target(bundle schema) is unchanged and tracked separately in elastic/docs-eng-team#790.NoteAmendReconciler: Lambda auto-generates.amend-notes.yamlsidecars for notes that arrive after their release bundle has shipped. One aggregate sidecar per parent bundle, rebuilt from state on every reconcile (idempotent).bundle_seqonNoteIndexEntry(0/1/2) reports shipped state cheaply.main/master, warn on discards, ordinal-first otherwise.What changed
ProductInfoDto.Target→[Obsolete];ProductInfoDto.Versionsadded;NoteIndexEntrydropsbranch, addsbundle_seq;schema_version: 1changelog notewritesversions;changelog adderrors if a version is supplied in--productsNotesIndexKeyparam renamedtarget→version; conditional writes + retry;NoteAmendReconciler(new)AmendDocumentBuilderextracted (pure);BundleAmendMerger/ChangelogBundleAmendServicewiden.amend-notesas reserved suffix; backport dedup inMergeNotesAsynccmd-note.md; updatedcmd-add.md,cmd-bundle-amend.md,changelog-fields.md,changelog-bundle-registry.md; CLI schema regeneratedTest plan
dotnet build— 0 errorsdotnet test tests/Elastic.Changelog.Tests/— all passing (1009 tests)dotnet test tests/Elastic.Documentation.Configuration.Tests/— all passing (681 tests)./build.sh lint— clean (pre-push hook passed)NoteAmendReconcilerTests(8 tests): late note → sidecar; already shipped → no sidecar, seq=1; human amend → no sidecar; no file annotations → skipped; delete path; idempotent redelivery; no matching bundle; no products in bundle treeBundleCdnSourcingTestsbackport tests (3 tests): main wins, ordinal pick, checksum dedup still works🤖 Generated with Claude Code