Fix up release highlights, add tests

Author: brianseeders

build-tools-internal/src/main/resources/templates/index.md

@@ -26,10 +26,9 @@ To check for security updates, go to [Security announcements for the Elastic sta
 
 ## ${unqualifiedVersion} [elasticsearch-${versionWithoutSeparator}-release-notes]
 **Release date:** April 01, 2025
-
 <%
 if (!notableHighlights.isEmpty() || !nonNotableHighlights.isEmpty()) {
-    print "### Highlights\n"
+    print "\n### Highlights [elasticsearch-${versionWithoutSeparator}-highlights]\n"
 }
 
 for (highlights in [notableHighlights, nonNotableHighlights]) {

build-tools-internal/src/test/java/org/elasticsearch/gradle/internal/release/ReleaseNotesGeneratorTest.java

@@ -19,6 +19,7 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 import static org.hamcrest.Matchers.equalTo;
 import static org.junit.Assert.assertThat;
@@ -44,6 +45,21 @@ public void generateFile_index_rendersCorrectMarkup() throws Exception {
         testTemplate("index.md");
     }
 
+    @Test
+    public void generateFile_index_noHighlights_rendersCorrectMarkup() throws Exception {
+        Set<ChangelogEntry> entries = getEntries();
+        entries = entries.stream().filter(e -> e.getHighlight() == null).collect(Collectors.toSet());
+
+        testTemplate("index.md", "index.no-highlights.md", entries);
+    }
+
+    @Test
+    public void generateFile_index_noChanges_rendersCorrectMarkup() throws Exception {
+        Set<ChangelogEntry> entries = new HashSet<>();
+
+        testTemplate("index.md", "index.no-changes.md", entries);
+    }
+
     @Test
     public void generateFile_breakingChanges_rendersCorrectMarkup() throws Exception {
         testTemplate("breaking-changes.md");
@@ -55,13 +71,21 @@ public void generateFile_deprecations_rendersCorrectMarkup() throws Exception {
     }
 
     public void testTemplate(String templateFilename) throws Exception {
+        testTemplate(templateFilename, templateFilename, null);
+    }
+
+    public void testTemplate(String templateFilename, String outputFilename) throws Exception {
+        testTemplate(templateFilename, outputFilename, null);
+    }
+
+    public void testTemplate(String templateFilename, String outputFilename, Set<ChangelogEntry> entries) throws Exception {
         // given:
         final String template = getResource("/templates/" + templateFilename);
-        final String expectedOutput = getResource(
-            "/org/elasticsearch/gradle/internal/release/ReleaseNotesGeneratorTest." + templateFilename
-        );
+        final String expectedOutput = getResource("/org/elasticsearch/gradle/internal/release/ReleaseNotesGeneratorTest." + outputFilename);
 
-        final Set<ChangelogEntry> entries = getEntries();
+        if (entries == null) {
+            entries = getEntries();
+        }
 
         // when:
         final String actualOutput = ReleaseNotesGenerator.generateFile(template, QualifiedVersion.of("8.2.0-SNAPSHOT"), entries);
@@ -76,6 +100,10 @@ private Set<ChangelogEntry> getEntries() {
             entries.addAll(buildEntries(i, 2));
         }
 
+        entries.add(makeHighlightsEntry(5001, false));
+        entries.add(makeHighlightsEntry(5000, true));
+        entries.add(makeHighlightsEntry(5002, true));
+
         return entries;
     }
 
@@ -110,6 +138,30 @@ private List<ChangelogEntry> buildEntries(int seed, int count) {
         return entries;
     }
 
+    private List<ChangelogEntry> getHighlightsEntries() {
+        ChangelogEntry entry123 = makeHighlightsEntry(123, true);
+        ChangelogEntry entry456 = makeHighlightsEntry(456, true);
+        ChangelogEntry entry789 = makeHighlightsEntry(789, false);
+        // Return unordered list, to test correct re-ordering
+        return List.of(entry456, entry123, entry789);
+    }
+
+    private ChangelogEntry makeHighlightsEntry(int pr, boolean notable) {
+        ChangelogEntry entry = new ChangelogEntry();
+        entry.setPr(pr);
+        ChangelogEntry.Highlight highlight = new ChangelogEntry.Highlight();
+        entry.setHighlight(highlight);
+
+        highlight.setNotable(notable);
+        highlight.setTitle((notable ? "[Notable] " : "") + "Release highlight number " + pr);
+        highlight.setBody("Release highlight body number " + pr);
+        entry.setType("feature");
+        entry.setArea("Search");
+        entry.setSummary("");
+
+        return entry;
+    }
+
     private String getResource(String name) throws Exception {
         return Files.readString(Paths.get(Objects.requireNonNull(this.getClass().getResource(name)).toURI()), StandardCharsets.UTF_8);
     }

build-tools-internal/src/test/resources/org/elasticsearch/gradle/internal/release/ReleaseNotesGeneratorTest.index.md

@@ -27,42 +27,65 @@ To check for security updates, go to [Security announcements for the Elastic sta
 ## 8.2.0 [elasticsearch-820-release-notes]
 **Release date:** April 01, 2025
 
+### Highlights [elasticsearch-820-highlights]
+
+::::{dropdown} [Notable] Release highlight number 5000
+Release highlight body number 5000
+
+For more information, check [PR #5000](https://github.com/elastic/elasticsearch/pull/5000).
+::::
+
+::::{dropdown} [Notable] Release highlight number 5002
+Release highlight body number 5002
+
+For more information, check [PR #5002](https://github.com/elastic/elasticsearch/pull/5002).
+::::
+
+::::{dropdown} Release highlight number 5001
+Release highlight body number 5001
+
+For more information, check [PR #5001](https://github.com/elastic/elasticsearch/pull/5001).
+::::
+
 ### Features and enhancements [elasticsearch-820-features-enhancements]
 
 Aggregation:
-* Test changelog entry 6_0 [#6000](https://github.com/elastic/elasticsearch/pull/6000) (issue: {es-issue}6001[#6001])
-* Test changelog entry 6_1 [#6002](https://github.com/elastic/elasticsearch/pull/6002) (issues: {es-issue}6003[#6003], {es-issue}6004[#6004])
+* Test changelog entry 6_0 [#6000](https://github.com/elastic/elasticsearch/pull/6000) (issue: [#6000](https://github.com/elastic/elasticsearch/pull/6000))
+* Test changelog entry 6_1 [#6002](https://github.com/elastic/elasticsearch/pull/6002) (issues: [#6002](https://github.com/elastic/elasticsearch/pull/6002), [#6002](https://github.com/elastic/elasticsearch/pull/6002))
 
 Cluster:
-* Test changelog entry 7_0 [#7000](https://github.com/elastic/elasticsearch/pull/7000) (issue: {es-issue}7001[#7001])
-* Test changelog entry 7_1 [#7002](https://github.com/elastic/elasticsearch/pull/7002) (issues: {es-issue}7003[#7003], {es-issue}7004[#7004])
+* Test changelog entry 7_0 [#7000](https://github.com/elastic/elasticsearch/pull/7000) (issue: [#7000](https://github.com/elastic/elasticsearch/pull/7000))
+* Test changelog entry 7_1 [#7002](https://github.com/elastic/elasticsearch/pull/7002) (issues: [#7002](https://github.com/elastic/elasticsearch/pull/7002), [#7002](https://github.com/elastic/elasticsearch/pull/7002))
 
 Indices:
-* Test changelog entry 8_0 [#8000](https://github.com/elastic/elasticsearch/pull/8000) (issue: {es-issue}8001[#8001])
-* Test changelog entry 8_1 [#8002](https://github.com/elastic/elasticsearch/pull/8002) (issues: {es-issue}8003[#8003], {es-issue}8004[#8004])
+* Test changelog entry 8_0 [#8000](https://github.com/elastic/elasticsearch/pull/8000) (issue: [#8000](https://github.com/elastic/elasticsearch/pull/8000))
+* Test changelog entry 8_1 [#8002](https://github.com/elastic/elasticsearch/pull/8002) (issues: [#8002](https://github.com/elastic/elasticsearch/pull/8002), [#8002](https://github.com/elastic/elasticsearch/pull/8002))
 
 Search:
-* Test changelog entry 10_0 [#10000](https://github.com/elastic/elasticsearch/pull/10000) (issue: {es-issue}10001[#10001])
-* Test changelog entry 10_1 [#10002](https://github.com/elastic/elasticsearch/pull/10002) (issues: {es-issue}10003[#10003], {es-issue}10004[#10004])
+*  [#5002](https://github.com/elastic/elasticsearch/pull/5002)
+*  [#5000](https://github.com/elastic/elasticsearch/pull/5000)
+*  [#5001](https://github.com/elastic/elasticsearch/pull/5001)
+* Test changelog entry 10_0 [#10000](https://github.com/elastic/elasticsearch/pull/10000) (issue: [#10000](https://github.com/elastic/elasticsearch/pull/10000))
+* Test changelog entry 10_1 [#10002](https://github.com/elastic/elasticsearch/pull/10002) (issues: [#10002](https://github.com/elastic/elasticsearch/pull/10002), [#10002](https://github.com/elastic/elasticsearch/pull/10002))
 
 Security:
-* Test changelog entry 5_0 [#5000](https://github.com/elastic/elasticsearch/pull/5000) (issue: {es-issue}5001[#5001])
-* Test changelog entry 5_1 [#5002](https://github.com/elastic/elasticsearch/pull/5002) (issues: {es-issue}5003[#5003], {es-issue}5004[#5004])
+* Test changelog entry 5_0 [#5000](https://github.com/elastic/elasticsearch/pull/5000) (issue: [#5000](https://github.com/elastic/elasticsearch/pull/5000))
+* Test changelog entry 5_1 [#5002](https://github.com/elastic/elasticsearch/pull/5002) (issues: [#5002](https://github.com/elastic/elasticsearch/pull/5002), [#5002](https://github.com/elastic/elasticsearch/pull/5002))
 
 ### Fixes [elasticsearch-820-fixes]
 
 Indices:
-* Test changelog entry 2_0 [#2000](https://github.com/elastic/elasticsearch/pull/2000) (issue: {es-issue}2001[#2001])
-* Test changelog entry 2_1 [#2002](https://github.com/elastic/elasticsearch/pull/2002) (issues: {es-issue}2003[#2003], {es-issue}2004[#2004])
+* Test changelog entry 2_0 [#2000](https://github.com/elastic/elasticsearch/pull/2000) (issue: [#2000](https://github.com/elastic/elasticsearch/pull/2000))
+* Test changelog entry 2_1 [#2002](https://github.com/elastic/elasticsearch/pull/2002) (issues: [#2002](https://github.com/elastic/elasticsearch/pull/2002), [#2002](https://github.com/elastic/elasticsearch/pull/2002))
 
 Mappings:
-* Test changelog entry 3_0 [#3000](https://github.com/elastic/elasticsearch/pull/3000) (issue: {es-issue}3001[#3001])
-* Test changelog entry 3_1 [#3002](https://github.com/elastic/elasticsearch/pull/3002) (issues: {es-issue}3003[#3003], {es-issue}3004[#3004])
+* Test changelog entry 3_0 [#3000](https://github.com/elastic/elasticsearch/pull/3000) (issue: [#3000](https://github.com/elastic/elasticsearch/pull/3000))
+* Test changelog entry 3_1 [#3002](https://github.com/elastic/elasticsearch/pull/3002) (issues: [#3002](https://github.com/elastic/elasticsearch/pull/3002), [#3002](https://github.com/elastic/elasticsearch/pull/3002))
 
 ### Regressions [elasticsearch-820-regression]
 
 Mappings:
-* Test changelog entry 9_0 [#9000](https://github.com/elastic/elasticsearch/pull/9000) (issue: {es-issue}9001[#9001])
-* Test changelog entry 9_1 [#9002](https://github.com/elastic/elasticsearch/pull/9002) (issues: {es-issue}9003[#9003], {es-issue}9004[#9004])
+* Test changelog entry 9_0 [#9000](https://github.com/elastic/elasticsearch/pull/9000) (issue: [#9000](https://github.com/elastic/elasticsearch/pull/9000))
+* Test changelog entry 9_1 [#9002](https://github.com/elastic/elasticsearch/pull/9002) (issues: [#9002](https://github.com/elastic/elasticsearch/pull/9002), [#9002](https://github.com/elastic/elasticsearch/pull/9002))
 
 

build-tools-internal/src/test/resources/org/elasticsearch/gradle/internal/release/ReleaseNotesGeneratorTest.index.no-changes.md

@@ -0,0 +1,30 @@
+---
+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-8.2.0.html
+  - https://www.elastic.co/guide/en/elasticsearch/reference/master/migrating-8.2.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 [elasticsearch-next-release-notes]
+% **Release date:** Month day, year
+
+% ### Features and enhancements [elasticsearch-next-features-enhancements]
+% *
+
+% ### Fixes [elasticsearch-next-fixes]
+% *
+
+## 8.2.0 [elasticsearch-820-release-notes]
+**Release date:** April 01, 2025
+
+

build-tools-internal/src/test/resources/org/elasticsearch/gradle/internal/release/ReleaseNotesGeneratorTest.index.no-highlights.md

@@ -0,0 +1,68 @@
+---
+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-8.2.0.html
+  - https://www.elastic.co/guide/en/elasticsearch/reference/master/migrating-8.2.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 [elasticsearch-next-release-notes]
+% **Release date:** Month day, year
+
+% ### Features and enhancements [elasticsearch-next-features-enhancements]
+% *
+
+% ### Fixes [elasticsearch-next-fixes]
+% *
+
+## 8.2.0 [elasticsearch-820-release-notes]
+**Release date:** April 01, 2025
+
+### Features and enhancements [elasticsearch-820-features-enhancements]
+
+Aggregation:
+* Test changelog entry 6_0 [#6000](https://github.com/elastic/elasticsearch/pull/6000) (issue: [#6000](https://github.com/elastic/elasticsearch/pull/6000))
+* Test changelog entry 6_1 [#6002](https://github.com/elastic/elasticsearch/pull/6002) (issues: [#6002](https://github.com/elastic/elasticsearch/pull/6002), [#6002](https://github.com/elastic/elasticsearch/pull/6002))
+
+Cluster:
+* Test changelog entry 7_0 [#7000](https://github.com/elastic/elasticsearch/pull/7000) (issue: [#7000](https://github.com/elastic/elasticsearch/pull/7000))
+* Test changelog entry 7_1 [#7002](https://github.com/elastic/elasticsearch/pull/7002) (issues: [#7002](https://github.com/elastic/elasticsearch/pull/7002), [#7002](https://github.com/elastic/elasticsearch/pull/7002))
+
+Indices:
+* Test changelog entry 8_0 [#8000](https://github.com/elastic/elasticsearch/pull/8000) (issue: [#8000](https://github.com/elastic/elasticsearch/pull/8000))
+* Test changelog entry 8_1 [#8002](https://github.com/elastic/elasticsearch/pull/8002) (issues: [#8002](https://github.com/elastic/elasticsearch/pull/8002), [#8002](https://github.com/elastic/elasticsearch/pull/8002))
+
+Search:
+* Test changelog entry 10_0 [#10000](https://github.com/elastic/elasticsearch/pull/10000) (issue: [#10000](https://github.com/elastic/elasticsearch/pull/10000))
+* Test changelog entry 10_1 [#10002](https://github.com/elastic/elasticsearch/pull/10002) (issues: [#10002](https://github.com/elastic/elasticsearch/pull/10002), [#10002](https://github.com/elastic/elasticsearch/pull/10002))
+
+Security:
+* Test changelog entry 5_0 [#5000](https://github.com/elastic/elasticsearch/pull/5000) (issue: [#5000](https://github.com/elastic/elasticsearch/pull/5000))
+* Test changelog entry 5_1 [#5002](https://github.com/elastic/elasticsearch/pull/5002) (issues: [#5002](https://github.com/elastic/elasticsearch/pull/5002), [#5002](https://github.com/elastic/elasticsearch/pull/5002))
+
+### Fixes [elasticsearch-820-fixes]
+
+Indices:
+* Test changelog entry 2_0 [#2000](https://github.com/elastic/elasticsearch/pull/2000) (issue: [#2000](https://github.com/elastic/elasticsearch/pull/2000))
+* Test changelog entry 2_1 [#2002](https://github.com/elastic/elasticsearch/pull/2002) (issues: [#2002](https://github.com/elastic/elasticsearch/pull/2002), [#2002](https://github.com/elastic/elasticsearch/pull/2002))
+
+Mappings:
+* Test changelog entry 3_0 [#3000](https://github.com/elastic/elasticsearch/pull/3000) (issue: [#3000](https://github.com/elastic/elasticsearch/pull/3000))
+* Test changelog entry 3_1 [#3002](https://github.com/elastic/elasticsearch/pull/3002) (issues: [#3002](https://github.com/elastic/elasticsearch/pull/3002), [#3002](https://github.com/elastic/elasticsearch/pull/3002))
+
+### Regressions [elasticsearch-820-regression]
+
+Mappings:
+* Test changelog entry 9_0 [#9000](https://github.com/elastic/elasticsearch/pull/9000) (issue: [#9000](https://github.com/elastic/elasticsearch/pull/9000))
+* Test changelog entry 9_1 [#9002](https://github.com/elastic/elasticsearch/pull/9002) (issues: [#9002](https://github.com/elastic/elasticsearch/pull/9002), [#9002](https://github.com/elastic/elasticsearch/pull/9002))
+
+

docs/release-notes/breaking-changes.md

@@ -15,6 +15,9 @@ To learn how to upgrade, check out <upgrade docs>.
 ## 9.1.0 [elasticsearch-910-breaking-changes]
 **Release date:** April 01, 2025
 
+Discovery-Plugins:
+* Upgrade `discovery-ec2` to AWS SDK v2 [#122062](https://github.com/elastic/elasticsearch/pull/122062)
+
 TLS:
 * Drop `TLS_RSA` cipher support for JDK 24 [#123600](https://github.com/elastic/elasticsearch/pull/123600)