Skip to content

Commit 6356016

Browse files
committed
Update docs help messages
1 parent 31c80c6 commit 6356016

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/contribute/changelog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ Add a new changelog fragment from command-line input
2626

2727
Options:
2828
--products <List<ProductInfo>> Required: Products affected in format "product target lifecycle, ..." (e.g., "elasticsearch 9.2.0 ga, cloud-serverless 2025-08-05") [Required]
29-
--title <string?> Optional: A short, user-facing title (max 80 characters). Required if --pr is not specified. If --pr is specified, will be derived from PR title if not provided. [Default: null]
30-
--type <string?> Optional: Type of change (feature, enhancement, bug-fix, breaking-change, etc.). Required if --pr is not specified. If --pr is specified, will be derived from PR labels if not provided. [Default: null]
29+
--title <string?> Optional: A short, user-facing title (max 80 characters). Required if --pr is not specified. If --pr and --title are specified, the latter value is used instead of what exists in the PR. [Default: null]
30+
--type <string?> Optional: Type of change (feature, enhancement, bug-fix, breaking-change, etc.). Required if --pr is not specified. If mappings are configured, type can be derived from the PR. [Default: null]
3131
--subtype <string?> Optional: Subtype for breaking changes (api, behavioral, configuration, etc.) [Default: null]
3232
--areas <string[]?> Optional: Area(s) affected (comma-separated or specify multiple times) [Default: null]
33-
--pr <string?> Optional: Pull request URL or PR number (if --owner and --repo are provided). If specified, --title and --type can be derived from the PR. [Default: null]
33+
--pr <string?> Optional: Pull request URL or PR number (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. [Default: null]
3434
--owner <string?> Optional: GitHub repository owner (used when --pr is just a number) [Default: null]
3535
--repo <string?> Optional: GitHub repository name (used when --pr is just a number) [Default: null]
3636
--issues <string[]?> Optional: Issue URL(s) (comma-separated or specify multiple times) [Default: null]

0 commit comments

Comments
 (0)