Skip to content

Commit 831717b

Browse files
committed
Add ignored files
1 parent 0d4c17f commit 831717b

File tree

2 files changed

+65
-0
lines changed

2 files changed

+65
-0
lines changed

docs/cli/release/changelog-add.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# changelog add
2+
3+
Create a changelog file that describes a single item in the release documentation.
4+
For details and examples, go to [](/contribute/changelog.md).
5+
6+
## Usage
7+
8+
```sh
9+
docs-builder changelog add [options...] [-h|--help]
10+
```
11+
12+
## Options
13+
14+
`--action <string?>`
15+
: Optional: What users must do to mitigate.
16+
17+
`--areas <string[]?>`
18+
: Optional: Areas affected (comma-separated or specify multiple times).
19+
20+
`--config <string?>`
21+
: Optional: Path to the changelog.yml configuration file. Defaults to `docs/changelog.yml`.
22+
23+
`--description <string?>`
24+
: Optional: Additional information about the change (max 600 characters).
25+
26+
`--feature-id <string?>`
27+
: Optional: Feature flag ID
28+
29+
`--highlight <bool?>`
30+
: Optional: Include in release highlights.
31+
32+
`--impact <string?>`
33+
: Optional: How the user's environment is affected.
34+
35+
`--issues <string[]?>`
36+
: Optional: Issue numbers (comma-separated or specify multiple times).
37+
38+
`--output <string?>`
39+
: Optional: Output directory for the changelog fragment. Defaults to current directory.
40+
41+
`--products <List<ProductInfo>>`
42+
: Required: Products affected in format "product target lifecycle, ..." (for example, `"elasticsearch 9.2.0 ga, cloud-serverless 2025-08-05"`).
43+
44+
`--pr <string?>`
45+
: Optional: Pull request number.
46+
47+
`--subtype <string?>`
48+
: Optional: Subtype for breaking changes (for example, `api`, `behavioral`, or `configuration`).
49+
50+
`--title <string>`
51+
: Required: A short, user-facing title (max 80 characters)
52+
53+
`--type <string>`
54+
: Required: Type of change (for example, `feature`, `enhancement`, `bug-fix`, or `breaking-change`)

docs/cli/release/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
navigation_title: "release"
3+
---
4+
5+
# Release doc commands
6+
7+
These commands are associated with product release documentation.
8+
9+
## Changelog commands
10+
11+
- [changelog add](changelog-add.md) - Create a changelog file

0 commit comments

Comments
 (0)