Loading

changelog bundle-amend

Amend a bundle with additional changelog entries, creating an immutable .amend-N.yaml file.

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

docs-builder changelog bundle-amend [arguments...] [options...] [-h|--help]
<string>
Required: Path to the original bundle file to amend.
--add <string[]?>
Required: Path(s) to changelog YAML file(s) to add as comma-separated values. Supports tilde (~) expansion and relative paths.
--resolve
Optional: Copy the contents of each changelog file into the entries array. Defaults to false.
docs-builder changelog bundle-amend \
  ./docs/changelog/bundles/9.3.0.yaml \
  --add ./docs/changelog/138723.yaml

Specify multiple files as comma-separated values:

docs-builder changelog bundle-amend \
  ./docs/changelog/bundles/9.3.0.yaml \
  --add "./docs/changelog/138723.yaml,./docs/changelog/1770424335.yaml"

The command supports tilde expansion, relative paths, and absolute paths:

# With tilde expansion
docs-builder changelog bundle-amend \
  ~/docs/changelog/bundles/9.3.0.yaml \
  --add "~/docs/changelog/138723.yaml,~/docs/changelog/1770424335.yaml"

# With relative paths
docs-builder changelog bundle-amend \
  ./bundles/9.3.0.yaml \
  --add "./138723.yaml,./1770424335.yaml"

# With absolute paths
docs-builder changelog bundle-amend \
  /path/to/bundles/9.3.0.yaml \
  --add "/path/to/138723.yaml,/path/to/1770424335.yaml"

Use --resolve to copy the full contents of each changelog file into the bundle entries array:

docs-builder changelog bundle-amend \
  ./docs/changelog/bundles/9.3.0.yaml \
  --add "./docs/changelog/138723.yaml,./docs/changelog/1770424335.yaml" \
  --resolve