You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
: Optional: Output directory for the changelog fragment. Defaults to current directory.
40
40
41
+
`--owner <string?>`
42
+
: Optional: GitHub repository owner (used when `--pr` is just a number).
43
+
41
44
`--products <List<ProductInfo>>`
42
45
: Required: Products affected in format "product target lifecycle, ..." (for example, `"elasticsearch 9.2.0 ga, cloud-serverless 2025-08-05"`).
43
46
: The valid product identifiers are listed in [products.yml](https://github.com/elastic/docs-builder/blob/main/config/products.yml).
44
47
: The valid lifecycles are listed in [ChangelogConfiguration.cs](https://github.com/elastic/docs-builder/blob/main/src/services/Elastic.Documentation.Services/Changelog/ChangelogConfiguration.cs).
45
48
46
49
`--pr <string?>`
47
-
: Optional: Pull request number.
50
+
: Optional: Pull request URL or number (if `--owner` and `--repo` are provided).
51
+
: If specified, `--title` can be derived from the PR.
52
+
: If mappings are configured, `--areas` and `--type` can also be derived from the PR.
53
+
54
+
`--repo <string?>`
55
+
: Optional: GitHub repository name (used when `--pr` is just a number).
48
56
49
57
`--subtype <string?>`
50
58
: Optional: Subtype for breaking changes (for example, `api`, `behavioral`, or `configuration`).
51
59
: The valid subtypes are listed in [ChangelogConfiguration.cs](https://github.com/elastic/docs-builder/blob/main/src/services/Elastic.Documentation.Services/Changelog/ChangelogConfiguration.cs).
52
60
53
61
`--title <string>`
54
-
: Required: A short, user-facing title (max 80 characters)
62
+
: A short, user-facing title (max 80 characters)
63
+
: Required if `--pr` is not specified.
64
+
: If both `--pr` and `--title` are specified, the latter value is used instead of what exists in the PR.
55
65
56
66
`--type <string>`
57
67
: Required: Type of change (for example, `feature`, `enhancement`, `bug-fix`, or `breaking-change`).
--description <string?> Optional: Additional information about the change (max 600 characters) (Default: null)
36
-
--impact <string?> Optional: How the user's environment is affected (Default: null)
37
-
--action <string?> Optional: What users must do to mitigate (Default: null)
38
-
--feature-id <string?> Optional: Feature flag ID (Default: null)
39
-
--highlight <bool?> Optional: Include in release highlights (Default: null)
40
-
--output <string?> Optional: Output directory for the changelog fragment. Defaults to current directory (Default: null)
41
-
--config <string?> Optional: Path to the changelog.yml configuration file. Defaults to 'docs/changelog.yml' (Default: null)
28
+
--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]
--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]
34
+
--owner <string?> Optional: GitHub repository owner (used when --pr is just a number) [Default: null]
35
+
--repo <string?> Optional: GitHub repository name (used when --pr is just a number) [Default: null]
1. The type values are defined in [ChangelogConfiguration.cs](https://github.com/elastic/docs-builder/blob/main/src/services/Elastic.Documentation.Services/Changelog/ChangelogConfiguration.cs).
93
-
2. The product values are defined in [products.yml](https://github.com/elastic/docs-builder/blob/main/config/products.yml).
94
-
3. At this time, the PR value can be a number or a URL; it is not validated.
94
+
1. This option is required only if you want to override what's derived from the PR title.
95
+
2. The type values are defined in [ChangelogConfiguration.cs](https://github.com/elastic/docs-builder/blob/main/src/services/Elastic.Documentation.Services/Changelog/ChangelogConfiguration.cs).
96
+
3. The product values are defined in [products.yml](https://github.com/elastic/docs-builder/blob/main/config/products.yml).
97
+
4. The `--pr` value can be a full URL (such as `https://github.com/owner/repo/pull/123`, a short format (such as `owner/repo#123`) or just a number (in which case you must also provide `--owner` and `--repo` options).
Copy file name to clipboardExpand all lines: src/tooling/docs-builder/Commands/ChangelogCommand.cs
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -31,12 +31,12 @@ public Task<int> Default()
31
31
/// <summary>
32
32
/// Add a new changelog fragment from command-line input
33
33
/// </summary>
34
-
/// <param name="title">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.</param>
34
+
/// <param name="title">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.</param>
35
35
/// <param name="type">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.</param>
36
36
/// <param name="products">Required: Products affected in format "product target lifecycle, ..." (e.g., "elasticsearch 9.2.0 ga, cloud-serverless 2025-08-05")</param>
/// <param name="areas">Optional: Area(s) affected (comma-separated or specify multiple times)</param>
39
-
/// <param name="pr">Optional: Pull request URL or PR number (if --owner and --repo are provided). If specified, --title and --type can be derived from the PR.</param>
39
+
/// <param name="pr">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.</param>
40
40
/// <param name="owner">Optional: GitHub repository owner (used when --pr is just a number)</param>
41
41
/// <param name="repo">Optional: GitHub repository name (used when --pr is just a number)</param>
42
42
/// <param name="issues">Optional: Issue URL(s) (comma-separated or specify multiple times)</param>
0 commit comments