Loading

changelog bundle

Bundle changelog files.

To create the changelogs, use changelog add. For details and examples, go to Create and bundle changelogs.

docs-builder  changelog bundle [arguments...] [options...] [-h|--help]

You can use either profile-based bundling (for example, bundle elasticsearch-release 9.2.0) or raw flags (bundle --all). These arguments apply to profile-based bundling:

[0] <string?>
Profile name from bundle.profiles in the changelog configuration file.
For example, "elasticsearch-release".
When it's specified, the second argument is the version or promotion report URL.
[1] <string?>
Version number or promotion report URL or path.
For example, "9.2.0" or "https://buildkite.../promotion-report.html".
--all
Include all changelogs from the directory.
Only one filter option can be specified: --all, --input-products, or --prs.
--config <string?>
Optional: Path to the changelog.yml configuration file.
Defaults to docs/changelog.yml.
--directory <string?>
Optional: The directory that contains the changelog YAML files.
Defaults to the current directory.
--hide-features <string[]?>
Optional: Filter by feature IDs (comma-separated), or a path to a newline-delimited file containing feature IDs.
Can be specified multiple times.
Entries with matching feature-id values will be commented out when the bundle is rendered (by the changelog render command or {changelog} directive).
--input-products <List<ProductInfo>?>
Filter by products in format "product target lifecycle, ..."
Only one filter option can be specified: --all, --input-products, or --prs.
When specified, all three parts (product, target, lifecycle) are required but can be wildcards (*). For example:
  • "cloud-serverless 2025-12-02 ga, cloud-serverless 2025-12-06 beta" - exact matches
  • "cloud-serverless 2025-12-02 *" - match cloud-serverless 2025-12-02 with any lifecycle
  • "elasticsearch * *" - match all elasticsearch changelogs
  • "* 9.3.* *" - match any product with target starting with "9.3."
  • "* * *" - match all changelogs (equivalent to --all)
--no-resolve
Optional: Explicitly turn off the resolve option if it's specified in the changelog configuration file.
--output <string?>
Optional: The output path for the bundle.
Can be either (1) a directory path, in which case changelog-bundle.yaml is created in that directory, or (2) a file path ending in .yml or .yaml.
Defaults to changelog-bundle.yaml in the input directory.
--output-products <List<ProductInfo>?>
Optional: Explicitly set the products array in the output file in format "product target lifecycle, ...".
This value replaces information that would otherwise by derived from changelogs.
--owner <string?>
The GitHub repository owner, which is required when pull requests are specified as numbers.
--prs <string[]?>
Filter by pull request URLs or numbers (comma-separated), or a path to a newline-delimited file containing PR URLs or numbers. Can be specified multiple times.
Only one filter option can be specified: --all, --input-products, or --prs.
Each occurrence can be either comma-separated PRs (e.g., --prs "https://github.com/owner/repo/pull/123,6789") or a file path (e.g., --prs /path/to/file.txt).
When specifying PRs directly, provide comma-separated values.
When specifying a file path, provide a single value that points to a newline-delimited file.
--repo <string?>
The GitHub repository name, which is required when PRs are specified as numbers.
--resolve
Optional: Copy the contents of each changelog file into the entries array.
By default, the bundle contains only the file names and checksums.