22# This file configures the valid values for changelog fields.
33# Place this file as `changelog.yml` in the `docs/` directory
44
5- # Available types for changelog entries
6- available_types :
7- - breaking-change
8- - bug-fix
9- - deprecation
10- - docs
11- - enhancement
12- - feature
13- - known-issue
14- - regression
15- - security
16- - other
5+ # Available products (optional - if not specified, all valid products are allowed)
6+ available_products :
7+ - elasticsearch
8+ - cloud-serverless
9+ # Add more products as needed
10+
11+ # Available types for changelog entries (optional - if not specified, all valid types are allowed)
12+ # available_types:
13+ # - breaking-change
14+ # - bug-fix
15+ # - deprecation
16+ # - docs
17+ # - enhancement
18+ # - feature
19+ # - known-issue
20+ # - regression
21+ # - security
22+ # - other
23+
24+ # GitHub label mappings (optional - used when --pr option is specified)
25+ # Maps GitHub PR labels to changelog type values
26+ # When a PR has a label that matches a key, the corresponding type value is used
27+ label_to_type :
28+ " >breaking " : breaking-change
29+ " >breaking-java " : breaking-change
30+ " >bug " : bug-fix
31+ " >deprecation " : deprecation
32+ " >docs " : docs
33+ " documentation " : docs
34+ " release_note:enhancement " : enhancement
35+ " >enhancement " : enhancement
36+ " >feature " : feature
37+ # "type:known": known-issue
38+ " >regression " : regression
39+ # "type:security": security
40+ # "type:other": other
1741
18- # Available subtypes for breaking changes
19- available_subtypes :
20- - api
21- - behavioral
22- - configuration
23- - dependency
24- - subscription
25- - plugin
26- - security
27- - other
42+ # Available subtypes for breaking changes (optional - if not specified, all valid subtypes are allowed)
43+ # available_subtypes:
44+ # - api
45+ # - behavioral
46+ # - configuration
47+ # - dependency
48+ # - subscription
49+ # - plugin
50+ # - security
51+ # - other
2852
29- # Available lifecycle values
30- available_lifecycles :
31- - preview
32- - beta
33- - ga
53+ # Available lifecycle values (optional - if not specified, all valid lifecycle values are allowed)
54+ # available_lifecycles:
55+ # - preview
56+ # - beta
57+ # - ga
3458
3559# Available areas (optional - if not specified, all areas are allowed)
3660available_areas :
@@ -118,30 +142,6 @@ available_areas:
118142 - Watcher
119143 # Add more areas as needed
120144
121- # Available products (optional - if not specified, all products are allowed)
122- available_products :
123- - elasticsearch
124- - cloud-serverless
125- # Add more products as needed
126-
127- # GitHub label mappings (optional - used when --pr option is specified)
128- # Maps GitHub PR labels to changelog type values
129- # When a PR has a label that matches a key, the corresponding type value is used
130- label_to_type :
131- " >breaking " : breaking-change
132- " >breaking-java " : breaking-change
133- " >bug " : bug-fix
134- " >deprecation " : deprecation
135- " >docs " : docs
136- " documentation " : docs
137- " release_note:enhancement " : enhancement
138- " >enhancement " : enhancement
139- " >feature " : feature
140- # "type:known": known-issue
141- " >regression " : regression
142- # "type:security": security
143- # "type:other": other
144-
145145# Maps GitHub PR labels to changelog area values
146146# Multiple labels can map to the same area, and a single label can map to multiple areas (comma-separated)
147147label_to_areas :
@@ -235,46 +235,49 @@ label_to_areas:
235235# Product-specific label blockers (optional)
236236# Maps product IDs to lists of labels that prevent changelog creation for that product
237237# If you run the changelog add command with the --prs option and a PR has any of these labels, the changelog is not created
238- product_label_blockers :
239- elasticsearch :
240- - " >non-issue"
241- - " >test"
242- - " >refactoring"
243- - " :Delivery/Build"
244- - " :Delivery/Tooling"
245- cloud-serverless :
246- - " >non-issue"
247- - " >test"
248- - " :Delivery/Build"
249- - " :Delivery/Tooling"
250- - " >refactoring"
251- - " :Distributed Coordination/Allocation"
252- - " :Security/Audit"
253- - " :Security/Authentication"
254- - " :Distributed Coordination/Autoscaling"
255- - " :Distributed Indexing/CCR"
256- - " :Search Foundations/CCS"
257- - " :Distributed Coordination/Cluster Coordination"
258- - " :StorageEngine/Codec"
259- - " :Distributed Coordination/Discovery-Plugins"
260- - " :Distributed Indexing/Engine"
261- - " :Security/FIPS"
262- - " :Data Management/Health"
263- - " :Data Management/ILM+SLM"
264- - " :Security/IdentityProvider"
265- - " :Core/Infra/CLI"
266- - " :Core/Infra/Circuit Breakers"
267- - " :Core/Infra/Core"
268- - " :Core/Infra/Entitlements"
269- - " :Core/Infra/Logging"
270- - " :Core/Infra/Metrics"
271- - " :Core/Infra/Node Lifecycle"
272- - " :Core/Infra/Plugins"
273- - " :Core/Infra/Transport API"
274- - " :Security/License"
275- - " :Data Management/Monitoring"
276- - " :Delivery/Packaging"
277- - " :Distributed Indexing/Searchable Snapshots"
278- - " :Distributed Coordination/Snapshot/Restore"
279- - " :Data Management/Stats"
280- - " :Data Management/Watcher"
238+ # add_blockers:
239+ # elasticsearch,cloud-serverless:
240+ # - ">non-issue"
241+ # - ">test"
242+ # - ">refactoring"
243+ # - ":Delivery/Build"
244+ # - ":Delivery/Tooling"
245+
246+ # render_blockers:
247+ # cloud-serverless:
248+ # areas:
249+ # - Allocation
250+ # - Audit
251+ # - Authentication
252+ # - Autoscaling
253+ # - CCR
254+ # - CCS
255+ # - "Cluster Coordination"
256+ # - Codec
257+ # - "Discovery-Plugins"
258+ # - Engine
259+ # - FIPS
260+ # - Health
261+ # - "ILM+SLM"
262+ # - "IdentityProvider"
263+ # - "Infra/CLI"
264+ # - "Circuit Breakers"
265+ # - "Infra/Core"
266+ # - "Infra/Entitlements"
267+ # - "Infra/Logging"
268+ # - "Infra/Metrics"
269+ # - "Infra/Node Lifecycle"
270+ # - "Infra/Plugins"
271+ # - "Infra/Transport API"
272+ # - License
273+ # - Monitoring
274+ # - Packaging
275+ # - Searchable Snapshots
276+ # - "Snapshot/Restore"
277+ # - Stats
278+ # - Watcher
279+ # types:
280+ # - docs
281+ # elasticsearch:
282+ # types:
283+ # - docs
0 commit comments