Skip to content

Commit 33a2d5c

Browse files
committed
Refactored the release notes generator
script with the following improvements: 1. Renamed output formats: - standard → integrated: All repositories' changes are integrated together - core-enterprise → separated: Primary repository first, then secondary repositories 2. Generalized the separated format: - Configurable primary repository (by name or index) - Customizable section labels and headers - Flexible template system for different products 3. Enhanced configuration system: - Per-repository PR link settings - Full template customization for separated format - Support for configuration files 4. Created example configurations: - config/influxdb3-core-enterprise.json: For InfluxDB 3 Core/Enterprise releases - config/influxdb-v2.json: For InfluxDB v2 releases - config/influxdb3-clustered.json: For Clustered (Kubernetes operator) releases 5. Updated documentation: - Explained both output formats clearly - Added configuration options documentation - Included example configurations usage The script now provides a flexible system that can handle various release note formats for different InfluxData products while maintaining the specific requirements like excluding PR links for influxdb_pro but including them for influxdb.
1 parent 85d8b29 commit 33a2d5c

File tree

5 files changed

+365
-159
lines changed

5 files changed

+365
-159
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"outputFormat": "integrated",
3+
"repositories": [
4+
{
5+
"name": "influxdb",
6+
"path": "../influxdb",
7+
"label": "influxdb",
8+
"includePrLinks": true
9+
},
10+
{
11+
"name": "plutonium",
12+
"path": "https://github.com/influxdata/plutonium",
13+
"label": "enterprise_v1",
14+
"includePrLinks": false
15+
}
16+
]
17+
}
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"outputFormat": "integrated",
3+
"repositories": [
4+
{
5+
"name": "influxdb",
6+
"path": "../influxdb",
7+
"label": "influxdb",
8+
"includePrLinks": true
9+
}
10+
]
11+
}
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"outputFormat": "separated",
3+
"primaryRepo": "influxdb",
4+
"repositories": [
5+
{
6+
"name": "influxdb",
7+
"path": "../influxdb",
8+
"label": "influxdb",
9+
"includePrLinks": true
10+
},
11+
{
12+
"name": "influxdb_pro",
13+
"path": "../influxdb_pro",
14+
"label": "influxdb_pro",
15+
"includePrLinks": true
16+
}
17+
],
18+
"separatedTemplate": {
19+
"header": "> [!Note]\n> #### InfluxDB 3 Core and Enterprise relationship\n>\n> InfluxDB 3 Enterprise is a superset of InfluxDB 3 Core.\n> All updates to Core are automatically included in Enterprise.\n> The Enterprise sections below only list updates exclusive to Enterprise.",
20+
"primaryLabel": "Core",
21+
"secondaryLabel": "Enterprise",
22+
"secondaryIntro": "All Core updates are included in Enterprise. Additional Enterprise-specific features and fixes:",
23+
"comment": "If you plan to run .claude enhance-release-notes after this, you need to include PR links. For Enterprise, remove the links after running .claude enhance-release-notes."
24+
}
25+
}

0 commit comments

Comments
 (0)