Skip to content

Support notes-product-version.json indices - #4120

Open
lcawl wants to merge 3 commits into
mainfrom
changelog-note-registry-fixes
Open

lcawl wants to merge 3 commits into
mainfrom
changelog-note-registry-fixes

Conversation

@lcawl

@lcawl lcawl commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR adds product-scoped notes indexes that are additive.
To ensure we don't break existing changelog users, the legacy notes-{version}.json keys stay, and {changelog} still does not read those indexes.

Background

Relates to #4090, #4103

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

Indexes. The scrubber now writes changelog/{org}/{repo}/notes-{product}-{version}.json (with product and version on the body) and still dual-writes notes-{version}.json as a version union without those fields. Stale product-scoped keys can be deleted; a version-only key is kept while any note still declares that version.

Consumers. changelog bundle GETs the product-scoped URL first and falls back to the version-only URL only on HTTP 404. An empty product-scoped index does not fall back. MergeNotesAsync walks each (product, version) from --output-products and still dedups by checksum.

Docs (same change set). docs/development/changelog-bundle-registry.md, docs/cli/changelog/cmd-note.md, and docs/cli/changelog/cmd-backfill.md.

The dual-write path is in the changelog-scrubber Lambda. It will not show up on the live CDN until that Lambda is deployed.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: Cursor Grok 4.6

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes: the current product/version notes flow can surface wrong-product notes in both CDN fallback and amend reconciliation paths.


What is this? | From workflow: PR Review

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No blocking issues found.


What is this? | From workflow: PR Review

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

This branch was successfully deployed

2 active deployments
docs-preview 09940a00 Deployed Sep 22, 2026 by github-actions[bot]
assembler-preview 09940a00 Deployed Sep 22, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants