Skip to content

Commit

Permalink
feat: Display maintainers annotation
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
gabibguti committed Feb 28, 2024
1 parent 470fcd8 commit 6584f58
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
5 changes: 5 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,11 @@ definitions:
x-order: 4
items:
type: string
maintainersAnnotation:
type: array
x-order: 5
items:
type: string

VerifiedScorecardResult:
type: object
Expand Down
6 changes: 6 additions & 0 deletions scorecards-site/static/viewer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down

0 comments on commit 6584f58

Please sign in to comment.