Skip to content

Commit 6584f58

Browse files
committed
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>
1 parent 470fcd8 commit 6584f58

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

openapi.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,11 @@ definitions:
223223
x-order: 4
224224
items:
225225
type: string
226+
maintainersAnnotation:
227+
type: array
228+
x-order: 5
229+
items:
230+
type: string
226231

227232
VerifiedScorecardResult:
228233
type: object

scorecards-site/static/viewer/index.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -931,6 +931,12 @@
931931
<div class="text-muted detail-line">{{this}}</div>
932932
{{/each}}
933933
{{/if}}
934+
{{#if maintainersAnnotation}}
935+
<div class="fw-semibold details-title">Maintainers Annotation</div>
936+
{{#each maintainersAnnotation}}
937+
<div class="text-muted detail-line">{{this}}</div>
938+
{{/each}}
939+
{{/if}}
934940
<div class="link-wrapper">
935941
<a class="btn-link fw-semibold" href="{{documentation.url}}" target="_blank" rel="noopener noreferrer">
936942
<div class="d-flex flex-row align-items-center justify-content-end">

0 commit comments

Comments
 (0)