Merge pull request #8 from gsmet/improve-feedback

Improve action feedback
quarkusio · Nov 23, 2023 · 58bb5e0 · 58bb5e0
2 parents 8661348 + 7d8d621
commit 58bb5e0
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 26 deletions.
diff --git a/src/main/java/io/quarkus/bot/release/ReleaseAction.java b/src/main/java/io/quarkus/bot/release/ReleaseAction.java
@@ -23,9 +23,6 @@
 import io.quarkus.arc.InstanceHandle;
 import io.quarkus.bot.release.error.StatusUpdateException;
 import io.quarkus.bot.release.error.StepExecutionException;
-import io.quarkus.bot.release.step.ApproveCoreRelease;
-import io.quarkus.bot.release.step.CoreReleasePrepare;
-import io.quarkus.bot.release.step.Prerequisites;
 import io.quarkus.bot.release.step.Step;
 import io.quarkus.bot.release.step.StepHandler;
 import io.quarkus.bot.release.step.StepStatus;
@@ -43,14 +40,6 @@ public class ReleaseAction {
     @Inject
     Processes processes;
 
-    // ugly workaround...
-    @Inject
-    Prerequisites prerequisites;
-    @Inject
-    ApproveCoreRelease approveCoreRelease;
-    @Inject
-    CoreReleasePrepare coreReleasePrepare;
-
     @Action
     void startRelease(Context context, Commands commands, @Issue.Opened GHEventPayload.Issue issuePayload) throws Exception {
         GHIssue issue = issuePayload.getIssue();
@@ -160,7 +149,7 @@ private void handleSteps(Context context, Commands commands, GHIssue issue, GHIs
         }
 
         progressInformation(context, commands, releaseInformation, currentReleaseStatus, issue,
-                "Proceeding to step " + Step.values()[initialStepOrdinal]);
+                "Proceeding to step " + Step.values()[initialStepOrdinal].getDescription());
 
         for (Step currentStep : Step.values()) {
             if (currentStep.ordinal() < initialStepOrdinal) {
@@ -261,21 +250,23 @@ private static void progressInformation(Context context, Commands commands, Rele
 
     private void progressError(Context context, Commands commands, ReleaseInformation releaseInformation, ReleaseStatus releaseStatus, GHIssue issue, String error) {
         try {
-            issue.setBody(issues.appendReleaseStatus(issue.getBody(), releaseStatus.progress(StepStatus.FAILED)));
+            ReleaseStatus currentReleaseStatus = releaseStatus.progress(StepStatus.FAILED);
+            issue.setBody(issues.appendReleaseStatus(issue.getBody(), currentReleaseStatus));
             issue.comment(":rotating_light: " + error + "\n\nYou can find more information about the failure [here](" + getWorkflowRunUrl(context) + ").\n\n"
                     + "This is not a fatal error, you can retry by adding a `retry` comment."
-                    + youAreHere(releaseInformation, releaseStatus));
+                    + youAreHere(releaseInformation, currentReleaseStatus));
         } catch (IOException e) {
             throw new RuntimeException("Unable to add progress error comment or close the comment: " + error, e);
         }
     }
 
     private void fatalError(Context context, Commands commands, ReleaseInformation releaseInformation, ReleaseStatus releaseStatus, GHIssue issue, String error) {
         try {
-            issue.setBody(issues.appendReleaseStatus(issue.getBody(), releaseStatus.progress(Status.FAILED, StepStatus.FAILED)));
+            ReleaseStatus currentReleaseStatus = releaseStatus.progress(Status.FAILED, StepStatus.FAILED);
+            issue.setBody(issues.appendReleaseStatus(issue.getBody(), currentReleaseStatus));
             issue.comment(":rotating_light: " + error + "\n\nYou can find more information about the failure [here](" + getWorkflowRunUrl(context) + ").\n\n"
                     + "This is a fatal error, the issue will be closed."
-                    + youAreHere(releaseInformation, releaseStatus));
+                    + youAreHere(releaseInformation, currentReleaseStatus));
             issue.close();
         } catch (IOException e) {
             throw new RuntimeException("Unable to add fatal error comment or close the comment: " + error, e);
@@ -287,7 +278,7 @@ private static String getWorkflowRunUrl(Context context) {
     }
 
     private static String youAreHere(ReleaseInformation releaseInformation, ReleaseStatus releaseStatus) {
-        return "\n\n<details><summary>You are here</summary>\n\n- " +
+        return "\n\n<details><summary>You are here</summary>\n\n" +
                 Arrays.stream(Step.values())
                     .filter(s -> releaseInformation.isFinal() || !s.isForFinalReleasesOnly())
                     .map(s -> {
@@ -299,14 +290,15 @@ private static String youAreHere(ReleaseInformation releaseInformation, ReleaseS
                         } else {
                             sb.append(" ");
                         }
-                        sb.append("] ").append(s.name());
-                        if (releaseStatus.getCurrentStepStatus() == StepStatus.STARTED) {
-                            sb.append(" :gear:");
-                        }
-                        if (releaseStatus.getCurrentStepStatus() == StepStatus.FAILED) {
-                            sb.append(" :rotating_light:");
-                        }
+                        sb.append("] ").append(s.getDescription());
+
                         if (releaseStatus.getCurrentStep() == s) {
+                            if (releaseStatus.getCurrentStepStatus() == StepStatus.STARTED) {
+                                sb.append(" :gear:");
+                            }
+                            if (releaseStatus.getCurrentStepStatus() == StepStatus.FAILED) {
+                                sb.append(" :rotating_light:");
+                            }
                             sb.append(" ☚ You are here");
                         }
                         return sb.toString();

diff --git a/src/main/java/io/quarkus/bot/release/step/ApproveCoreRelease.java b/src/main/java/io/quarkus/bot/release/step/ApproveCoreRelease.java
@@ -7,11 +7,13 @@
 import org.kohsuke.github.GHIssue;
 import org.kohsuke.github.GHIssueComment;
 
+import io.quarkus.arc.Unremovable;
 import io.quarkus.bot.release.ReleaseInformation;
 import io.quarkus.bot.release.ReleaseStatus;
 import io.quarkus.bot.release.util.Command;
 
 @Singleton
+@Unremovable
 public class ApproveCoreRelease implements StepHandler {
 
     @Override

diff --git a/src/main/java/io/quarkus/bot/release/step/CoreReleasePrepare.java b/src/main/java/io/quarkus/bot/release/step/CoreReleasePrepare.java
@@ -6,9 +6,11 @@
 
 import org.kohsuke.github.GHIssue;
 
+import io.quarkus.arc.Unremovable;
 import io.quarkus.bot.release.ReleaseInformation;
 
 @Singleton
+@Unremovable
 public class CoreReleasePrepare implements StepHandler {
 
     @Override

diff --git a/src/main/java/io/quarkus/bot/release/step/Prerequisites.java b/src/main/java/io/quarkus/bot/release/step/Prerequisites.java
@@ -11,11 +11,13 @@
 
 import org.kohsuke.github.GHIssue;
 
+import io.quarkus.arc.Unremovable;
 import io.quarkus.bot.release.ReleaseInformation;
 import io.quarkus.bot.release.util.Issues;
 import io.quarkus.bot.release.util.Processes;
 
 @Singleton
+@Unremovable
 public class Prerequisites implements StepHandler {
 
     @Inject

diff --git a/src/test/java/io/quarkus/bot/release/StepInjectionTest.java b/src/test/java/io/quarkus/bot/release/StepInjectionTest.java
@@ -5,14 +5,16 @@
 import org.junit.jupiter.api.Test;
 
 import io.quarkus.arc.Arc;
-import io.quarkus.bot.release.step.Prerequisites;
+import io.quarkus.bot.release.step.Step;
 import io.quarkus.test.junit.QuarkusTest;
 
 @QuarkusTest
 public class StepInjectionTest {
 
     @Test
     void testStepInjection() {
-        assertThat(Arc.container().instance(Prerequisites.class).get()).isNotNull();
+        for (Step step : Step.values()) {
+            assertThat(Arc.container().instance(step.getStepHandler()).get()).isNotNull();
+        }
     }
 }