[docs] Add support for overriding entries in the release notes

Author: brianseeders

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/release/ChangelogEntry.java

@@ -43,6 +43,7 @@ public class ChangelogEntry {
     private Breaking breaking;
     private Highlight highlight;
     private Deprecation deprecation;
+    private String entryOverride;
 
     private static final ObjectMapper yamlMapper = new ObjectMapper(new YAMLFactory());
 
@@ -125,6 +126,14 @@ public void setDeprecation(Deprecation deprecation) {
         this.deprecation = deprecation;
     }
 
+    public String getEntryOverride() {
+        return entryOverride;
+    }
+
+    public void setEntryOverride(String entryOverride) {
+        this.entryOverride = entryOverride;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {
@@ -140,12 +149,13 @@ public boolean equals(Object o) {
             && Objects.equals(type, that.type)
             && Objects.equals(summary, that.summary)
             && Objects.equals(highlight, that.highlight)
-            && Objects.equals(breaking, that.breaking);
+            && Objects.equals(breaking, that.breaking)
+            && Objects.equals(entryOverride, that.entryOverride);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(pr, issues, area, type, summary, highlight, breaking);
+        return Objects.hash(pr, issues, area, type, summary, highlight, breaking, entryOverride);
     }
 
     @Override

build-tools-internal/src/main/resources/templates/breaking-changes.md

@@ -27,24 +27,30 @@ for(bundle in changelogBundles) {
     }
 %>
 ## ${unqualifiedVersion} [elasticsearch-${versionForIds}-breaking-changes]
+
 <%
     if (!changelogsByTypeByArea['breaking']) {
-        print "\nThere are no breaking changes associated with this release.\n"
+        print "There are no breaking changes associated with this release.\n"
     } else {
         for (team in (changelogsByTypeByArea['breaking'] ?: [:]).keySet()) {
-            print "\n${team}:\n";
+            print "${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 { "[#${it}](https://github.com/elastic/elasticsearch/issues/${it})" }.join(", ")
-                    print ")"
+                if (!change.entryOverride) {
+                    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 { "[#${it}](https://github.com/elastic/elasticsearch/issues/${it})" }.join(", ")
+                        print ")"
+                    }
+                } else {
+                    print change.entryOverride;
                 }
                 print "\n"
             }
+            print "\n"
         }
 
-        print "\n\n"
+        print "\n"
     }
 }

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

@@ -59,18 +59,24 @@ for (changeType in ['features-enhancements', 'fixes', 'regression']) {
     }
 %>
 ### ${ TYPE_LABELS.getOrDefault(changeType, 'No mapping for TYPE_LABELS[' + changeType + ']') } [elasticsearch-${versionForIds}-${changeType}]
+
 <% for (team in changelogsByTypeByArea[changeType].keySet()) {
-    print "\n${team}:\n";
+    print "${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 { "[#${it}](https://github.com/elastic/elasticsearch/issues/${it})" }.join(", ")
-            print ")"
+        if (!change.entryOverride) {
+            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 { "[#${it}](https://github.com/elastic/elasticsearch/issues/${it})" }.join(", ")
+                print ")"
+            }
+        } else {
+            print change.entryOverride.trim();
         }
         print "\n"
     }
+    print "\n"
 }
 }
 print "\n"

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

