Repository navigation
Conversation
Docs preview (local build)Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/4124/ Sample changed pages: |
20d5861 to
55689f8
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Approved.
What is this? | From workflow: PR Review
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
55689f8 to
d50f873
Compare
d50f873 to
bf815d3
Compare
bf815d3 to
8494308
Compare
![infra-vault-gh-plugin-prod[bot]](https://avatars.githubusercontent.com/u/6764390?s=60&v=4){kind=small}
ProfileMode_CdnNotesForTheTarget_AreMergedIntoTheBundle landed on main
after this branch and served the version-only notes index. The cutover
reads notes-{product}-{version}.json only.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TjZFCvQhL3DdrcjFKU6jDT
8494308 to
f1db04d
Compare
`changelog-note-registry-fixes-2` merged `main`, and one hunk in `CdnChangelogEntryFetcherTests` conflicted: that branch only reformatted a legacy-fallback test block that this branch deletes. The merge keeps the deletion, which is the point of the cutover. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
| IEnumerable<string> productVersionKeys, | ||
| IEnumerable<string> versions | ||
| ) | ||
| private static HashSet<string> IntendedIndexKeys(string org, string repo, IEnumerable<string> productVersionKeys) |
There was a problem hiding this comment.
Severity: P2 (Medium)
Removing notes-{version}.json from the intended keys means the scrubber stops writing it and also deletes any existing copy on the next reconcile. Before this PR, the docs said that key was kept "for older CLI pins". A pinned changelog bundle from before the product-scoped key existed only GETs notes-{version}.json, and it treats a 404 as "no notes" rather than an error. Once the Lambda deploys, bundles built by those pinned CLIs will silently leave out every changelog note. Either confirm that no pinned consumers remain, or keep the dual-write and skip deleting the legacy key until a minimum CLI version is enforced. The cutover should also be called out in the release notes or upgrade docs.
Generated by Libra. Specialist: libra-complexity. React with 👍 or 👎 to give feedback on this comment.
Summary
This PR is the fourth and final phase of fixes for changelog note registry issues.
When it is merged, we can delete leftover
notes-{version}.jsonobjects from S3/CDN.{changelog}:cdn:pages no longer read them.Background
Relates to #4090, #4103
Per #4103 (comment), since the related issues touch the same areas of the code and have a significant, overlapping impact, this PR is part of a multi-PR phased approach.
Details
CdnChangelogFetcheronly loads:bundle/{product}/registry.jsoncloud-4.2.0.yaml,.amend-N,.amend-notes.yaml)src/Elastic.Markdownnever referencesnotes-. Notes indexes are only used bychangelog bundle.Do not delete
bundle/{product}/*.yamlorbundle/{product}/registry.json. Those are what the pages render.This cutover:
notes-{version}.jsonFetchNotesAsync404 fallback;changelog bundleonly GETsnotes-{product}-{version}.jsonA note upload (or
--skip-etag-checkon an existing note) is enough to trigger leftover version-only deletes. Manual S3 deletes of those objects are also safe for directive pages.Generative AI disclosure
Tool(s) and model(s) used: Cursor Grok 4.6