﻿---
title: changelog bundle
description: Bundle changelog files. To create the changelogs, use changelog add. For details and examples, go to Create and bundle changelogs. "cloud-serverless 2025-12-02...
url: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/2569/cli/release/changelog-bundle
---

# changelog bundle
Bundle changelog files.
To create the changelogs, use [changelog add](https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/2569/cli/release/changelog-add).
For details and examples, go to [Create and bundle changelogs](https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/2569/contribute/changelog).

## Usage

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


## Options

<definitions>
  <definition term="--all">
    Include all changelogs from the directory.
  </definition>
  <definition term="Only one filter option can be specified: --all, --input-products, or --prs.">
  </definition>
  <definition term="--directory <string?>">
    Optional: The directory that contains the changelog YAML files.
  </definition>
  <definition term="Defaults to the current directory.">
  </definition>
  <definition term="--input-products <List<ProductInfo>?>">
    Filter by products in format "product target lifecycle, ..."
  </definition>
  <definition term="Only one filter option can be specified: --all, --input-products, or --prs.">
  </definition>
  <definition term="When specified, all three parts (product, target, lifecycle) are required but can be wildcards (*). For example:">
  </definition>
</definitions>

- `"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`)

<definitions>
  <definition term="--output <string?>">
    Optional: The output path for the bundle.
  </definition>
  <definition term="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.">
  </definition>
  <definition term="Defaults to changelog-bundle.yaml in the input directory.">
  </definition>
  <definition term="--output-products <List<ProductInfo>?>">
    Optional: Explicitly set the products array in the output file in format "product target lifecycle, ...".
  </definition>
  <definition term="This value replaces information that would otherwise by derived from changelogs.">
  </definition>
  <definition term="--owner <string?>">
    The GitHub repository owner, which is required when pull requests are specified as numbers.
  </definition>
  <definition term="--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.
  </definition>
  <definition term="Only one filter option can be specified: --all, --input-products, or --prs.">
  </definition>
  <definition term="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).">
  </definition>
  <definition term="When specifying PRs directly, provide comma-separated values.">
  </definition>
  <definition term="When specifying a file path, provide a single value that points to a newline-delimited file.">
  </definition>
  <definition term="--repo <string?>">
    The GitHub repository name, which is required when PRs are specified as numbers.
  </definition>
  <definition term="--resolve">
    Optional: Copy the contents of each changelog file into the entries array.
  </definition>
  <definition term="By default, the bundle contains only the file names and checksums.">
  </definition>
</definitions>