changelog: fetch scrubbed bundle from the CDN for the bundle PR flow#182
Open
cotti wants to merge 3 commits into
Open
changelog: fetch scrubbed bundle from the CDN for the bundle PR flow#182cotti wants to merge 3 commits into
cotti wants to merge 3 commits into
Conversation
Make changelog-bundle-pr.yml fetch-only: instead of regenerating the bundle locally, download the already-uploaded, scrubbed copy from the public CDN and open a PR with it, so the committed file matches what was published to S3 (private references removed). - Add the changelog/bundle-fetch composite action: resolve the plan (output_path + cdn_url), poll the CDN with exponential backoff to absorb scrubbing/CloudFront propagation latency, and upload the bundle artifact. - Split changelog-bundle-pr.yml into a read-only fetch job and a write create-pr job. - bundle-pr: make the artifact source description action-agnostic. - Document CDN entry sourcing (bundle.use_local_changelogs) and the fetch-only PR flow in the changelog READMEs. Requires the matching docs-builder change (cdn_url plan output + entry registry); the fetch action fails clearly until that ships to edge. Co-authored-by: Cursor <cursoragent@cursor.com>
Make it easier to pick how to create a bundle: open the section with two choices (how the bundle is delivered, how its entries are selected) as scannable tables that link to the matching recipe, instead of inferring them from prose. Co-authored-by: Cursor <cursoragent@cursor.com>
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.
Important
Depends on elastic/docs-builder#3470 (adds the
cdn_urlplan output and the per-product entry registry). Thebundle-fetchaction fails clearly until that change ships to the docs-builder edge image, so merge/release that first.Summary
Make
changelog-bundle-pr.ymlfetch-only. Instead of regenerating the bundle locally and committing whatever the runner produced, it downloads the already-uploaded, scrubbed copy from the public CDN and opens the PR with that — so the committed file matches exactly what was published to S3 (private references removed).What changed
changelog/bundle-fetchcomposite action: resolves the plan (output_path+cdn_url), polls the CDN with exponential backoff (~5s → 60s cap, ~10 min budget) to absorb scrubbing + CloudFront propagation latency, then uploads the bundle as an artifact. Fails the job if the bundle never appears.changelog-bundle-pr.ymlsplit into a read-only fetch job and a write create-pr job.bundle-pr: input descriptions (output,artifact-name) made source-agnostic, since the artifact can now come from eitherbundle-createorbundle-fetch.bundle.use_local_changelogs) and the fetch-only PR flow across the changelog READMEs.Rollout ordering
changelog-bundle.yml) must run for a product/version before the PR workflow can fetch it.Test plan
changelog-bundle.ymlto upload a bundlechangelog-bundle-pr.ymlfetch job resolvescdn_urland downloads the scrubbed bundleMade with Cursor