@@ -47,6 +47,7 @@ Search:
 *  [#52](https://github.com/elastic/elasticsearch/pull/52)
 
 
+
 ## 9.0.10 [elasticsearch-9.0.10-release-notes]
 ```{applies_to}
 stack: coming 9.0.10
@@ -59,6 +60,7 @@ Search:
 * Test changelog entry 10_1 [#10002](https://github.com/elastic/elasticsearch/pull/10002) (issues: [#10003](https://github.com/elastic/elasticsearch/issues/10003), [#10004](https://github.com/elastic/elasticsearch/issues/10004))
 
 
+
 ## 9.0.9 [elasticsearch-9.0.9-release-notes]
 
 ### Regressions [elasticsearch-9.0.9-regression]
@@ -68,6 +70,7 @@ Mappings:
 * Test changelog entry 9_1 [#9002](https://github.com/elastic/elasticsearch/pull/9002) (issues: [#9003](https://github.com/elastic/elasticsearch/issues/9003), [#9004](https://github.com/elastic/elasticsearch/issues/9004))
 
 
+
 ## 9.0.8 [elasticsearch-9.0.8-release-notes]
 
 ### Features and enhancements [elasticsearch-9.0.8-features-enhancements]
@@ -77,6 +80,7 @@ Indices:
 * Test changelog entry 8_1 [#8002](https://github.com/elastic/elasticsearch/pull/8002) (issues: [#8003](https://github.com/elastic/elasticsearch/issues/8003), [#8004](https://github.com/elastic/elasticsearch/issues/8004))
 
 
+
 ## 9.0.7 [elasticsearch-9.0.7-release-notes]
 
 ### Features and enhancements [elasticsearch-9.0.7-features-enhancements]
@@ -86,6 +90,7 @@ Cluster:
 * Test changelog entry 7_1 [#7002](https://github.com/elastic/elasticsearch/pull/7002) (issues: [#7003](https://github.com/elastic/elasticsearch/issues/7003), [#7004](https://github.com/elastic/elasticsearch/issues/7004))
 
 
+
 ## 9.0.6 [elasticsearch-9.0.6-release-notes]
 
 ### Features and enhancements [elasticsearch-9.0.6-features-enhancements]
@@ -95,6 +100,7 @@ Aggregation:
 * Test changelog entry 6_1 [#6002](https://github.com/elastic/elasticsearch/pull/6002) (issues: [#6003](https://github.com/elastic/elasticsearch/issues/6003), [#6004](https://github.com/elastic/elasticsearch/issues/6004))
 
 
+
 ## 9.0.5 [elasticsearch-9.0.5-release-notes]
 
 ### Features and enhancements [elasticsearch-9.0.5-features-enhancements]
@@ -104,6 +110,7 @@ Security:
 * Test changelog entry 5_1 [#5002](https://github.com/elastic/elasticsearch/pull/5002) (issues: [#5003](https://github.com/elastic/elasticsearch/issues/5003), [#5004](https://github.com/elastic/elasticsearch/issues/5004))
 
 
+
 ## 9.0.4 [elasticsearch-9.0.4-release-notes]
 
 
@@ -116,6 +123,7 @@ Mappings:
 * Test changelog entry 3_1 [#3002](https://github.com/elastic/elasticsearch/pull/3002) (issues: [#3003](https://github.com/elastic/elasticsearch/issues/3003), [#3004](https://github.com/elastic/elasticsearch/issues/3004))
 
 
+
 ## 9.0.2 [elasticsearch-9.0.2-release-notes]
 
 ### Fixes [elasticsearch-9.0.2-fixes]
@@ -125,6 +133,7 @@ Indices:
 * Test changelog entry 2_1 [#2002](https://github.com/elastic/elasticsearch/pull/2002) (issues: [#2003](https://github.com/elastic/elasticsearch/issues/2003), [#2004](https://github.com/elastic/elasticsearch/issues/2004))
 
 
+
 ## 9.0.1 [elasticsearch-9.0.1-release-notes]
 
 

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

@@ -32,6 +32,7 @@ Search:
 * Test changelog entry 10_1 [#10002](https://github.com/elastic/elasticsearch/pull/10002) (issues: [#10003](https://github.com/elastic/elasticsearch/issues/10003), [#10004](https://github.com/elastic/elasticsearch/issues/10004))
 
 
+
 ## 9.0.9 [elasticsearch-9.0.9-release-notes]
 
 ### Regressions [elasticsearch-9.0.9-regression]
@@ -41,6 +42,7 @@ Mappings:
 * Test changelog entry 9_1 [#9002](https://github.com/elastic/elasticsearch/pull/9002) (issues: [#9003](https://github.com/elastic/elasticsearch/issues/9003), [#9004](https://github.com/elastic/elasticsearch/issues/9004))
 
 
+
 ## 9.0.8 [elasticsearch-9.0.8-release-notes]
 
 ### Features and enhancements [elasticsearch-9.0.8-features-enhancements]
@@ -50,6 +52,7 @@ Indices:
 * Test changelog entry 8_1 [#8002](https://github.com/elastic/elasticsearch/pull/8002) (issues: [#8003](https://github.com/elastic/elasticsearch/issues/8003), [#8004](https://github.com/elastic/elasticsearch/issues/8004))
 
 
+
 ## 9.0.7 [elasticsearch-9.0.7-release-notes]
 
 ### Features and enhancements [elasticsearch-9.0.7-features-enhancements]
@@ -59,6 +62,7 @@ Cluster:
 * Test changelog entry 7_1 [#7002](https://github.com/elastic/elasticsearch/pull/7002) (issues: [#7003](https://github.com/elastic/elasticsearch/issues/7003), [#7004](https://github.com/elastic/elasticsearch/issues/7004))
 
 
+
 ## 9.0.6 [elasticsearch-9.0.6-release-notes]
 
 ### Features and enhancements [elasticsearch-9.0.6-features-enhancements]
@@ -68,6 +72,7 @@ Aggregation:
 * Test changelog entry 6_1 [#6002](https://github.com/elastic/elasticsearch/pull/6002) (issues: [#6003](https://github.com/elastic/elasticsearch/issues/6003), [#6004](https://github.com/elastic/elasticsearch/issues/6004))
 
 
+
 ## 9.0.5 [elasticsearch-9.0.5-release-notes]
 
 ### Features and enhancements [elasticsearch-9.0.5-features-enhancements]
@@ -77,6 +82,7 @@ Security:
 * Test changelog entry 5_1 [#5002](https://github.com/elastic/elasticsearch/pull/5002) (issues: [#5003](https://github.com/elastic/elasticsearch/issues/5003), [#5004](https://github.com/elastic/elasticsearch/issues/5004))
 
 
+
 ## 9.0.4 [elasticsearch-9.0.4-release-notes]
 
 
@@ -89,6 +95,7 @@ Mappings:
 * Test changelog entry 3_1 [#3002](https://github.com/elastic/elasticsearch/pull/3002) (issues: [#3003](https://github.com/elastic/elasticsearch/issues/3003), [#3004](https://github.com/elastic/elasticsearch/issues/3004))
 
 
+
 ## 9.0.2 [elasticsearch-9.0.2-release-notes]
 
 ### Fixes [elasticsearch-9.0.2-fixes]
@@ -98,6 +105,7 @@ Indices:
 * Test changelog entry 2_1 [#2002](https://github.com/elastic/elasticsearch/pull/2002) (issues: [#2003](https://github.com/elastic/elasticsearch/issues/2003), [#2004](https://github.com/elastic/elasticsearch/issues/2004))
 
 
+
 ## 9.0.1 [elasticsearch-9.0.1-release-notes]