Skip to content

[DOCS] Describe workflow for amending changelog bundle notes - #4073

Open
lcawl wants to merge 2 commits into
mainfrom
docs-amend-notes
Open

lcawl wants to merge 2 commits into
mainfrom
docs-amend-notes

Conversation

@lcawl

@lcawl lcawl commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Document adding and removing notes from published bundles

Relates to #4072 (documentation of all but the missing functionality)

Details

Canonical how-to is now a subsection of Amend bundles: Add or remove notes after a bundle ships.

Add a late note: changelog notechangelog upload --artifact-type changelog. Do not use bundle-amend --add; the scrubber writes {parent}.amend-notes.yaml.

Remove: local changelog remove never changes published bundles. Notes already in the parent can use bundle-amend --remove plus uploading amend-N. Notes that exist only in .amend-notes have no unpublish command. A warning covers the scrubber putting a still-published pool file back.

The same facts are linked from cmd-note.md, cmd-bundle-amend.md, create.md, cmd-remove.md, overview.md, cmd-upload.md, and changelog-bundle-registry.md. None of those pages tell authors to delete S3 objects.

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

@Mpdreamz Mpdreamz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Reviewed the docs-only workflow update. The late-note guidance is consistent across the CLI and release-notes pages, the reserved .amend-notes ownership is clear, and CI is green. Looks ready once the PR is out of draft.

@lcawl
lcawl marked this pull request as ready for review September 14, 2026 22:24
@lcawl
lcawl requested a review from a team as a code owner September 14, 2026 22:24
@lcawl
lcawl requested a review from akira28 September 14, 2026 22:24

@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.

Approved.


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.

Requesting changes.


What is this? | From workflow: PR Review

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


`changelog remove` only deletes local YAML. It does not change a published bundle or the changelog pool.

- If the note is already embedded in the parent bundle, use `changelog bundle-amend --remove` and upload the numbered sidecar. Refer to [](/data/release-notes/bundle.md#changelog-bundle-notes-after-ship).

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.

This step says to upload the numbered sidecar, but it omits the required artifact type. A reader can reasonably run changelog upload --artifact-type changelog, which won’t amend published bundles. Please make this explicit here (for example: upload {parent}.amend-N.yaml with docs-builder changelog upload --artifact-type bundle).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants