From fb84bcfbcbf938f920bc8be563bd36cd13e2541d Mon Sep 17 00:00:00 2001 From: laurentsimon Date: Fri, 1 Apr 2022 22:30:59 +0000 Subject: [PATCH] comment --- checks/cii_best_practices.go | 2 +- pkg/json_raw_results.go | 23 ++++++++--------------- 2 files changed, 9 insertions(+), 16 deletions(-) diff --git a/checks/cii_best_practices.go b/checks/cii_best_practices.go index aeb7e557a62c..6fb31de1781d 100644 --- a/checks/cii_best_practices.go +++ b/checks/cii_best_practices.go @@ -32,7 +32,7 @@ func init() { } } -// CodeReview will check if the maintainers perform code review. +// CheckCIIBestPractices will check if the maintainers has a CII badge. func CIIBestPractices(c *checker.CheckRequest) checker.CheckResult { rawData, err := raw.CIIBestPractices(c) if err != nil { diff --git a/pkg/json_raw_results.go b/pkg/json_raw_results.go index 6ec2737aac31..56ad9743d8dd 100644 --- a/pkg/json_raw_results.go +++ b/pkg/json_raw_results.go @@ -119,17 +119,13 @@ type jsonIssue struct { // TODO: add fields, e.g., state=[opened|closed] } -type jsonRawResults struct { - // List of recent issues. - RecentIssues []jsonIssue `json:"issues"` - // List of vulnerabilities. -} - type jsonOssfBestPractices struct { Badge string `json:"badge"` } type jsonRawResults struct { + // Issues. + RecentIssues []jsonIssue `json:"issues"` // OSSF best practices badge. OssfBestPractices jsonOssfBestPractices `json:"openssf-best-practices-badge"` // Vulnerabilities. @@ -208,15 +204,6 @@ func (r *jsonScorecardRawResult) setDefaultCommitData(commits []checker.DefaultB return nil } - -//nolint:unparam -func (r *jsonScorecardRawResult) addOssfBestPracticesRawResults(cbp *checker.CIIBestPracticesData) error { - r.Results.OssfBestPractices.Badge = string(cbp.Badge) - return nil -} - -//nolint:unparam -func (r *jsonScorecardRawResult) addCodeReviewRawResults(cr *checker.CodeReviewData) error { r.Results.DefaultBranchCommits = []jsonDefaultBranchCommit{} for _, commit := range commits { com := jsonDefaultBranchCommit{ @@ -262,6 +249,12 @@ func (r *jsonScorecardRawResult) addCodeReviewRawResults(cr *checker.CodeReviewD return nil } +//nolint:unparam +func (r *jsonScorecardRawResult) addOssfBestPracticesRawResults(cbp *checker.CIIBestPracticesData) error { + r.Results.OssfBestPractices.Badge = string(cbp.Badge) + return nil +} + func (r *jsonScorecardRawResult) addCodeReviewRawResults(cr *checker.CodeReviewData) error { return r.setDefaultCommitData(cr.DefaultBranchCommits) }