Add changelog unpack command - #4059
Open
lcawl wants to merge 1 commit into
Open
Conversation
Docs preview (local build)Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/4059/ Sample changed pages: |
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
Adds a
changelog unpackcommand that derives changelog files from a bundle file.Rationale
For PRs like elastic/elasticsearch#158728 where a bundle file has been created, but changelogs are not stored locally and have not been uploaded to the CDN.
Perhaps this might be an exceptional situation in the long-term, but IMO it is useful to be able to reverse-engineer changelogs from bundles.
Details
Unpack is implemented as a mapper onto
changelog add/changelog note, including amend merge and docs for scrubbed public bundles.Command:
docs-builder changelog unpack <bundle.yaml> [--output] [--config] [--concise]CreatePreparedChangelog(same writer as add, no GitHub fetch, no one-file-per-PR split).CreateNote.# PRIVATE:sentinels are unwrapped to the underlying URL..amend-*files like render. Amend inputs unpackentriesonly and skipexclude-entries.file.name. Checksums are not restored.Tests
I used this command to successfully generate changelog files from the bundles like this:
I was then able to successfully make some edits to the changelogs, upload the changelogs to S3, and re-generate the bundles.
Generative AI disclosure
Tool(s) and model(s) used: Cursor Grok 4.6