Cleanup and comments

Author: brianseeders

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

@@ -103,6 +103,20 @@ public BundleChangelogsTask(ObjectFactory objectFactory, ExecOperations execOper
         gitWrapper = new GitWrapper(execOperations);
     }
 
+    /*
+        Given a branch, and possibly a build candidate commit sha
+        Check out the changelog yaml files from the branch/BC sha
+        Then, bundle them all up into one file and write it to disk, along with a timestamp and whether the release is considered released
+
+         When using a branch without a BC sha:
+            - Check out the changelog yaml files from the HEAD of the branch
+
+         When using a BC sha:
+            - Check out the changelog yaml files from the BC commit
+            - Update those files with any updates from the HEAD of the branch (in case the changelogs get modified later)
+            - Check for any changelog yaml files that were added AFTER the BC,
+              but whose PR was merged before the BC (in case someone adds a forgotten changelog after the fact)
+    */
     @TaskAction
     public void executeTask() throws IOException {
         if (branch == null) {
@@ -145,7 +159,7 @@ public void executeTask() throws IOException {
                     return true;
                 }
 
-                // If the changelog was present in the BC sha, use it
+                // If the changelog was present in the BC sha, always use it
                 if (finalEntriesFromBc.contains(f.getName())) {
                     return true;
                 }

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

@@ -13,7 +13,6 @@
 
 import org.elasticsearch.gradle.VersionProperties;
 import org.gradle.api.DefaultTask;
-import org.gradle.api.GradleException;
 import org.gradle.api.file.Directory;
 import org.gradle.api.file.DirectoryProperty;
 import org.gradle.api.file.RegularFile;
@@ -32,7 +31,6 @@
 import java.util.Comparator;
 import java.util.HashSet;
 import java.util.List;
-import java.util.Map;
 
 import javax.inject.Inject;
 
@@ -82,7 +80,6 @@ public void executeTask() throws IOException {
         }
 
         LOGGER.info("Finding changelog bundles...");
-
         List<ChangelogBundle> allBundles = this.changelogBundleDirectory.getAsFileTree()
             .getFiles()
             .stream()
@@ -126,18 +123,7 @@ static List<ChangelogBundle> getSortedBundlesWithUniqueChangelogs(List<Changelog
      */
     private static void findAndUpdateUpstreamRemote(GitWrapper gitWrapper) {
         LOGGER.info("Finding upstream git remote");
-        // We need to ensure the tags are up-to-date. Find the correct remote to use
-        String upstream = gitWrapper.listRemotes()
-            .entrySet()
-            .stream()
-            .filter(entry -> entry.getValue().contains("elastic/elasticsearch"))
-            .findFirst()
-            .map(Map.Entry::getKey)
-            .orElseThrow(
-                () -> new GradleException(
-                    "I need to ensure the git tags are up-to-date, but I couldn't find a git remote for [elastic/elasticsearch]"
-                )
-            );
+        String upstream = gitWrapper.getUpstream();
 
         LOGGER.info("Updating remote [{}]", upstream);
         // Now update the remote, and make sure we update the tags too

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

@@ -109,25 +109,8 @@ static String generateFile(String template, List<ChangelogBundle> bundles) throw
             bundlesWrapped.add(wrapped);
         }
 
-        // final var changelogsByTypeByArea = buildChangelogBreakdown(changelogs);
-        //
-        // final Map<Boolean, List<ChangelogEntry.Highlight>> groupedHighlights = changelogs.stream()
-        // .map(ChangelogEntry::getHighlight)
-        // .filter(Objects::nonNull)
-        // .sorted(comparingInt(ChangelogEntry.Highlight::getPr))
-        // .collect(groupingBy(ChangelogEntry.Highlight::isNotable, toList()));
-        //
-        // final List<ChangelogEntry.Highlight> notableHighlights = groupedHighlights.getOrDefault(true, List.of());
-        // final List<ChangelogEntry.Highlight> nonNotableHighlights = groupedHighlights.getOrDefault(false, List.of());
-
         final Map<String, Object> bindings = new HashMap<>();
-        // 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("\\.", ""));
-        // bindings.put("notableHighlights", notableHighlights);
-        // bindings.put("nonNotableHighlights", nonNotableHighlights);
         bindings.put("changelogBundles", bundlesWrapped);
 
         return TemplateUtils.render(template, bindings);