Loading

changelog bundle-amend cli command

docs-builder changelog bundle-amend <bundle-path> [options]

Amend a bundle with additional changelog entries. Amend bundles follow a specific naming convention: {parent-bundle-name}.amend-{N}.yaml where {N} is a sequence number.

To create a bundle, use changelog bundle cli command. For details and examples, go to Bundle changelogs.

<bundle-path> string required

Required: Path to the original bundle file to amend

Constraints: symbolic links not allowed, must exist, extensions: yml, yaml, supports ~ home expansion

--add string[]

Required: Path(s) to changelog YAML file(s) to add as comma-separated values (e.g., --add "file1.yaml,file2.yaml"). Supports tilde (~) expansion and relative paths.

Repeatable: pass --add multiple times to supply more than one value

--[no-]resolve
Optional: Copy the contents of each changelog file into the entries array. Use --no-resolve to explicitly turn off resolve (overrides inference from original bundle).
-l --log-level enum

Minimum log level.

Values: trace, debug, information, warning, error, critical, none

Default: information

-c --config-source enum

Override the configuration source: local, remote

Values: local, remote, embedded

--[no-]skip-private-repositories
Skip cloning private repositories

By default, the bundle-amend command infers whether to resolve entries from the original bundle. If the original bundle contains resolved entries (with inline title, type, and so on), the amend file will also be resolved. If the original bundle contains only file references, the amend file will also contain only file references.

This inference ensures that amend files are portable — they contain everything needed to be understood alongside the original bundle, even when copied to another repository.

You can override this behaviour:

  • --resolve: Force entries to be resolved (inline content), regardless of the original bundle.
  • --no-resolve: Force entries to contain only file references, regardless of the original bundle.

Amend bundles contain only the additional entries, not a full repetition of the original bundle. For example:

# 9.3.0.amend-1.yaml
entries:
- file:
    name: late-addition.yaml
    checksum: abc123def456

When bundles are loaded (either via the changelog render command or the {changelog} directive), amend files are automatically merged with their parent bundles. The entries from all matching amend files are combined with the parent bundle's entries, and the result is rendered as a single release.

Note

Amend bundles do not need to include products or hide-features fields — they inherit these from their parent bundle. If an amend bundle is found without a matching parent bundle, it remains standalone.

rules.bundle filtering does not apply to changelog bundle-amend. The command is a direct-injection escape hatch: the files you specify with --add are always included regardless of any product, type, or area filter configuration.

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

The new bundle automatically matches the resolve style of the original bundle.

docs-builder changelog bundle-amend \
  ./docs/changelog/bundles/9.3.0.yaml \
  --add "./docs/changelog/138723.yaml,./docs/changelog/1770424335.yaml"
		
# Force resolved (inline) entries
docs-builder changelog bundle-amend \
  ./docs/changelog/bundles/9.3.0.yaml \
  --add "./docs/changelog/138723.yaml" \
  --resolve

# Force file-only references
docs-builder changelog bundle-amend 9.3.0.yaml \
  --add ./docs/changelog/late-addition.yaml \
  --no-resolve