changelog add

Create a changelog file that describes a single item in the release documentation. For details and examples, go to Create changelogs.

Usage

docs-builder changelog add [options...] [-h|--help]

Options

--action <string?>: Optional: What users must do to mitigate.
--areas <string[]?>: Optional: Areas affected (comma-separated or specify multiple times).
--config <string?>: Optional: Path to the changelog.yml configuration file. Defaults to docs/changelog.yml.
--description <string?>: Optional: Additional information about the change (max 600 characters).
--feature-id <string?>: Optional: Feature flag ID
--highlight <bool?>: Optional: Include in release highlights.
--impact <string?>: Optional: How the user's environment is affected.
--issues <string[]?>: Optional: Issue numbers (comma-separated or specify multiple times).
--output <string?>: Optional: Output directory for the changelog fragment. Defaults to current directory.
--owner <string?>: Optional: GitHub repository owner (used when --pr is just a number).
--products <List<ProductInfo>>: Required: Products affected in format "product target lifecycle, ..." (for example, "elasticsearch 9.2.0 ga, cloud-serverless 2025-08-05").; The valid product identifiers are listed in products.yml.; The valid lifecycles are listed in ChangelogConfiguration.cs.
--prs <string[]?>: Optional: Pull request URLs or numbers (if --owner and --repo are provided).; If specified, --title can be derived from the PR.; If mappings are configured, --areas and --type can also be derived from the PR.; Creates one changelog file per PR.
--repo <string?>: Optional: GitHub repository name (used when --pr is just a number).
--subtype <string?>: Optional: Subtype for breaking changes (for example, api, behavioral, or configuration).; The valid subtypes are listed in ChangelogConfiguration.cs.
--title <string>: A short, user-facing title (max 80 characters); Required if --pr is not specified.; If both --pr and --title are specified, the latter value is used instead of what exists in the PR.
--type <string>: Required: Type of change (for example, feature, enhancement, bug-fix, or breaking-change).; The valid types are listed in ChangelogConfiguration.cs.