From 6584f580dc92d54550704cb57494b9f9a90665f3 Mon Sep 17 00:00:00 2001
From: Gabriela Gutierrez <gabigutierrez@google.com>
Date: Wed, 28 Feb 2024 18:01:54 +0000
Subject: [PATCH] feat: Display maintainers annotation

The annotations are displayed inside the check collapsible component, after the reason and details, as "Maintainers Annotation". Then, we list the human-readable annotations for that check based on the label annotations given by the maintainer in scorecard.yml file.

(For this field to come, first the JSON output in ossf/scorecard needs to introduce the maintainers annotation field).

Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>
---
 openapi.yaml                             | 5 +++++
 scorecards-site/static/viewer/index.html | 6 ++++++
 2 files changed, 11 insertions(+)

diff --git a/openapi.yaml b/openapi.yaml
index 953c9bbc..5a3da019 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -223,6 +223,11 @@ definitions:
         x-order: 4
         items:
           type: string
+      maintainersAnnotation:
+        type: array
+        x-order: 5
+        items:
+          type: string
 
   VerifiedScorecardResult:
     type: object
diff --git a/scorecards-site/static/viewer/index.html b/scorecards-site/static/viewer/index.html
index a1c4fe7a..0a37b930 100644
--- a/scorecards-site/static/viewer/index.html
+++ b/scorecards-site/static/viewer/index.html
@@ -931,6 +931,12 @@
                   <div class="text-muted detail-line">{{this}}</div>
                 {{/each}}
               {{/if}}
+              {{#if maintainersAnnotation}}
+                <div class="fw-semibold details-title">Maintainers Annotation</div>
+                {{#each maintainersAnnotation}}
+                  <div class="text-muted detail-line">{{this}}</div>
+                {{/each}}
+              {{/if}}
               <div class="link-wrapper">
                 <a class="btn-link fw-semibold" href="{{documentation.url}}" target="_blank" rel="noopener noreferrer">
                   <div class="d-flex flex-row align-items-center justify-content-end">