Skip to content

Default to shared bundle filename pattern - #3985

Merged
Mpdreamz merged 1 commit into
bundle-filenamesfrom
default-bundle-name
Sep 2, 2026
Merged

Default to shared bundle filename pattern#3985
Mpdreamz merged 1 commit into
bundle-filenamesfrom
default-bundle-name

Conversation

@lcawl

@lcawl lcawl commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

This PR is an optional follow-up to #3984

Summary

The option-mode of the changelog bundle command now uses the same {repo}-{product}-{version}.yaml naming as profile mode when --output is omitted or is a directory.

Details

Behavior

  • Explicit .yml / .yaml --output is unchanged.
  • A directory --output (or no --output) joins the conventional name under that directory, bundle.output_directory, or the input directory.
  • Product/version come from --output-products, then --input-products, then --release-version.
  • If those cannot be resolved (--all, PR-only, and similar), the command warns and writes changelog-bundle.yaml.
  • --plan gets the same product lists and --release-version, so output_path matches the run.

The pattern is as follows:

  • Default (including option mode with no --output, or a directory) is {repo}-{product}-{version}.yaml.
  • An explicit option-mode --output file path (with .yml or .yml filename) is used as-is.
  • No authoring repo → warn and {product}-{version}.yaml.
  • No product or version → warn and changelog-bundle.yaml.

Examples

I tried it out with some simple bundle commands like this:

.artifacts/publish/docs-builder/release/docs-builder changelog bundle --prs ./docs/temp/prs.txt --output-products "kibana" --output ./docs/releases/kibana/

Yields the same changelog-bundle.yaml file as previous, but with additional message: Could not resolve a product and version for the bundle file (pass --output-products or --input-products with a concrete target). Using 'changelog-bundle.yaml'.

If I run the command with sufficient info to follow the shared pattern, however, it works. For example:

.artifacts/publish/docs-builder/release/docs-builder changelog bundle --prs ./docs/temp/prs.txt --output-products "cloud-serverless 2026-08-31" --output ./docs/releases/kibana/

... now yields a docs/releases/kibana/kibana-cloud-serverless-2026-08-31.yaml file, same as the profile mode does.

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

@lcawl
lcawl requested a review from a team as a code owner August 31, 2026 20:05
@lcawl
lcawl requested a review from Mpdreamz August 31, 2026 20:05
@lcawl lcawl mentioned this pull request Aug 31, 2026
2 tasks
@Mpdreamz
Mpdreamz force-pushed the default-bundle-name branch from ee25a5e to efe7960 Compare September 2, 2026 18:05
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

@Mpdreamz
Mpdreamz merged commit ede54c5 into main Sep 2, 2026
32 checks passed
@Mpdreamz
Mpdreamz deleted the default-bundle-name branch September 2, 2026 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants