Organizational changes based on direction from docs team, cleanup and simplify some stuff

Author: brianseeders

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

@@ -53,39 +53,31 @@ public class GenerateReleaseNotesTask extends DefaultTask {
 
     private final ConfigurableFileCollection changelogs;
 
-    private final RegularFileProperty releaseNotesIndexTemplate;
     private final RegularFileProperty releaseNotesTemplate;
     private final RegularFileProperty releaseHighlightsTemplate;
     private final RegularFileProperty breakingChangesTemplate;
     private final RegularFileProperty deprecationsTemplate;
-    private final RegularFileProperty migrationIndexTemplate;
 
-    private final RegularFileProperty releaseNotesIndexFile;
     private final RegularFileProperty releaseNotesFile;
     private final RegularFileProperty releaseHighlightsFile;
-    private final RegularFileProperty breakingChangesMigrationFile;
+    private final RegularFileProperty breakingChangesFile;
     private final RegularFileProperty deprecationsFile;
-    private final RegularFileProperty migrationIndexFile;
 
     private final GitWrapper gitWrapper;
 
     @Inject
     public GenerateReleaseNotesTask(ObjectFactory objectFactory, ExecOperations execOperations) {
         changelogs = objectFactory.fileCollection();
 
-        releaseNotesIndexTemplate = objectFactory.fileProperty();
         releaseNotesTemplate = objectFactory.fileProperty();
         releaseHighlightsTemplate = objectFactory.fileProperty();
         breakingChangesTemplate = objectFactory.fileProperty();
         deprecationsTemplate = objectFactory.fileProperty();
-        migrationIndexTemplate = objectFactory.fileProperty();
 
-        releaseNotesIndexFile = objectFactory.fileProperty();
         releaseNotesFile = objectFactory.fileProperty();
         releaseHighlightsFile = objectFactory.fileProperty();
-        breakingChangesMigrationFile = objectFactory.fileProperty();
+        breakingChangesFile = objectFactory.fileProperty();
         deprecationsFile = objectFactory.fileProperty();
-        migrationIndexFile = objectFactory.fileProperty();
 
         gitWrapper = new GitWrapper(execOperations);
     }
@@ -117,13 +109,6 @@ public void executeTask() throws IOException {
 
         final Set<QualifiedVersion> versions = getVersions(gitWrapper, currentVersion);
 
-        LOGGER.info("Updating release notes index...");
-        ReleaseNotesIndexGenerator.update(
-            versions,
-            this.releaseNotesIndexTemplate.get().getAsFile(),
-            this.releaseNotesIndexFile.get().getAsFile()
-        );
-
         LOGGER.info("Generating release notes...");
         final QualifiedVersion qualifiedVersion = QualifiedVersion.of(currentVersion);
         ReleaseNotesGenerator.update(
@@ -133,19 +118,12 @@ public void executeTask() throws IOException {
             changelogsByVersion.getOrDefault(qualifiedVersion, Set.of())
         );
 
-        // Only update breaking changes and migration guide for new minors
+        // Only update breaking changes and deprecations for new minors
         if (qualifiedVersion.revision() == 0) {
-            LOGGER.info("Generating release highlights...");
-            ReleaseHighlightsGenerator.update(
-                this.releaseHighlightsTemplate.get().getAsFile(),
-                this.releaseHighlightsFile.get().getAsFile(),
-                entries
-            );
-
             LOGGER.info("Generating breaking changes / deprecations notes...");
             ReleaseNotesGenerator.update(
                 this.breakingChangesTemplate.get().getAsFile(),
-                this.breakingChangesMigrationFile.get().getAsFile(),
+                this.breakingChangesFile.get().getAsFile(),
                 qualifiedVersion,
                 changelogsByVersion.getOrDefault(qualifiedVersion, Set.of())
             );
@@ -156,13 +134,6 @@ public void executeTask() throws IOException {
                 qualifiedVersion,
                 changelogsByVersion.getOrDefault(qualifiedVersion, Set.of())
             );
-
-            LOGGER.info("Updating migration/index...");
-            MigrationIndexGenerator.update(
-                getMinorVersions(versions),
-                this.migrationIndexTemplate.get().getAsFile(),
-                this.migrationIndexFile.get().getAsFile()
-            );
         }
     }
 
@@ -329,15 +300,6 @@ public void setChangelogs(FileCollection files) {
         this.changelogs.setFrom(files);
     }
 
-    @InputFile
-    public RegularFileProperty getReleaseNotesIndexTemplate() {
-        return releaseNotesIndexTemplate;
-    }
-
-    public void setReleaseNotesIndexTemplate(RegularFile file) {
-        this.releaseNotesIndexTemplate.set(file);
-    }
-
     @InputFile
     public RegularFileProperty getReleaseNotesTemplate() {
         return releaseNotesTemplate;
@@ -374,24 +336,6 @@ public void setDeprecationsTemplate(RegularFile file) {
         this.deprecationsTemplate.set(file);
     }
 
-    @InputFile
-    public RegularFileProperty getMigrationIndexTemplate() {
-        return migrationIndexTemplate;
-    }
-
-    public void setMigrationIndexTemplate(RegularFile file) {
-        this.migrationIndexTemplate.set(file);
-    }
-
-    @OutputFile
-    public RegularFileProperty getReleaseNotesIndexFile() {
-        return releaseNotesIndexFile;
-    }
-
-    public void setReleaseNotesIndexFile(RegularFile file) {
-        this.releaseNotesIndexFile.set(file);
-    }
-
     @OutputFile
     public RegularFileProperty getReleaseNotesFile() {
         return releaseNotesFile;
@@ -411,12 +355,12 @@ public void setReleaseHighlightsFile(RegularFile file) {
     }
 
     @OutputFile
-    public RegularFileProperty getBreakingChangesMigrationFile() {
-        return breakingChangesMigrationFile;
+    public RegularFileProperty getBreakingChangesFile() {
+        return breakingChangesFile;
     }
 
-    public void setBreakingChangesMigrationFile(RegularFile file) {
-        this.breakingChangesMigrationFile.set(file);
+    public void setBreakingChangesFile(RegularFile file) {
+        this.breakingChangesFile.set(file);
     }
 
     @OutputFile
@@ -427,13 +371,4 @@ public RegularFileProperty getDeprecationsFile() {
     public void setDeprecationsFile(RegularFile file) {
         this.deprecationsFile.set(file);
     }
-
-    @OutputFile
-    public RegularFileProperty getMigrationIndexFile() {
-        return migrationIndexFile;
-    }
-
-    public void setMigrationIndexFile(RegularFile file) {
-        this.migrationIndexFile.set(file);
-    }
 }

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

@@ -49,6 +49,11 @@ public class ReleaseNotesGenerator {
         TYPE_LABELS.put("upgrade", "Upgrades");
     }
 
+    /**
+     * These are the types of changes that are considered "Features and Enhancements" in the release notes.
+     */
+    private static final List<String> FEATURE_ENHANCEMENT_TYPES = List.of("feature", "new-aggregation", "enhancement", "upgrade");
+
     static void update(File templateFile, File outputFile, QualifiedVersion version, Set<ChangelogEntry> changelogs) throws IOException {
         final String templateString = Files.readString(templateFile.toPath());
 
@@ -71,12 +76,16 @@ static String generateFile(String template, QualifiedVersion version, Set<Change
         return TemplateUtils.render(template, bindings);
     }
 
+    /**
+     * The new markdown release notes are grouping several of the old change types together.
+     * This method maps the change type that developers use in the changelogs to the new type that the release notes cares about.
+     */
     private static String getTypeFromEntry(ChangelogEntry entry) {
         if (entry.getBreaking() != null) {
             return "breaking";
         }
 
-        if (entry.getType().equals("feature") || entry.getType().equals("enhancement")) {
+        if (FEATURE_ENHANCEMENT_TYPES.contains(entry.getType())) {
             return "features-enhancements";
         }
 

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

@@ -77,19 +77,14 @@ public void apply(Project project) {
                 task.setDescription("Generates stub release notes e.g. after feature freeze");
             }
 
-            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.md"));
+            task.setReleaseNotesTemplate(projectDirectory.file(RESOURCES + "templates/index.md"));
             task.setReleaseNotesFile(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.md"));
-            task.setBreakingChangesMigrationFile(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"));
+            task.setBreakingChangesFile(projectDirectory.file("docs/release-notes/breaking-changes.md"));
 
             task.setDeprecationsTemplate(projectDirectory.file(RESOURCES + "templates/deprecations.md"));
             task.setDeprecationsFile(