Doesn't leave an empty dependency upgrade section

marcingrzejszczak · marcingrzejszczak · commit b5c59946aeb0 · 2025-02-17T14:24:55.000+01:00
diff --git a/src/main/java/io/micrometer/release/single/ChangelogProcessor.java b/src/main/java/io/micrometer/release/single/ChangelogProcessor.java
@@ -68,20 +68,19 @@ File processChangelog(File changelog, File oldChangelog) throws Exception {
         depsSection.clear();
         processedDeps.forEach(depsSection::addEntry);
 
-        // Write the result
         try (BufferedWriter writer = Files.newBufferedWriter(outputFile.toPath())) {
-            // Write header
+
             for (String line : currentChangelog.getHeader()) {
                 writer.write(line + "\n");
             }
 
-            // Write sections
             for (ChangelogSection section : currentChangelog.getSections()) {
-                writer.write("## " + section.getTitle() + "\n\n");
-
                 List<String> sortedEntries = new ArrayList<>(section.getEntries());
+                if (sortedEntries.isEmpty()) {
+                    continue;
+                }
                 Collections.sort(sortedEntries);
-
+                writer.write("## " + section.getTitle() + "\n\n");
                 for (String entry : sortedEntries) {
                     writer.write(entry + "\n");
                 }
diff --git a/src/main/java/io/micrometer/release/single/MilestoneIssueReassigner.java b/src/main/java/io/micrometer/release/single/MilestoneIssueReassigner.java
@@ -63,7 +63,7 @@ private MilestoneWithDeadline createMilestone(String version) {
 
         // Using 17:00 UTC for consistency
         List<String> lines = processRunner.run("gh", "api", "/repos/" + ghRepo + "/milestones", "-X", "POST", "-f",
-                "title=" + version, "-f", "due_on=" + dueDate.toString() + "T17:00:00Z");
+                "title=" + version, "-f", "due_on=" + dueDate + "T17:00:00Z");
 
         if (lines.isEmpty()) {
             throw new IllegalStateException("Could not create milestone " + version);
diff --git a/src/test/java/io/micrometer/release/common/GithubActions.java b/src/test/java/io/micrometer/release/common/GithubActions.java
@@ -15,24 +15,23 @@
  */
 package io.micrometer.release.common;
 
-import static org.assertj.core.api.Assertions.assertThat;
-
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import io.micrometer.release.JavaHomeFinder;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Tag;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.time.LocalDate;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 
-import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Tag;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import static org.assertj.core.api.Assertions.assertThat;
 
 @Tag("e2e")
 public interface GithubActions {
@@ -49,8 +48,8 @@ public interface GithubActions {
     static void resetsMilestones() throws InterruptedException {
         assertThat(System.getenv("GH_TOKEN")).as("GH_TOKEN env var must be set!").isNotBlank();
         log.info(
-                "This test requires GH connection and will operate on [{}] repository. It's quite slow because it runs GH actions so please be patient...",
-                REPO);
+            "This test requires GH connection and will operate on [{}] repository. It's quite slow because it runs GH actions so please be patient...",
+            REPO);
         resetMilestones();
     }
 
@@ -65,8 +64,7 @@ static void runWorkflow(String workflowName, List<String> commands) {
         processRunner.run(commands);
         try {
             waitForWorkflowCompletion(workflowName);
-        }
-        catch (InterruptedException e) {
+        } catch (InterruptedException e) {
             throw new IllegalStateException(e);
         }
     }
@@ -79,16 +77,19 @@ private static void waitForWorkflowCompletion(String workflowFile) throws Interr
         int maxAttempts = 30;
         int attempts = 0;
         while (!completed && attempts < maxAttempts) { // 5 minute timeout
-            List<String> status = processRunner.run("gh", "run", "list", "--workflow", workflowFile, "--limit", "1");
-            log.info("Workflow [{}] not completed yet - attempt [{}]/[{}]", workflowFile, attempts + 1, maxAttempts);
+            List<String> status = processRunner.run("gh", "run", "list", "--workflow", workflowFile,
+                "--limit", "1");
+            log.info("Workflow [{}] not completed yet - attempt [{}]/[{}]", workflowFile,
+                attempts + 1, maxAttempts);
             completed = status.stream().anyMatch(line -> line.contains("completed"));
             if (!completed) {
                 Thread.sleep(10_000);
                 attempts++;
             }
         }
         if (!completed) {
-            throw new RuntimeException("Workflow " + workflowFile + " did not complete within timeout");
+            throw new RuntimeException(
+                "Workflow " + workflowFile + " did not complete within timeout");
         }
         log.info("Workflow [{}] completed successfully!", workflowFile);
     }
@@ -116,46 +117,54 @@ class GithubClient {
         GithubClient(String token, String repo) {
             this.repo = repo;
             this.processRunner = new ProcessRunner(repo).withEnvVars(
-                    Map.of("JAVA_HOME", JavaHomeFinder.findJavaHomePath(), "GH_TOKEN", token != null ? token : ""));
+                Map.of("JAVA_HOME", JavaHomeFinder.findJavaHomePath(), "GH_TOKEN",
+                    token != null ? token : ""));
             this.objectMapper = new ObjectMapper().registerModule(new JavaTimeModule())
                 .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
         }
 
         public Release getRelease(String tag) throws JsonProcessingException {
-            List<String> output = processRunner.run("gh", "api", "/repos/" + repo + "/releases/tags/" + tag);
-            return parseReleaseFromJson(output.get(0));
+            String output = String.join("\n",
+                processRunner.run("gh", "api", "/repos/" + repo + "/releases/tags/" + tag));
+            return parseReleaseFromJson(output);
         }
 
         public Milestone getMilestoneByTitle(String title) throws JsonProcessingException {
-            List<String> output = processRunner.run("gh", "api", "/repos/" + repo + "/milestones");
-            return parseMilestoneFromJson(output.get(0), title);
+            String output = String.join("\n",
+                processRunner.run("gh", "api", "/repos/" + repo + "/milestones"));
+            return parseMilestoneFromJson(output, title);
         }
 
-        public List<Issue> getIssuesForMilestone(int milestoneNumber) throws JsonProcessingException {
-            List<String> output = processRunner.run("gh", "api",
-                    "/repos/" + repo + "/issues?milestone=" + milestoneNumber);
-            return parseIssuesFromJson(output.get(0));
+        public List<Issue> getIssuesForMilestone(int milestoneNumber)
+            throws JsonProcessingException {
+            String output = String.join("\n", processRunner.run("gh", "api",
+                "/repos/" + repo + "/issues?milestone=" + milestoneNumber));
+            return parseIssuesFromJson(output);
         }
 
-        public List<Issue> getClosedIssuesForMilestone(int milestoneNumber) throws JsonProcessingException {
-            List<String> output = processRunner.run("gh", "api",
-                    "/repos/" + repo + "/issues?milestone=" + milestoneNumber + "&state=closed");
-            return parseIssuesFromJson(output.get(0));
+        public List<Issue> getClosedIssuesForMilestone(int milestoneNumber)
+            throws JsonProcessingException {
+            String output = String.join("\n", processRunner.run("gh", "api",
+                "/repos/" + repo + "/issues?milestone=" + milestoneNumber + "&state=closed"));
+            return parseIssuesFromJson(output);
         }
 
         private Release parseReleaseFromJson(String json) throws JsonProcessingException {
             JsonNode root = objectMapper.readTree(json);
             return new Release(root.get("body").asText());
         }
 
-        private Milestone parseMilestoneFromJson(String json, String title) throws JsonProcessingException {
+        private Milestone parseMilestoneFromJson(String json, String title)
+            throws JsonProcessingException {
             JsonNode root = objectMapper.readTree(json);
             for (JsonNode milestone : root) {
                 if (milestone.get("title").asText().equals(title)) {
-                    return new Milestone(milestone.get("number").asInt(), milestone.get("state").asText(),
-                            milestone.get("title").asText(),
-                            milestone.get("due_on") != null && !milestone.get("due_on").isNull()
-                                    ? LocalDate.parse(milestone.get("due_on").asText().substring(0, 10)) : null);
+                    return new Milestone(milestone.get("number").asInt(),
+                        milestone.get("state").asText(),
+                        milestone.get("title").asText(),
+                        milestone.get("due_on") != null && !milestone.get("due_on").isNull()
+                            ? LocalDate.parse(milestone.get("due_on").asText().substring(0, 10))
+                            : null);
                 }
             }
             throw new RuntimeException("Milestone with title " + title + " not found");
@@ -166,7 +175,7 @@ private List<Issue> parseIssuesFromJson(String json) throws JsonProcessingExcept
             List<Issue> issues = new ArrayList<>();
             for (JsonNode issue : root) {
                 issues.add(new Issue(issue.get("number").asInt(), issue.get("state").asText(),
-                        issue.get("title").asText()));
+                    issue.get("title").asText()));
             }
             return issues;
         }
diff --git a/src/test/java/io/micrometer/release/single/ChangelogProcessorTests.java b/src/test/java/io/micrometer/release/single/ChangelogProcessorTests.java
@@ -62,10 +62,6 @@ class ChangelogProcessorTests {
 
     ChangelogProcessor processor = testChangelogProcessor(output);
 
-    static ChangelogProcessor testChangelogProcessor() {
-        return testChangelogProcessor(new File(ChangelogProcessor.OUTPUT_FILE));
-    }
-
     static ChangelogProcessor testChangelogProcessor(File output) {
         return new ChangelogProcessor(new ProcessRunner(), output) {
             @Override
diff --git a/src/test/java/io/micrometer/release/train/TrainGithubActionsE2eTests.java b/src/test/java/io/micrometer/release/train/TrainGithubActionsE2eTests.java
@@ -37,12 +37,63 @@ static void should_go_through_whole_flow() {
     }
 
     @Test
-    void should_verify_release_notes_content() throws JsonProcessingException {
+    void should_verify_release_notes_content_for_ga() throws JsonProcessingException {
         Release release = githubClient.getRelease("v0.1.1");
 
-        assertThat(release.body()).isEqualToIgnoringWhitespace("""
-                TODO
-                """);
+        assertThat(release.body()).isEqualToIgnoringWhitespace(
+                """
+                        ## :star: New Features
+
+                        - Closed enhancement in generic 0.1.x [#8](https://github.com/marcingrzejszczak/gh-actions-test/issues/8)
+
+                        ## :lady_beetle: Bug Fixes
+
+                        - Closed bug in concrete 0.1.1 [#12](https://github.com/marcingrzejszczak/gh-actions-test/issues/12)
+                        - Closed bug in generic 0.1.x [#9](https://github.com/marcingrzejszczak/gh-actions-test/issues/9)
+                        """);
+    }
+
+    @Test
+    void should_verify_release_notes_content_for_M2() throws JsonProcessingException {
+        Release release = githubClient.getRelease("v0.2.0-M2");
+
+        assertThat(release.body()).isEqualToIgnoringWhitespace(
+                """
+                        ## :star: New Features
+
+                        - Closed enhancement in generic 0.1.x [#8](https://github.com/marcingrzejszczak/gh-actions-test/issues/8)
+                        - Closed enhancement in generic 0.2.x [#14](https://github.com/marcingrzejszczak/gh-actions-test/issues/14)
+
+                        ## :lady_beetle: Bug Fixes
+
+                        - Closed bug in concrete 0.1.1 [#12](https://github.com/marcingrzejszczak/gh-actions-test/issues/12)
+                        - Closed bug in concrete 0.2.0-M2 [#18](https://github.com/marcingrzejszczak/gh-actions-test/issues/18)
+                        - Closed bug in generic 0.1.x [#9](https://github.com/marcingrzejszczak/gh-actions-test/issues/9)
+                        - Closed bug in generic 0.2.x [#15](https://github.com/marcingrzejszczak/gh-actions-test/issues/15)
+                        """);
+    }
+
+    @Test
+    void should_verify_release_notes_content_for_RC1() throws JsonProcessingException {
+        Release release = githubClient.getRelease("v1.0.0-RC1");
+
+        assertThat(release.body()).isEqualToIgnoringWhitespace(
+                """
+                        ## :star: New Features
+
+                        - Closed enhancement in generic 0.1.x [#8](https://github.com/marcingrzejszczak/gh-actions-test/issues/8)
+                        - Closed enhancement in generic 0.2.x [#14](https://github.com/marcingrzejszczak/gh-actions-test/issues/14)
+                        - Closed enhancement in generic 1.0.x [#5](https://github.com/marcingrzejszczak/gh-actions-test/issues/5)
+
+                        ## :lady_beetle: Bug Fixes
+
+                        - Closed bug in concrete 0.1.1 [#12](https://github.com/marcingrzejszczak/gh-actions-test/issues/12)
+                        - Closed bug in concrete 0.2.0-M2 [#18](https://github.com/marcingrzejszczak/gh-actions-test/issues/18)
+                        - Closed bug in concrete 1.0.0-RC1 [#3](https://github.com/marcingrzejszczak/gh-actions-test/issues/3)
+                        - Closed bug in generic 0.1.x [#9](https://github.com/marcingrzejszczak/gh-actions-test/issues/9)
+                        - Closed bug in generic 0.2.x [#15](https://github.com/marcingrzejszczak/gh-actions-test/issues/15)
+                        - Closed bug in generic 1.0.x [#4](https://github.com/marcingrzejszczak/gh-actions-test/issues/4)
+                        """);
     }
 
     @ParameterizedTest
