Skip to content

Commit ae66d4f

Browse files
authored
Merge branch 'changelog-config' into rn-test
2 parents b3311df + 42a3c43 commit ae66d4f

File tree

1 file changed

+55
-68
lines changed

1 file changed

+55
-68
lines changed

docs/changelog.yml

Lines changed: 55 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,33 @@
22
# This file configures the valid values for changelog fields using the pivot structure.
33
# Place this file as `changelog.yml` in the `docs/` directory
44

5-
# Available products (optional - if not specified, all products from products.yml are allowed)
5+
# Products configuration (optional)
6+
# If not specified, all products from products.yml are allowed
67
products:
7-
- elasticsearch
8-
- cloud-serverless
9-
# Add more products as needed
8+
# List of available product IDs (empty = all from products.yml)
9+
available:
10+
- elasticsearch
11+
- cloud-serverless
12+
# Default products when --products not specified
13+
# default:
14+
# - product: elasticsearch
15+
# lifecycle: ga
16+
17+
# Extraction configuration
18+
# Controls automatic extraction of information from PR descriptions
19+
extract:
20+
# Auto-extract release notes from PR descriptions (default: true)
21+
# Can be overridden by CLI --no-extract-release-notes
22+
release_notes: true
23+
# Auto-extract issues from PR body (default: true)
24+
# Looks for patterns like "Fixes #123", "Closes #456", etc.
25+
issues: true
1026

1127
# Available lifecycle values (strongly typed: preview, beta, ga)
12-
# lifecycles:
13-
# - preview
14-
# - beta
15-
# - ga
28+
lifecycles:
29+
- preview
30+
- beta
31+
- ga
1632

1733
# Pivot configuration for types, subtypes, and areas with label mappings.
1834
# By default we render entries grouped by type > subtype > area.
@@ -30,23 +46,23 @@ pivot:
3046
breaking-change:
3147
labels: ">breaking"
3248
subtypes:
33-
# api: ">api-breaking"
34-
# behavioral: ">behavioral-breaking"
35-
# configuration: ">config-breaking"
36-
# dependency: ">dependency-breaking"
37-
# subscription: ">subscription-breaking"
38-
# plugin: ">plugin-breaking"
39-
# security: ">security-breaking"
49+
api:
50+
behavioral:
51+
configuration:
52+
dependency:
53+
subscription:
54+
plugin:
55+
security:
4056
other: ">breaking-java"
4157
# Simple string form: labels as comma-separated string
4258
bug-fix: ">bug"
4359
deprecation: ">deprecation"
4460
docs: ">docs, documentation"
4561
enhancement: "release_note:enhancement, >enhancement"
4662
feature: ">feature"
47-
known-issue: "release_note:known-issue"
63+
known-issue:
4864
regression: ">regression"
49-
security: "release_note:security"
65+
security:
5066
other: ">upgrade"
5167

5268
# Area definitions with labels
@@ -138,56 +154,6 @@ pivot:
138154
"Vector search": ":Search Relevance/Vectors"
139155
Watcher: ":Data Management/Watcher"
140156

141-
# Product-specific label blockers (optional)
142-
# Maps product IDs to lists of labels that prevent changelog creation for that product
143-
# If you run the changelog add command with the --prs option and a PR has any of these labels, the changelog is not created
144-
# add_blockers:
145-
# elasticsearch,cloud-serverless:
146-
# - ">non-issue"
147-
# - ">test"
148-
# - ">refactoring"
149-
# - ":Delivery/Build"
150-
# - ":Delivery/Tooling"
151-
152-
# render_blockers:
153-
# cloud-serverless:
154-
# areas:
155-
# - Allocation
156-
# - Audit
157-
# - Authentication
158-
# - Autoscaling
159-
# - CCR
160-
# - CCS
161-
# - "Cluster Coordination"
162-
# - Codec
163-
# - "Discovery-Plugins"
164-
# - Engine
165-
# - FIPS
166-
# - Health
167-
# - "ILM+SLM"
168-
# - "IdentityProvider"
169-
# - "Infra/CLI"
170-
# - "Circuit Breakers"
171-
# - "Infra/Core"
172-
# - "Infra/Entitlements"
173-
# - "Infra/Logging"
174-
# - "Infra/Metrics"
175-
# - "Infra/Node Lifecycle"
176-
# - "Infra/Plugins"
177-
# - "Infra/Transport API"
178-
# - License
179-
# - Monitoring
180-
# - Packaging
181-
# - Searchable Snapshots
182-
# - "Snapshot/Restore"
183-
# - Stats
184-
# - Watcher
185-
# types:
186-
# - docs
187-
# elasticsearch:
188-
# types:
189-
# - docs
190-
191157
# Block configuration - combined create and publish blockers
192158
block:
193159
# Global labels that block changelog creation for all products (comma-separated string)
@@ -239,4 +205,25 @@ block:
239205
- Stats
240206
- Watcher
241207
types:
242-
- docs
208+
- docs
209+
210+
# Bundle configuration (profiles and defaults)
211+
# bundle:
212+
# Input directory containing changelog YAML files
213+
# directory: docs/changelog
214+
# Output directory for bundled changelog files
215+
# output_directory: docs/releases
216+
# Whether to resolve (copy contents) by default
217+
# resolve: true
218+
219+
# Named bundle profiles for different release scenarios
220+
# profiles:
221+
# Example: Elasticsearch release profile
222+
# elasticsearch-release:
223+
# products: "elasticsearch {version} {lifecycle}"
224+
# output: "elasticsearch-{version}.yaml"
225+
226+
# Example: Serverless release profile
227+
# serverless-release:
228+
# products: "cloud-serverless {version} *"
229+
# output: "serverless-{version}.yaml"

0 commit comments

Comments
 (0)