Repo-prefixed changelog bundle output names - #3984
Open
lcawl wants to merge 1 commit into
Open
Conversation
2 tasks
Docs preview (local build)Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/3984/ Sample changed pages: |
2 tasks
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.
Problem
Per #3856 (comment) the changes to the bundle filename make it more likely for multiple repos to overwrite each others' bundles.
Fix
Profile-mode bundles now use
{repo}-{product}-{version}.yamlwhen a repo can be resolved.Naming
--repo→ profilerepo→bundle.repo→ gitorigin(github.com){product}-{version}.yamlname--planuses the same helper as the real write, so docs-actions can still trustoutput_path/cdn_urlTests cover Kibana-style prefixes,
--repo/ profile overrides,elastic/kibana→kibana, git origin, and the no-repo warning path. Existing github-release / git-ref / cloud fixture assertions were updated (for exampleelasticsearch-elasticsearch-9.2.0.yamlwhen repo and product are bothelasticsearch).Not done here
--repo/--ownerin profile mode inbundle-createandbundle-fetch(promotion workflow itself does not need a code change): Support repo-prefixed changelog bundle output names docs-actions#316Tests
Prior to this fix, when I ran a command like this in the kibana repo:
... it created a file
docs/releases/cloud-serverless-2026-08-31.yaml(which is a filename that could be overwritten by the same command run in any of the other repos that create serverless bundles (e.g. elasticsearch).With the fix, it creates
docs/releases/kibana-cloud-serverless-2026-08-31.yamlGenerative AI disclosure
Tool(s) and model(s) used: Cursor Grok 4.6