add comments to build reports (#50200)

tests/ci/build_report_check.py

@@ -73,6 +73,7 @@ def get_failed_report(
         sanitizer="unknown",
         status=message,
         elapsed_seconds=0,
+        comment="",
     )
     return [build_result], [[""]], [GITHUB_RUN_URL]
 
@@ -87,6 +88,7 @@ def process_report(
         sanitizer=build_config["sanitizer"],
         status="success" if build_report["status"] else "failure",
         elapsed_seconds=build_report["elapsed_seconds"],
+        comment=build_config["comment"],
     )
     build_results = []
     build_urls = []

tests/ci/ci_config.py

@@ -17,6 +17,7 @@ CI_CONFIG = {
             "additional_pkgs": True,
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "coverity": {
             "compiler": "clang-16",
@@ -26,6 +27,7 @@ CI_CONFIG = {
             "tidy": "disable",
             "with_coverage": False,
             "official": False,
+            "comment": "A special build for coverity",
         },
         "package_aarch64": {
             "compiler": "clang-16-aarch64",
@@ -36,6 +38,7 @@ CI_CONFIG = {
             "additional_pkgs": True,
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "package_asan": {
             "compiler": "clang-16",
@@ -44,6 +47,7 @@ CI_CONFIG = {
             "package_type": "deb",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "package_ubsan": {
             "compiler": "clang-16",
@@ -52,6 +56,7 @@ CI_CONFIG = {
             "package_type": "deb",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "package_tsan": {
             "compiler": "clang-16",
@@ -60,6 +65,7 @@ CI_CONFIG = {
             "package_type": "deb",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "package_msan": {
             "compiler": "clang-16",
@@ -68,6 +74,7 @@ CI_CONFIG = {
             "package_type": "deb",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "package_debug": {
             "compiler": "clang-16",
@@ -76,6 +83,7 @@ CI_CONFIG = {
             "package_type": "deb",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "Note: sparse checkout was used",
         },
         "binary_release": {
             "compiler": "clang-16",
@@ -84,6 +92,7 @@ CI_CONFIG = {
             "package_type": "binary",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "binary_tidy": {
             "compiler": "clang-16",
@@ -93,6 +102,7 @@ CI_CONFIG = {
             "static_binary_name": "debug-amd64",
             "tidy": "enable",
             "with_coverage": False,
+            "comment": "clang-tidy is used for static analysis",
         },
         "binary_darwin": {
             "compiler": "clang-16-darwin",
@@ -102,6 +112,7 @@ CI_CONFIG = {
             "static_binary_name": "macos",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "binary_aarch64": {
             "compiler": "clang-16-aarch64",
@@ -110,6 +121,7 @@ CI_CONFIG = {
             "package_type": "binary",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "binary_aarch64_v80compat": {
             "compiler": "clang-16-aarch64-v80compat",
@@ -119,6 +131,7 @@ CI_CONFIG = {
             "static_binary_name": "aarch64v80compat",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "For ARMv8.1 and older",
         },
         "binary_freebsd": {
             "compiler": "clang-16-freebsd",
@@ -128,6 +141,7 @@ CI_CONFIG = {
             "static_binary_name": "freebsd",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "binary_darwin_aarch64": {
             "compiler": "clang-16-darwin-aarch64",
@@ -137,6 +151,7 @@ CI_CONFIG = {
             "static_binary_name": "macos-aarch64",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "binary_ppc64le": {
             "compiler": "clang-16-ppc64le",
@@ -146,6 +161,7 @@ CI_CONFIG = {
             "static_binary_name": "powerpc64le",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "",
         },
         "binary_amd64_compat": {
             "compiler": "clang-16-amd64-compat",
@@ -155,6 +171,7 @@ CI_CONFIG = {
             "static_binary_name": "amd64compat",
             "tidy": "disable",
             "with_coverage": False,
+            "comment": "SSE2-only build",
         },
     },
     "builds_report_config": {

tests/ci/report.py

@@ -243,6 +243,7 @@ class BuildResult:
     sanitizer: str
     status: str
     elapsed_seconds: int
+    comment: str
 
 
 BuildResults = List[BuildResult]
@@ -452,6 +453,7 @@ tr:hover td {{filter: brightness(95%);}}
 <th>Build log</th>
 <th>Build time</th>
 <th class="artifacts">Artifacts</th>
+<th>Comment</th>
 </tr>
 {rows}
 </table>
@@ -519,6 +521,8 @@ def create_build_html_report(
                 links = links[: -len(link_separator)]
             row += f"<td>{links}</td>"
 
+        row += f"<td>{build_result.comment}</td>"
+
         row += "</tr>"
         rows += row
     return HTML_BASE_BUILD_TEMPLATE.format(