From 8626bffad30d08792f0acbc813391800838e8207 Mon Sep 17 00:00:00 2001
From: Jacob MacDonald <jakemac@google.com>
Date: Fri, 16 Aug 2024 07:39:11 -0700
Subject: [PATCH] More concise formatting of github workflow summary comments
 (#288)

The health check comment that is posted currently is extremely long, and pushes user comments below the fold.

This proposed new formatting shortens it up quite a bit.
---
 pkgs/firehose/CHANGELOG.md                    |  5 +++++
 pkgs/firehose/lib/src/health/health.dart      | 20 +++++++++----------
 pkgs/firehose/pubspec.yaml                    |  2 +-
 .../test_data/golden/comment_breaking.md      |  4 +---
 .../golden/comment_breaking_ignore_package.md |  4 +---
 .../test_data/golden/comment_changelog.md     |  4 +---
 .../comment_changelog_ignore_package.md       |  4 +---
 .../test_data/golden/comment_coverage.md      |  4 +---
 .../golden/comment_coverage_ignore_package.md |  4 +---
 .../test_data/golden/comment_do-not-submit.md |  4 +---
 .../test_data/golden/comment_leaking.md       |  4 +---
 .../golden/comment_leaking_ignore_package.md  |  4 +---
 .../test_data/golden/comment_license.md       |  4 +---
 .../golden/comment_license_ignore_license.md  |  4 +---
 .../golden/comment_license_ignore_package.md  |  4 +---
 .../test_data/golden/comment_version.md       |  4 +---
 .../golden/comment_version_ignore_package.md  |  4 +---
 17 files changed, 30 insertions(+), 53 deletions(-)

diff --git a/pkgs/firehose/CHANGELOG.md b/pkgs/firehose/CHANGELOG.md
index d409f866..1ded817f 100644
--- a/pkgs/firehose/CHANGELOG.md
+++ b/pkgs/firehose/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 0.9.2
+
+- Improve formatting of the github workflow summary comments so they use less
+  vertical space.
+
 ## 0.9.1
 
 - Support packages nested under a 'workspace' root package.
diff --git a/pkgs/firehose/lib/src/health/health.dart b/pkgs/firehose/lib/src/health/health.dart
index e0cc3b07..12e1d1f7 100644
--- a/pkgs/firehose/lib/src/health/health.dart
+++ b/pkgs/firehose/lib/src/health/health.dart
@@ -20,13 +20,13 @@ import 'coverage.dart';
 import 'license.dart';
 
 enum Check {
-  version('### Package publish validation', 'version'),
-  license('### License Headers', 'license'),
-  changelog('### Changelog Entry', 'changelog'),
-  coverage('### Coverage', 'coverage'),
-  breaking('### Breaking changes', 'breaking'),
-  leaking('### API leaks', 'leaking'),
-  donotsubmit('### Do Not Submit', 'do-not-submit');
+  version('Package publish validation', 'version'),
+  license('License Headers', 'license'),
+  changelog('Changelog Entry', 'changelog'),
+  coverage('Coverage', 'coverage'),
+  breaking('Breaking changes', 'breaking'),
+  leaking('API leaks', 'leaking'),
+  donotsubmit('Do Not Submit', 'do-not-submit');
 
   final String tag;
 
@@ -406,10 +406,11 @@ This check for [test coverage](https://github.com/dart-lang/ecosystem/wiki/Test-
     if (result.markdown != null) {
       var markdown = result.markdown;
       var isWorseThanInfo = result.severity.index >= Severity.warning.index;
-      var s = '''
+
+      markdownSummary = '''
 <details${isWorseThanInfo ? ' open' : ''}>
 <summary>
-Details
+<strong>${check.tag}</strong> ${result.severity.emoji}
 </summary>
 
 $markdown
@@ -418,7 +419,6 @@ ${isWorseThanInfo ? 'This check can be disabled by tagging the PR with `skip-${r
 </details>
 
 ''';
-      markdownSummary = '${check.tag} ${result.severity.emoji}\n\n$s';
     } else {
       markdownSummary = '';
     }
diff --git a/pkgs/firehose/pubspec.yaml b/pkgs/firehose/pubspec.yaml
index d9a079a2..73403073 100644
--- a/pkgs/firehose/pubspec.yaml
+++ b/pkgs/firehose/pubspec.yaml
@@ -1,6 +1,6 @@
 name: firehose
 description: A tool to automate publishing of Pub packages from GitHub actions.
-version: 0.9.1
+version: 0.9.2
 repository: https://github.com/dart-lang/ecosystem/tree/main/pkgs/firehose
 
 environment:
diff --git a/pkgs/firehose/test_data/golden/comment_breaking.md b/pkgs/firehose/test_data/golden/comment_breaking.md
index 4bfe13de..84aabe0b 100644
--- a/pkgs/firehose/test_data/golden/comment_breaking.md
+++ b/pkgs/firehose/test_data/golden/comment_breaking.md
@@ -1,8 +1,6 @@
-### Breaking changes :warning:
-
 <details open>
 <summary>
-Details
+<strong>Breaking changes</strong> :warning:
 </summary>
 
 | Package | Change | Current Version | New Version | Needed Version | Looking good? |
diff --git a/pkgs/firehose/test_data/golden/comment_breaking_ignore_package.md b/pkgs/firehose/test_data/golden/comment_breaking_ignore_package.md
index 121b540b..59fda74f 100644
--- a/pkgs/firehose/test_data/golden/comment_breaking_ignore_package.md
+++ b/pkgs/firehose/test_data/golden/comment_breaking_ignore_package.md
@@ -1,8 +1,6 @@
-### Breaking changes :warning:
-
 <details open>
 <summary>
-Details
+<strong>Breaking changes</strong> :warning:
 </summary>
 
 | Package | Change | Current Version | New Version | Needed Version | Looking good? |
diff --git a/pkgs/firehose/test_data/golden/comment_changelog.md b/pkgs/firehose/test_data/golden/comment_changelog.md
index 2fae5434..ae601aeb 100644
--- a/pkgs/firehose/test_data/golden/comment_changelog.md
+++ b/pkgs/firehose/test_data/golden/comment_changelog.md
@@ -1,8 +1,6 @@
-### Changelog Entry :exclamation:
-
 <details open>
 <summary>
-Details
+<strong>Changelog Entry</strong> :exclamation:
 </summary>
 
 | Package | Changed Files |
diff --git a/pkgs/firehose/test_data/golden/comment_changelog_ignore_package.md b/pkgs/firehose/test_data/golden/comment_changelog_ignore_package.md
index 00fa9033..8c154a43 100644
--- a/pkgs/firehose/test_data/golden/comment_changelog_ignore_package.md
+++ b/pkgs/firehose/test_data/golden/comment_changelog_ignore_package.md
@@ -1,8 +1,6 @@
-### Changelog Entry :exclamation:
-
 <details open>
 <summary>
-Details
+<strong>Changelog Entry</strong> :exclamation:
 </summary>
 
 | Package | Changed Files |
diff --git a/pkgs/firehose/test_data/golden/comment_coverage.md b/pkgs/firehose/test_data/golden/comment_coverage.md
index acd10c8e..52d81eeb 100644
--- a/pkgs/firehose/test_data/golden/comment_coverage.md
+++ b/pkgs/firehose/test_data/golden/comment_coverage.md
@@ -1,8 +1,6 @@
-### Coverage :warning:
-
 <details open>
 <summary>
-Details
+<strong>Coverage</strong> :warning:
 </summary>
 
 | File | Coverage |
diff --git a/pkgs/firehose/test_data/golden/comment_coverage_ignore_package.md b/pkgs/firehose/test_data/golden/comment_coverage_ignore_package.md
index c492d000..46137334 100644
--- a/pkgs/firehose/test_data/golden/comment_coverage_ignore_package.md
+++ b/pkgs/firehose/test_data/golden/comment_coverage_ignore_package.md
@@ -1,8 +1,6 @@
-### Coverage :warning:
-
 <details open>
 <summary>
-Details
+<strong>Coverage</strong> :warning:
 </summary>
 
 | File | Coverage |
diff --git a/pkgs/firehose/test_data/golden/comment_do-not-submit.md b/pkgs/firehose/test_data/golden/comment_do-not-submit.md
index 4df7261a..530c94f3 100644
--- a/pkgs/firehose/test_data/golden/comment_do-not-submit.md
+++ b/pkgs/firehose/test_data/golden/comment_do-not-submit.md
@@ -1,8 +1,6 @@
-### Do Not Submit :exclamation:
-
 <details open>
 <summary>
-Details
+<strong>Do Not Submit</strong> :exclamation:
 </summary>
 
 Body contains `DO_NOT_SUBMIT`: false
diff --git a/pkgs/firehose/test_data/golden/comment_leaking.md b/pkgs/firehose/test_data/golden/comment_leaking.md
index 64d37937..b0abc3d2 100644
--- a/pkgs/firehose/test_data/golden/comment_leaking.md
+++ b/pkgs/firehose/test_data/golden/comment_leaking.md
@@ -1,8 +1,6 @@
-### API leaks :warning:
-
 <details open>
 <summary>
-Details
+<strong>API leaks</strong> :warning:
 </summary>
 
 The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.
diff --git a/pkgs/firehose/test_data/golden/comment_leaking_ignore_package.md b/pkgs/firehose/test_data/golden/comment_leaking_ignore_package.md
index 64d37937..b0abc3d2 100644
--- a/pkgs/firehose/test_data/golden/comment_leaking_ignore_package.md
+++ b/pkgs/firehose/test_data/golden/comment_leaking_ignore_package.md
@@ -1,8 +1,6 @@
-### API leaks :warning:
-
 <details open>
 <summary>
-Details
+<strong>API leaks</strong> :warning:
 </summary>
 
 The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.
diff --git a/pkgs/firehose/test_data/golden/comment_license.md b/pkgs/firehose/test_data/golden/comment_license.md
index ad5231b8..c671aa72 100644
--- a/pkgs/firehose/test_data/golden/comment_license.md
+++ b/pkgs/firehose/test_data/golden/comment_license.md
@@ -1,8 +1,6 @@
-### License Headers :exclamation:
-
 <details open>
 <summary>
-Details
+<strong>License Headers</strong> :exclamation:
 </summary>
 
 ```
diff --git a/pkgs/firehose/test_data/golden/comment_license_ignore_license.md b/pkgs/firehose/test_data/golden/comment_license_ignore_license.md
index cfb18712..3903f9e1 100644
--- a/pkgs/firehose/test_data/golden/comment_license_ignore_license.md
+++ b/pkgs/firehose/test_data/golden/comment_license_ignore_license.md
@@ -1,8 +1,6 @@
-### License Headers :exclamation:
-
 <details open>
 <summary>
-Details
+<strong>License Headers</strong> :exclamation:
 </summary>
 
 ```
diff --git a/pkgs/firehose/test_data/golden/comment_license_ignore_package.md b/pkgs/firehose/test_data/golden/comment_license_ignore_package.md
index 47860a99..8a6f79a2 100644
--- a/pkgs/firehose/test_data/golden/comment_license_ignore_package.md
+++ b/pkgs/firehose/test_data/golden/comment_license_ignore_package.md
@@ -1,8 +1,6 @@
-### License Headers :exclamation:
-
 <details open>
 <summary>
-Details
+<strong>License Headers</strong> :exclamation:
 </summary>
 
 ```
diff --git a/pkgs/firehose/test_data/golden/comment_version.md b/pkgs/firehose/test_data/golden/comment_version.md
index e01840e5..c8835af5 100644
--- a/pkgs/firehose/test_data/golden/comment_version.md
+++ b/pkgs/firehose/test_data/golden/comment_version.md
@@ -1,8 +1,6 @@
-### Package publish validation :exclamation:
-
 <details open>
 <summary>
-Details
+<strong>Package publish validation</strong> :exclamation:
 </summary>
 
 | Package | Version | Status |
diff --git a/pkgs/firehose/test_data/golden/comment_version_ignore_package.md b/pkgs/firehose/test_data/golden/comment_version_ignore_package.md
index 697af42e..376e1d94 100644
--- a/pkgs/firehose/test_data/golden/comment_version_ignore_package.md
+++ b/pkgs/firehose/test_data/golden/comment_version_ignore_package.md
@@ -1,8 +1,6 @@
-### Package publish validation :exclamation:
-
 <details open>
 <summary>
-Details
+<strong>Package publish validation</strong> :exclamation:
 </summary>
 
 | Package | Version | Status |