Added option of running a release train for a single project

Author: marcingrzejszczak

build.gradle

@@ -44,18 +44,17 @@ println "I'm configuring $project.name with version $project.version"
 dependencies {
     checkstyle libs.javaFormatForPlugins
 
-    // Use JUnit Jupiter for testing.
     implementation libs.slf4j
     implementation libs.logback
+    implementation libs.jacksonDatabind
 
     testImplementation 'org.junit.jupiter:junit-jupiter'
     testImplementation libs.assertj
+    testImplementation libs.archunit
     testImplementation libs.mockitoCore
-    testImplementation libs.jacksonDatabind
     testImplementation libs.jacksonDatatype
     testImplementation libs.wiremock
 
-
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 
     // PIT JUnit 5 plugin
@@ -76,7 +75,6 @@ application {
 }
 
 tasks.named('test') {
-    // Use JUnit Platform for unit tests.
     useJUnitPlatform()
 }
 

gradle/libs.versions.toml

@@ -1,5 +1,6 @@
 [versions]
 assertj = "3.27.3"
+archunit = "1.4.0"
 jackson = "2.18.2"
 javaFormatForPlugins = "0.0.43"
 junit = "5.11.4"
@@ -12,6 +13,7 @@ wiremock = "3.12.0"
 
 [libraries]
 assertj = { module = "org.assertj:assertj-core", version.ref = "assertj" }
+archunit = { module = "com.tngtech.archunit:archunit-junit5", version.ref = "archunit" }
 jacksonDatabind = { module = "com.fasterxml.jackson.core:jackson-databind", version.ref = "jackson" }
 jacksonDatatype = { module = "com.fasterxml.jackson.datatype:jackson-datatype-jsr310", version.ref = "jackson" }
 javaFormatForPlugins = { module = "io.spring.javaformat:spring-javaformat-checkstyle", version.ref = "javaFormatForPlugins" }

src/main/java/io/micrometer/release/Main.java

@@ -15,10 +15,20 @@
  */
 package io.micrometer.release;
 
+import io.micrometer.release.common.ProcessRunner;
+import io.micrometer.release.single.*;
+import io.micrometer.release.train.ProjectTrainReleaseWorkflow;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 public class Main {
 
+    private static final Logger log = LoggerFactory.getLogger(Main.class);
+
     public static void main(String[] args) throws Exception {
         // Env Vars
+
+        // Single Project Post Release
         // GH_TOKEN
         // CHANGELOG_GENERATOR_VERSION
         // GITHUB_REPOSITORY
@@ -27,14 +37,71 @@ public static void main(String[] args) throws Exception {
         // BSKY_IDENTIFIER
         // BSKY_HANDLE
         // SPRING_RELEASE_GCHAT_WEBHOOK_URL
-        newWorkflow().run();
+
+        // Train Project Post Release
+        // TRAIN_VERSIONS
+        Main main = new Main();
+        main.run();
     }
 
-    private static PostReleaseWorkflow newWorkflow() {
+    void run() {
         ProcessRunner processRunner = new ProcessRunner();
-        return new PostReleaseWorkflow(new ChangelogGeneratorDownloader(), new ChangelogGenerator(processRunner),
-                new ChangelogFetcher(processRunner), new ChangelogProcessor(processRunner),
-                new ReleaseNotesUpdater(processRunner), new MilestoneUpdater(processRunner), new NotificationSender());
+        PostReleaseWorkflow postReleaseWorkflow = newPostReleaseWorkflow(processRunner);
+        String githubOrgRepo = getGithubRepository();
+        String githubRefName = getGithubRefName();
+        String previousRefName = getPreviousRefName();
+        String trainVersions = getTrainVersions();
+        String artifactToCheck = System.getenv("ARTIFACT_TO_CHECK");
+
+        log.info("""
+                !!!
+
+                @@@ MICROMETER RELEASE @@@
+
+                Processing following env variables:
+
+                GITHUB_REPOSITORY [%s]
+                GITHUB_REF_NAME [%s]
+                PREVIOUS_REF_NAME [%s]
+                TRAIN_VERSIONS [%s]
+                ARTIFACT_TO_CHECK [%s]
+
+                !!!
+                """.formatted(githubOrgRepo, githubRefName, previousRefName, trainVersions, artifactToCheck));
+
+        if (trainVersions != null && !trainVersions.isBlank()) {
+            log.info("Will proceed with train release...");
+            trainReleaseWorkflow(githubOrgRepo, artifactToCheck, postReleaseWorkflow, processRunner).run(trainVersions);
+        }
+        else {
+            log.info("Will proceed with single project post release workflow...");
+            postReleaseWorkflow.run(githubOrgRepo, githubRefName, previousRefName);
+        }
+    }
+
+    String getGithubRepository() {
+        return System.getenv("GITHUB_REPOSITORY");
+    }
+
+    String getPreviousRefName() {
+        return System.getenv("PREVIOUS_REF_NAME");
+    }
+
+    String getGithubRefName() {
+        return System.getenv("GITHUB_REF_NAME");
+    }
+
+    String getTrainVersions() {
+        return System.getenv("TRAIN_VERSIONS");
+    }
+
+    ProjectTrainReleaseWorkflow trainReleaseWorkflow(String githubOrgRepo, String artifactToCheck,
+            PostReleaseWorkflow postReleaseWorkflow, ProcessRunner processRunner) {
+        return new ProjectTrainReleaseWorkflow(githubOrgRepo, artifactToCheck, processRunner, postReleaseWorkflow);
+    }
+
+    PostReleaseWorkflow newPostReleaseWorkflow(ProcessRunner processRunner) {
+        return new PostReleaseWorkflow(processRunner);
     }
 
 }

src/main/java/io/micrometer/release/ProcessRunner.java src/main/java/io/micrometer/release/common/ProcessRunner.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.common;
 
 import java.io.File;
 
@@ -25,7 +25,7 @@
 import java.io.InputStreamReader;
 import java.util.*;
 
-class ProcessRunner {
+public class ProcessRunner {
 
     private static final Logger log = LoggerFactory.getLogger(ProcessRunner.class);
 
@@ -35,24 +35,24 @@ class ProcessRunner {
 
     private final Map<String, String> envVars = new HashMap<>();
 
-    ProcessRunner() {
+    public ProcessRunner() {
         this.repo = null;
     }
 
-    ProcessRunner(String repo) {
+    public ProcessRunner(String repo) {
         this.repo = repo;
     }
 
-    ProcessRunner withEnvVars(Map<String, String> envVars) {
+    public ProcessRunner withEnvVars(Map<String, String> envVars) {
         this.envVars.putAll(envVars);
         return this;
     }
 
-    List<String> run(List<String> command) {
+    public List<String> run(List<String> command) {
         return run(command.toArray(new String[0]));
     }
 
-    List<String> run(String... command) {
+    public List<String> run(String... command) {
         List<String> lines = new ArrayList<>();
         String[] processedCommand = processCommand(command);
         try {
@@ -108,7 +108,7 @@ List<String> run(String... command) {
         return lines;
     }
 
-    Process startProcess(String[] processedCommand) throws IOException, InterruptedException {
+    Process startProcess(String... processedCommand) throws IOException, InterruptedException {
         if (isGradleCommand(processedCommand)) {
             runGitConfig();
         }

src/main/java/io/micrometer/release/Changelog.java src/main/java/io/micrometer/release/single/Changelog.java

@@ -13,9 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
 
-import io.micrometer.release.ChangelogSection.Section;
+import io.micrometer.release.single.ChangelogSection.Section;
 
 import java.io.File;
 import java.io.IOException;

src/main/java/io/micrometer/release/ChangelogFetcher.java src/main/java/io/micrometer/release/single/ChangelogFetcher.java

@@ -13,8 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
 
+import io.micrometer.release.common.ProcessRunner;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

src/main/java/io/micrometer/release/ChangelogGenerator.java src/main/java/io/micrometer/release/single/ChangelogGenerator.java

@@ -13,7 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
+
+import io.micrometer.release.common.ProcessRunner;
 
 import java.io.File;
 

src/main/java/io/micrometer/release/ChangelogGeneratorDownloader.java src/main/java/io/micrometer/release/single/ChangelogGeneratorDownloader.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
 
 import java.io.File;
 import java.net.URI;

src/main/java/io/micrometer/release/ChangelogProcessor.java src/main/java/io/micrometer/release/single/ChangelogProcessor.java

@@ -13,9 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
 
-import io.micrometer.release.ChangelogSection.Section;
+import io.micrometer.release.common.ProcessRunner;
+import io.micrometer.release.single.ChangelogSection.Section;
 
 import java.io.*;
 import java.nio.file.Files;

src/main/java/io/micrometer/release/ChangelogSection.java src/main/java/io/micrometer/release/single/ChangelogSection.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
 
 import java.util.*;
 import java.util.regex.Matcher;

src/main/java/io/micrometer/release/MilestoneIssueReassigner.java src/main/java/io/micrometer/release/single/MilestoneIssueReassigner.java

@@ -13,9 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
 
-import io.micrometer.release.MilestoneMigrator.Milestone;
+import io.micrometer.release.common.ProcessRunner;
+import io.micrometer.release.single.MilestoneMigrator.Milestone;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

src/main/java/io/micrometer/release/MilestoneMigrator.java src/main/java/io/micrometer/release/single/MilestoneMigrator.java

@@ -13,7 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
+
+import io.micrometer.release.common.ProcessRunner;
 
 import java.util.ArrayList;
 import java.util.List;

src/main/java/io/micrometer/release/MilestoneUpdater.java src/main/java/io/micrometer/release/single/MilestoneUpdater.java

@@ -13,8 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
 
+import io.micrometer.release.common.ProcessRunner;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

src/main/java/io/micrometer/release/MilestoneWithDeadline.java src/main/java/io/micrometer/release/single/MilestoneWithDeadline.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
 
 import java.time.LocalDate;
 

src/main/java/io/micrometer/release/NotificationSender.java src/main/java/io/micrometer/release/single/NotificationSender.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

src/main/java/io/micrometer/release/PostReleaseWorkflow.java src/main/java/io/micrometer/release/single/PostReleaseWorkflow.java

@@ -13,11 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.release;
+package io.micrometer.release.single;
+
+import io.micrometer.release.common.ProcessRunner;
 
 import java.io.File;
 
-class PostReleaseWorkflow {
+public class PostReleaseWorkflow {
 
     private final ChangelogGeneratorDownloader changelogGeneratorDownloader;
 
@@ -46,12 +48,17 @@ class PostReleaseWorkflow {
         this.notificationSender = notificationSender;
     }
 
-    public void run() throws Exception {
-        String githubOrgRepo = ghOrgRepo(); // micrometer-metrics/tracing
-        String githubRefName = ghRef(); // v1.3.1
-        String previousRefName = previousRefName(); // v1.2.5
-        assertInputs(githubOrgRepo, githubRefName, previousRefName);
+    public PostReleaseWorkflow(ProcessRunner processRunner) {
+        this(new ChangelogGeneratorDownloader(), new ChangelogGenerator(processRunner),
+                new ChangelogFetcher(processRunner), new ChangelogProcessor(processRunner),
+                new ReleaseNotesUpdater(processRunner), new MilestoneUpdater(processRunner), new NotificationSender());
+    }
 
+    // micrometer-metrics/tracing
+    // v1.3.1
+    // v1.2.5 (optional)
+    public void run(String githubOrgRepo, String githubRefName, String previousRefName) {
+        assertInputs(githubOrgRepo, githubRefName, previousRefName);
         String githubRepo = githubOrgRepo.contains("/") ? githubOrgRepo.split("/")[1] : githubOrgRepo;
 
         // Step 1: Close milestone and move issues around
@@ -95,20 +102,13 @@ void assertInputs(String githubOrgRepo, String githubRefName, String previousRef
         }
     }
 
-    String ghRef() {
-        return System.getenv("GITHUB_REF_NAME");
-    }
-
-    String ghOrgRepo() {
-        return System.getenv("GITHUB_REPOSITORY");
-    }
-
-    String previousRefName() {
-        return System.getenv("PREVIOUS_REF_NAME");
-    }
-
-    private File downloadChangelogGenerator() throws Exception {
-        return changelogGeneratorDownloader.downloadChangelogGenerator();
+    private File downloadChangelogGenerator() {
+        try {
+            return changelogGeneratorDownloader.downloadChangelogGenerator();
+        }
+        catch (Exception e) {
+            throw new IllegalStateException(e);
+        }
     }
 
     private File generateOldChangelog(String githubRefName, String githubOrgRepo) {
@@ -119,8 +119,13 @@ private File generateChangelog(String githubRefName, String githubOrgRepo, File
         return changelogGenerator.generateChangelog(githubRefName, githubOrgRepo, jarPath);
     }
 
-    private File processChangelog(File changelog, File oldChangelog) throws Exception {
-        return changelogProcessor.processChangelog(changelog, oldChangelog);
+    private File processChangelog(File changelog, File oldChangelog) {
+        try {
+            return changelogProcessor.processChangelog(changelog, oldChangelog);
+        }
+        catch (Exception e) {
+            throw new IllegalStateException(e);
+        }
     }
 
     private void updateReleaseNotes(String refName, File changelog) {