Merge pull request #199 from gsmet/small-improvements

Use Markdown admonitions in reports
quarkusio · Jul 10, 2024 · b11c10b · b11c10b
2 parents 8a262f9 + 0aa2103
commit b11c10b
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 13 deletions.
diff --git a/...s/src/main/java/io/quarkus/bot/buildreporter/githubactions/BuildReporterEventHandler.java b/...s/src/main/java/io/quarkus/bot/buildreporter/githubactions/BuildReporterEventHandler.java
@@ -108,7 +108,8 @@ private void handleCompleted(GHWorkflow workflow,
             artifactsAvailable = true;
         } catch (ConditionTimeoutException e) {
             if (workflowRun.getConclusion() != Conclusion.CANCELLED) {
-                LOG.warn("Workflow run #" + workflowRun.getId()
+                LOG.warn("Workflow run " + workflowRun.getRepository().getFullName() + "#"
+                        + workflowRun.getName() + ":" + workflowRun.getId()
                         + " - Unable to get the artifacts in a timely manner, ignoring them");
             }
             artifacts = Collections.emptyList();

diff --git a/...-actions/src/main/resources/templates/WorkflowReportFormatter/checkRunReport.md b/...-actions/src/main/resources/templates/WorkflowReportFormatter/checkRunReport.md
@@ -1,7 +1,15 @@
 ## Test Failures
 
-{#if !includeStackTraces}:warning: Unable to include the stracktraces as the report was too long. See annotations below for the details.{/if}
-{#if !includeFailureLinks}:warning: Unable to include the failure links as the report was too long. See annotations below for the details.{/if}
+{#if !includeStackTraces}
+> [!WARNING]
+> Unable to include the stracktraces as the report was too long. See annotations below for the details.
+
+{/if}
+{#if !includeFailureLinks}
+> [!WARNING]
+> Unable to include the failure links as the report was too long. See annotations below for the details.
+
+{/if}
 
 {#for job in report.jobsWithReportedFailures}
 ### :gear: {job.name} {#if job.reportedFailures}<a href="#user-content-{job.failuresAnchor}" id="{job.failuresAnchor}">#</a>{/if}

diff --git a/...s/src/main/resources/templates/WorkflowReportFormatter/checkRunReportSummary.md b/...s/src/main/resources/templates/WorkflowReportFormatter/checkRunReportSummary.md
@@ -1,15 +1,21 @@
 {#if report.cancelled}
-:no_entry_sign: This build has been cancelled.
+> [!NOTE]
+> :no_entry_sign: This build has been cancelled.
 
 {/if}
 {#if report.failure && !report.jobsFailing}
-✖ This build has failed but no jobs reported an error. Something weird happened, please check [the workflow run page]({report.workflowRunUrl}) carefully.
+> [!CAUTION]
+> This build has failed but no jobs reported an error. Something weird happened, please check [the workflow run page]({report.workflowRunUrl}) carefully.
 
 {/if}
 {#if report.jobsFailing}
 ## <a id="build-summary-top"></a>Failing Jobs - Building {report.sha} - [Back to {workflowContext.type}]({workflowContext.htmlUrl})
 
-{#if !artifactsAvailable && !report.cancelled}:warning: Artifacts of the workflow run were not available thus the report misses some details.{/if}
+{#if !artifactsAvailable && !report.cancelled}
+> [!WARNING]
+> Artifacts of the workflow run were not available thus the report misses some details.
+
+{/if}
 
 | Status | Name | Step | Failures | Logs | Raw logs | Build scan |
 | :-:  | --  | --  | :-:  | :-:  | :-:  | :-:  |
@@ -21,5 +27,7 @@
 {/if}
 
 {#if report.flakyTests}
-:warning: This workflow run had flaky tests. See details for more information.
+> [!WARNING]
+> This workflow run had flaky tests. See details for more information.
+
 {/if}
diff --git a/...b-actions/src/main/resources/templates/WorkflowReportFormatter/commentReport.md b/...b-actions/src/main/resources/templates/WorkflowReportFormatter/commentReport.md
@@ -3,16 +3,27 @@
 This is the status report for running `{report.workflowName}` on commit {report.sha}.
 
 {#if report.cancelled}
-:no_entry_sign: This workflow run has been cancelled.
+> [!NOTE]
+> :no_entry_sign: This build has been cancelled.
 
 {/if}
 
-{#if !includeStackTraces}:warning: Unable to include the stracktraces as the report was too long. See annotations below for the details.{/if}
-{#if !includeFailureLinks}:warning: Unable to include the failure links as the report was too long. See annotations below for the details.{/if}
+{#if !includeStackTraces}
+> [!WARNING]
+> Unable to include the stracktraces as the report was too long. See annotations below for the details.
+
+{/if}
+{#if !includeFailureLinks}
+> [!WARNING]
+> Unable to include the failure links as the report was too long. See annotations below for the details.
+
+{/if}
 
 {#if report.failure}
 {#if !report.jobsFailing}
-✖ This workflow run has failed but no jobs reported an error. Something weird happened, please check [the workflow run page]({report.workflowRunUrl}) carefully: it might be an issue with the workflow configuration itself.
+> [!CAUTION]
+> This workflow run has failed but no jobs reported an error. Something weird happened, please check [the workflow run page]({report.workflowRunUrl}) carefully: it might be an issue with the workflow configuration itself.
+
 {#else}
 ## Failing Jobs
 
@@ -33,7 +44,8 @@ Full information is available in the [Build summary check run]({checkRun.htmlUrl
 {#if develocityEnabled}{buildScansCheckRunMarker}{/if}
 
 {#if report.errorDownloadingBuildReports}
-:warning: Errors occurred while downloading the build reports. This report is incomplete.
+> [!WARNING]
+> Errors occurred while downloading the build reports. This report is incomplete.
 {/if}
 
 {#if report.reportedFailures}
@@ -88,7 +100,8 @@ Full information is available in the [Build summary check run]({checkRun.htmlUrl
 It should be safe to merge provided you have a look at the other checks in the summary.
 
 {#if hasOtherPendingCheckRuns}
-:warning: There are other workflow runs running, you probably need to wait for their status before merging.
+> [!WARNING]
+> There are other workflow runs running, you probably need to wait for their status before merging.
 
 {/if}
 {#if develocityEnabled}{buildScansCheckRunMarker}{/if}