wip - update release notes automation to use new markdown format

brianseeders · brianseeders · commit e57027468da6 · 2025-03-05T17:27:24.000-05:00
diff --git a/build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/release/GenerateReleaseNotesTask.java b/build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/release/GenerateReleaseNotesTask.java
@@ -139,10 +139,11 @@ public void executeTask() throws IOException {
             );
 
             LOGGER.info("Generating breaking changes / deprecations notes...");
-            BreakingChangesGenerator.update(
+            ReleaseNotesGenerator.update(
                 this.breakingChangesTemplate.get().getAsFile(),
                 this.breakingChangesMigrationFile.get().getAsFile(),
-                entries
+                qualifiedVersion,
+                changelogsByVersion.getOrDefault(qualifiedVersion, Set.of())
             );
 
             LOGGER.info("Updating migration/index...");
diff --git a/build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/release/ReleaseNotesGenerator.java b/build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/release/ReleaseNotesGenerator.java
@@ -39,9 +39,11 @@ public class ReleaseNotesGenerator {
         TYPE_LABELS.put("breaking", "Breaking changes");
         TYPE_LABELS.put("breaking-java", "Breaking Java changes");
         TYPE_LABELS.put("bug", "Bug fixes");
+        TYPE_LABELS.put("fixes", "Fixes");
         TYPE_LABELS.put("deprecation", "Deprecations");
         TYPE_LABELS.put("enhancement", "Enhancements");
         TYPE_LABELS.put("feature", "New features");
+        TYPE_LABELS.put("features-enhancements", "Features and enhancements");
         TYPE_LABELS.put("new-aggregation", "New aggregation");
         TYPE_LABELS.put("regression", "Regressions");
         TYPE_LABELS.put("upgrade", "Upgrades");
@@ -63,16 +65,34 @@ static String generateFile(String template, QualifiedVersion version, Set<Change
         bindings.put("version", version);
         bindings.put("changelogsByTypeByArea", changelogsByTypeByArea);
         bindings.put("TYPE_LABELS", TYPE_LABELS);
+        bindings.put("unqualifiedVersion", version.withoutQualifier());
+        bindings.put("versionWithoutSeparator", version.withoutQualifier().toString().replaceAll("\\.", ""));
 
         return TemplateUtils.render(template, bindings);
     }
 
+    private static String getTypeFromEntry(ChangelogEntry entry) {
+        if (entry.getBreaking() != null) {
+            return "breaking";
+        }
+
+        if (entry.getType().equals("feature") || entry.getType().equals("enhancement")) {
+            return "features-enhancements";
+        }
+
+        if (entry.getType().equals("bug")) {
+            return "fixes";
+        }
+
+        return entry.getType();
+    }
+
     private static Map<String, Map<String, List<ChangelogEntry>>> buildChangelogBreakdown(Set<ChangelogEntry> changelogs) {
         Map<String, Map<String, List<ChangelogEntry>>> changelogsByTypeByArea = changelogs.stream()
             .collect(
                 groupingBy(
                     // Entries with breaking info are always put in the breaking section
-                    entry -> entry.getBreaking() == null ? entry.getType() : "breaking",
+                    entry -> getTypeFromEntry(entry),
                     TreeMap::new,
                     // Group changelogs for each type by their team area
                     groupingBy(
diff --git a/build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/release/ReleaseToolsPlugin.java b/build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/release/ReleaseToolsPlugin.java
@@ -80,26 +80,17 @@ public void apply(Project project) {
             task.setReleaseNotesIndexTemplate(projectDirectory.file(RESOURCES + "templates/release-notes-index.asciidoc"));
             task.setReleaseNotesIndexFile(projectDirectory.file("docs/reference/release-notes.asciidoc"));
 
-            task.setReleaseNotesTemplate(projectDirectory.file(RESOURCES + "templates/release-notes.asciidoc"));
+            task.setReleaseNotesTemplate(projectDirectory.file(RESOURCES + "templates/release-notes.md"));
             task.setReleaseNotesFile(
-                projectDirectory.file(
-                    String.format(
-                        "docs/reference/release-notes/%d.%d.%d.asciidoc",
-                        version.getMajor(),
-                        version.getMinor(),
-                        version.getRevision()
-                    )
-                )
+                projectDirectory.file("docs/release-notes/index.md")
             );
 
             task.setReleaseHighlightsTemplate(projectDirectory.file(RESOURCES + "templates/release-highlights.asciidoc"));
             task.setReleaseHighlightsFile(projectDirectory.file("docs/reference/release-notes/highlights.asciidoc"));
 
-            task.setBreakingChangesTemplate(projectDirectory.file(RESOURCES + "templates/breaking-changes.asciidoc"));
+            task.setBreakingChangesTemplate(projectDirectory.file(RESOURCES + "templates/breaking-changes.md"));
             task.setBreakingChangesMigrationFile(
-                projectDirectory.file(
-                    String.format("docs/reference/migration/migrate_%d_%d.asciidoc", version.getMajor(), version.getMinor())
-                )
+                projectDirectory.file("docs/release-notes/breaking-changes.md")
             );
             task.setMigrationIndexTemplate(projectDirectory.file(RESOURCES + "templates/migration-index.asciidoc"));
             task.setMigrationIndexFile(projectDirectory.file("docs/reference/migration/index.asciidoc"));
diff --git a/build-tools-internal/src/main/resources/templates/breaking-changes.md b/build-tools-internal/src/main/resources/templates/breaking-changes.md
@@ -0,0 +1,30 @@
+---
+navigation_title: "Elasticsearch"
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/reference/current/breaking-changes.html
+---
+
+# Elasticsearch breaking changes [elasticsearch-breaking-changes]
+Before you upgrade, carefully review the Elasticsearch breaking changes and take the necessary steps to mitigate any issues.
+
+To learn how to upgrade, check out <uprade docs>.
+
+% ## Next version [elasticsearch-nextversion-breaking-changes]
+% **Release date:** Month day, year
+
+## ${unqualifiedVersion} [elasticsearch-${versionWithoutSeparator}-breaking-changes]
+**Release date:** April 01, 2025
+<% for (team in changelogsByTypeByArea['breaking'].keySet()) {
+    print "\n${team}:\n";
+
+    for (change in changelogsByTypeByArea['breaking'][team]) {
+        print "* ${change.summary} [#${change.pr}](https://github.com/elastic/elasticsearch/pull/${change.pr})"
+        if (change.issues != null && change.issues.empty == false) {
+            print change.issues.size() == 1 ? " (issue: " : " (issues: "
+            print change.issues.collect { "{es-issue}${it}[#${it}]" }.join(", ")
+            print ")"
+        }
+        print "\n"
+    }
+}
+print "\n\n"
diff --git a/build-tools-internal/src/main/resources/templates/release-notes.md b/build-tools-internal/src/main/resources/templates/release-notes.md
@@ -0,0 +1,47 @@
+---
+navigation_title: "Elasticsearch"
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/reference/current/es-connectors-release-notes.html
+  - https://www.elastic.co/guide/en/elasticsearch/reference/current/es-release-notes.html
+  - https://www.elastic.co/guide/en/elasticsearch/reference/master/release-notes-${unqualifiedVersion}.html
+  - https://www.elastic.co/guide/en/elasticsearch/reference/master/migrating-${version.major}.${version.minor}.html
+---
+
+# Elasticsearch release notes [elasticsearch-release-notes]
+
+Review the changes, fixes, and more in each version of Elasticsearch.
+
+To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31).
+
+% Release notes include only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes sections.
+
+% ## version.next [felasticsearch-next-release-notes]
+% **Release date:** Month day, year
+
+% ### Features and enhancements [elasticsearch-next-features-enhancements]
+% *
+
+% ### Fixes [elasticsearch-next-fixes]
+% *
+
+## ${unqualifiedVersion} [elasticsearch-${versionWithoutSeparator}-release-notes]
+**Release date:** April 01, 2025
+<%
+for (changeType in changelogsByTypeByArea.keySet()) {
+%>
+### ${ TYPE_LABELS.getOrDefault(changeType, 'No mapping for TYPE_LABELS[' + changeType + ']') } [elasticsearch-${versionWithoutSeparator}-${changeType}]
+<% for (team in changelogsByTypeByArea[changeType].keySet()) {
+    print "\n${team}:\n";
+
+    for (change in changelogsByTypeByArea[changeType][team]) {
+        print "* ${change.summary} [#${change.pr}](https://github.com/elastic/elasticsearch/pull/${change.pr})"
+        if (change.issues != null && change.issues.empty == false) {
+            print change.issues.size() == 1 ? " (issue: " : " (issues: "
+            print change.issues.collect { "{es-issue}${it}[#${it}]" }.join(", ")
+            print ")"
+        }
+        print "\n"
+    }
+}
+}
+print "\n\n"
diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md
@@ -5,58 +5,99 @@ mapped_pages:
 ---
 
 # Elasticsearch breaking changes [elasticsearch-breaking-changes]
-Before you upgrade, carefully review the Elasticsearch breaking changes and take the necessary steps to mitigate any issues. 
+Before you upgrade, carefully review the Elasticsearch breaking changes and take the necessary steps to mitigate any issues.
 
 To learn how to upgrade, check out <uprade docs>.
 
 % ## Next version [elasticsearch-nextversion-breaking-changes]
 % **Release date:** Month day, year
 
-## 9.0.0 [elasticsearch-900-breaking-changes]
-**Release date:** March 25, 2025
+## 9.1.0 [elasticsearch-910-breaking-changes]
+**Release date:** April 01, 2025
 
-Allocation
-:   * Increase minimum threshold in shard balancer [#115831](https://github.com/elastic/elasticsearch/pull/115831)
+Aggregations:
+* Remove date histogram boolean support [#118484](https://github.com/elastic/elasticsearch/pull/118484)
+
+Allocation:
+* Increase minimum threshold in shard balancer [#115831](https://github.com/elastic/elasticsearch/pull/115831)
 * Remove `cluster.routing.allocation.disk.watermark.enable_for_single_data_node` setting [#114207](https://github.com/elastic/elasticsearch/pull/114207)
-* Remove cluster state from `/_cluster/reroute` response [#114231](https://github.com/elastic/elasticsearch/pull/114231) (issue: [#88978](https://github.com/elastic/elasticsearch/issues/88978))
+* Remove cluster state from `/_cluster/reroute` response [#114231](https://github.com/elastic/elasticsearch/pull/114231) (issue: {es-issue}88978[#88978])
 
-Analysis
-:   * Snowball stemmers have been upgraded [#114146](https://github.com/elastic/elasticsearch/pull/114146)
-* The *german2* stemmer is now an alias for the *german* snowball stemmer [#113614](https://github.com/elastic/elasticsearch/pull/113614)
-* The *persian* analyzer has stemmer by default [#113482](https://github.com/elastic/elasticsearch/pull/113482) (issue: [#113050](https://github.com/elastic/elasticsearch/issues/113050))
+Analysis:
+* Snowball stemmers have been upgraded [#114146](https://github.com/elastic/elasticsearch/pull/114146)
+* The 'german2' stemmer is now an alias for the 'german' snowball stemmer [#113614](https://github.com/elastic/elasticsearch/pull/113614)
+* The 'persian' analyzer has stemmer by default [#113482](https://github.com/elastic/elasticsearch/pull/113482) (issue: {es-issue}113050[#113050])
 * The Korean dictionary for Nori has been updated [#114124](https://github.com/elastic/elasticsearch/pull/114124)
 
+Authentication:
+* Configuring a bind DN in an LDAP or Active Directory (AD) realm without a corresponding bind password
+will prevent node from starting [#118366](https://github.com/elastic/elasticsearch/pull/118366)
 
-Cluster Coordination
-:   * Remove unsupported legacy value for `discovery.type` [#112903](https://github.com/elastic/elasticsearch/pull/112903)
+Cluster Coordination:
+* Remove unsupported legacy value for `discovery.type` [#112903](https://github.com/elastic/elasticsearch/pull/112903)
 
+EQL:
+* Set allow_partial_search_results=true by default [#120267](https://github.com/elastic/elasticsearch/pull/120267)
 
-Highlighting
-:   * Remove support for deprecated `force_source` highlighting parameter [#116943](https://github.com/elastic/elasticsearch/pull/116943)
+Extract&Transform:
+* Restrict Connector APIs to manage/monitor_connector privileges [#119863](https://github.com/elastic/elasticsearch/pull/119863)
 
+Highlighting:
+* Remove support for deprecated `force_source` highlighting parameter [#116943](https://github.com/elastic/elasticsearch/pull/116943)
 
-Indices APIs
-:   * Apply more strict parsing of actions in bulk API [#115923](https://github.com/elastic/elasticsearch/pull/115923)
+Indices APIs:
+* Apply more strict parsing of actions in bulk API [#115923](https://github.com/elastic/elasticsearch/pull/115923)
 * Remove deprecated local attribute from alias APIs [#115393](https://github.com/elastic/elasticsearch/pull/115393)
+* Remove the ability to read frozen indices [#120108](https://github.com/elastic/elasticsearch/pull/120108)
+* Remove unfreeze REST endpoint [#119227](https://github.com/elastic/elasticsearch/pull/119227)
+
+Infra/Core:
+* Change Elasticsearch timeouts to 429 response instead of 5xx [#116026](https://github.com/elastic/elasticsearch/pull/116026)
+* Limit `ByteSizeUnit` to 2 decimals [#120142](https://github.com/elastic/elasticsearch/pull/120142)
+* Remove `client.type` setting [#118192](https://github.com/elastic/elasticsearch/pull/118192) (issue: {es-issue}104574[#104574])
+* Remove any references to org.elasticsearch.core.RestApiVersion#V_7 [#118103](https://github.com/elastic/elasticsearch/pull/118103)
 
+Infra/Logging:
+* Change `deprecation.elasticsearch` keyword to `elasticsearch.deprecation` [#117933](https://github.com/elastic/elasticsearch/pull/117933) (issue: {es-issue}83251[#83251])
 
-Infra/REST API
-:   * Output a consistent format when generating error json [#90529](https://github.com/elastic/elasticsearch/pull/90529) (issue: [#89387](https://github.com/elastic/elasticsearch/issues/89387))
+Infra/Metrics:
+* Deprecated tracing.apm.* settings got removed. [#119926](https://github.com/elastic/elasticsearch/pull/119926)
 
+Infra/REST API:
+* Output a consistent format when generating error json [#90529](https://github.com/elastic/elasticsearch/pull/90529) (issue: {es-issue}89387[#89387])
 
-Ingest Node
-:   * Remove `ecs` option on `user_agent` processor [#116077](https://github.com/elastic/elasticsearch/pull/116077)
+Ingest Node:
+* Remove `ecs` option on `user_agent` processor [#116077](https://github.com/elastic/elasticsearch/pull/116077)
 * Remove ignored fallback option on GeoIP processor [#116112](https://github.com/elastic/elasticsearch/pull/116112)
 
+Logs:
+* Conditionally enable logsdb by default for data streams matching with logs-*-* pattern. [#121049](https://github.com/elastic/elasticsearch/pull/121049) (issue: {es-issue}106489[#106489])
+
+Machine Learning:
+* Disable machine learning on macOS x86_64 [#104125](https://github.com/elastic/elasticsearch/pull/104125)
+
+Mapping:
+* Remove support for type, fields, `copy_to` and boost in metadata field definition [#118825](https://github.com/elastic/elasticsearch/pull/118825)
+* Turn `_source` meta fieldmapper's mode attribute into a no-op [#119072](https://github.com/elastic/elasticsearch/pull/119072) (issue: {es-issue}118596[#118596])
+
+Search:
+* Adjust `random_score` default field to `_seq_no` field [#118671](https://github.com/elastic/elasticsearch/pull/118671)
+* Change Semantic Text To Act Like A Normal Text Field [#120813](https://github.com/elastic/elasticsearch/pull/120813)
+* Remove legacy params from range query [#116970](https://github.com/elastic/elasticsearch/pull/116970)
+
+Snapshot/Restore:
+* Remove deprecated `xpack.searchable.snapshot.allocate_on_rolling_restart` setting [#114202](https://github.com/elastic/elasticsearch/pull/114202)
 
-Mapping
-:   * Remove support for type, fields, `copy_to` and boost in metadata field definition [#116944](https://github.com/elastic/elasticsearch/pull/116944)
+TLS:
+* Remove TLSv1.1 from default protocols [#121731](https://github.com/elastic/elasticsearch/pull/121731)
 
+Transform:
+* Remove `data_frame_transforms` roles [#117519](https://github.com/elastic/elasticsearch/pull/117519)
 
-Search
-:   * Remove legacy params from range query [#116970](https://github.com/elastic/elasticsearch/pull/116970)
+Vector Search:
+* Remove old `_knn_search` tech preview API in v9 [#118104](https://github.com/elastic/elasticsearch/pull/118104)
 
+Watcher:
+* Removing support for types field in watcher search [#120748](https://github.com/elastic/elasticsearch/pull/120748)
 
-Snapshot/Restore
-:   * Remove deprecated `xpack.searchable.snapshot.allocate_on_rolling_restart` setting [#114202](https://github.com/elastic/elasticsearch/pull/114202)
 
diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md
