refactor: Rename maintainers annotation to annotations

Renaming flags, function params, docs and fixing config renamings.

Signed-off-by: Gabriela Gutierrez <[email protected]>

Author: gabibguti

README.md

@@ -419,9 +419,9 @@ RESULTS
 |---------|------------------------|--------------------------------|--------------------------------|---------------------------------------------------------------------------|
 ```
 
-##### Showing Maintainers Annotation
+##### Showing Maintainers Annotations
 
-To see maintainers annotations for each check, use the `--show-ma` option.
+To see the maintainers annotations for each check, use the `--show-annotations` option.
 
 ##### Using a GitLab Repository
 

checker/check_result.go

@@ -265,7 +265,7 @@ func LogFindings(findings []finding.Finding, dl DetailLogger) {
 	}
 }
 
-// IsExempted verifies if a given check in the results is exempted in maintainers annotation.
+// IsExempted verifies if a given check in the results is exempted in annotations.
 func (check *CheckResult) IsExempted(c config.Config) (bool, []string) {
 	// If check has a maximum score, then there it doesn't make sense anymore to reason the check
 	// This may happen if the check score was once low but then the problem was fixed on Scorecard side

config/README.md

@@ -1,10 +1,10 @@
-# Maintainers Annotation
+# Maintainers Annotations
 
-Maintainers Annotation is an experimental feature to let maintainers add annotations to Scorecard checks.
+Maintainers Annotations is an experimental feature to let maintainers add annotations to Scorecard checks.
 
-## Showing Maintainers Annotation
+## Showing Maintainers Annotations
 
-To see maintainers annotations for each check on Scorecard results, use the `--show-ma` option.
+To see the maintainers annotations for each check on Scorecard results, use the `--show-annotations` option.
 
 ## Adding Annotations
 

options/flags.go

@@ -54,8 +54,8 @@ const (
 	// FlagShowDetails is the flag name for outputting additional check info.
 	FlagShowDetails = "show-details"
 
-	// FlagShowMaintainersAnnotation is the flag name for outputting maintainers annotations on checks.
-	FlagShowMaintainersAnnotation = "show-ma"
+	// FlagShowAnnotations is the flag name for outputting annotations on checks.
+	FlagShowAnnotations = "show-annotations"
 
 	// FlagChecks is the flag name for specifying which checks to run.
 	FlagChecks = "checks"
@@ -157,9 +157,9 @@ func (o *Options) AddFlags(cmd *cobra.Command) {
 
 	if o.isExperimentalEnabled() {
 		cmd.Flags().BoolVar(
-			&o.ShowMaintainersAnnotation,
-			FlagShowMaintainersAnnotation,
-			o.ShowMaintainersAnnotation,
+			&o.ShowAnnotations,
+			FlagShowAnnotations,
+			o.ShowAnnotations,
 			"show maintainers annotations for checks",
 		)
 	}

options/options.go

@@ -30,23 +30,23 @@ import (
 
 // Options define common options for configuring scorecard.
 type Options struct {
-	Repo                      string
-	Local                     string
-	Commit                    string
-	LogLevel                  string
-	Format                    string
-	NPM                       string
-	PyPI                      string
-	RubyGems                  string
-	Nuget                     string
-	PolicyFile                string
-	ResultsFile               string
-	ChecksToRun               []string
-	ProbesToRun               []string
-	Metadata                  []string
-	CommitDepth               int
-	ShowDetails               bool
-	ShowMaintainersAnnotation bool
+	Repo            string
+	Local           string
+	Commit          string
+	LogLevel        string
+	Format          string
+	NPM             string
+	PyPI            string
+	RubyGems        string
+	Nuget           string
+	PolicyFile      string
+	ResultsFile     string
+	ChecksToRun     []string
+	ProbesToRun     []string
+	Metadata        []string
+	CommitDepth     int
+	ShowDetails     bool
+	ShowAnnotations bool
 	// Feature flags.
 	EnableSarif                 bool `env:"ENABLE_SARIF"`
 	EnableScorecardV6           bool `env:"SCORECARD_V6"`

pkg/json.go

@@ -49,12 +49,12 @@ type jsonCheckDocumentationV2 struct {
 
 //nolint:govet
 type jsonCheckResultV2 struct {
-	Details               []string                 `json:"details"`
-	Score                 int                      `json:"score"`
-	Reason                string                   `json:"reason"`
-	Name                  string                   `json:"name"`
-	Doc                   jsonCheckDocumentationV2 `json:"documentation"`
-	MaintainersAnnotation []string                 `json:"maintainersAnnotation"`
+	Details     []string                 `json:"details"`
+	Score       int                      `json:"score"`
+	Reason      string                   `json:"reason"`
+	Name        string                   `json:"name"`
+	Doc         jsonCheckDocumentationV2 `json:"documentation"`
+	Annotations []string                 `json:"annotations"`
 }
 
 type jsonRepoV2 struct {
@@ -123,7 +123,7 @@ func (r *ScorecardResult) AsJSON(showDetails bool, logLevel log.Level, writer io
 
 // AsJSON2 exports results as JSON for new detail format.
 func (r *ScorecardResult) AsJSON2(showDetails bool,
-	showMaintainersAnnotation bool, logLevel log.Level,
+	showAnnotations bool, logLevel log.Level,
 	checkDocs docs.Doc, writer io.Writer,
 ) error {
 	score, err := r.GetAggregateScore(checkDocs)
@@ -174,10 +174,10 @@ func (r *ScorecardResult) AsJSON2(showDetails bool,
 				tmpResult.Details = append(tmpResult.Details, m)
 			}
 		}
-		if showMaintainersAnnotation {
-			exempted, reasons := checkResult.IsExempted(r.MaintainersAnnotation)
+		if showAnnotations {
+			exempted, reasons := checkResult.IsExempted(r.Config)
 			if exempted {
-				tmpResult.MaintainersAnnotation = reasons
+				tmpResult.Annotations = reasons
 			}
 		}
 		out.Checks = append(out.Checks, tmpResult)

pkg/sarif.go

@@ -628,7 +628,7 @@ func (r *ScorecardResult) AsSARIF(showDetails bool, logLevel log.Level,
 		check := check
 
 		// If check is exempted, skip
-		exempted, _ := check.IsExempted(r.MaintainersAnnotation)
+		exempted, _ := check.IsExempted(r.Config)
 		if exempted {
 			continue
 		}

pkg/scorecard.go

@@ -28,9 +28,9 @@ import (
 
 	"github.com/ossf/scorecard/v4/checker"
 	"github.com/ossf/scorecard/v4/clients"
+	"github.com/ossf/scorecard/v4/config"
 	sce "github.com/ossf/scorecard/v4/errors"
 	"github.com/ossf/scorecard/v4/finding"
-	ma "github.com/ossf/scorecard/v4/maintainers_annotation"
 	"github.com/ossf/scorecard/v4/options"
 	"github.com/ossf/scorecard/v4/probes"
 	"github.com/ossf/scorecard/v4/probes/zrunner"
@@ -164,12 +164,12 @@ func runScorecard(ctx context.Context,
 	// If the user runs checks
 	go runEnabledChecks(ctx, repo, request, checksToRun, resultsCh)
 
-	// Get maintainers annotation
-	maintainersAnnotation, err := ma.GetMaintainersAnnotation(repoClient)
+	// Get configuration
+	c, err := config.Parse(repoClient)
 	if err != nil {
 		return ScorecardResult{}, err
 	}
-	ret.MaintainersAnnotation = maintainersAnnotation
+	ret.Config = c
 
 	for result := range resultsCh {
 		ret.Checks = append(ret.Checks, result)

pkg/scorecard_result.go

@@ -30,11 +30,11 @@ import (
 	"github.com/ossf/scorecard/v4/checks/raw/gitlab"
 	"github.com/ossf/scorecard/v4/clients/githubrepo"
 	"github.com/ossf/scorecard/v4/clients/gitlabrepo"
+	"github.com/ossf/scorecard/v4/config"
 	docChecks "github.com/ossf/scorecard/v4/docs/checks"
 	sce "github.com/ossf/scorecard/v4/errors"
 	"github.com/ossf/scorecard/v4/finding"
 	"github.com/ossf/scorecard/v4/log"
-	ma "github.com/ossf/scorecard/v4/maintainers_annotation"
 	"github.com/ossf/scorecard/v4/options"
 	spol "github.com/ossf/scorecard/v4/policy"
 	"github.com/ossf/scorecard/v4/probes"
@@ -54,14 +54,14 @@ type RepoInfo struct {
 
 // ScorecardResult struct is returned on a successful Scorecard run.
 type ScorecardResult struct {
-	Repo                  RepoInfo
-	Date                  time.Time
-	Scorecard             ScorecardInfo
-	Checks                []checker.CheckResult
-	RawResults            checker.RawResults
-	Findings              []finding.Finding
-	Metadata              []string
-	MaintainersAnnotation ma.MaintainersAnnotation
+	Repo       RepoInfo
+	Date       time.Time
+	Scorecard  ScorecardInfo
+	Checks     []checker.CheckResult
+	RawResults checker.RawResults
+	Findings   []finding.Finding
+	Metadata   []string
+	Config     config.Config
 }
 
 func scoreToString(s float64) string {
@@ -132,12 +132,12 @@ func FormatResults(
 
 	switch opts.Format {
 	case options.FormatDefault:
-		err = results.AsString(opts.ShowDetails, opts.ShowMaintainersAnnotation, log.ParseLevel(opts.LogLevel), doc, output)
+		err = results.AsString(opts.ShowDetails, opts.ShowAnnotations, log.ParseLevel(opts.LogLevel), doc, output)
 	case options.FormatSarif:
 		// TODO: support config files and update checker.MaxResultScore.
 		err = results.AsSARIF(opts.ShowDetails, log.ParseLevel(opts.LogLevel), output, doc, policy, opts)
 	case options.FormatJSON:
-		err = results.AsJSON2(opts.ShowDetails, opts.ShowMaintainersAnnotation, log.ParseLevel(opts.LogLevel), doc, output)
+		err = results.AsJSON2(opts.ShowDetails, opts.ShowAnnotations, log.ParseLevel(opts.LogLevel), doc, output)
 	case options.FormatFJSON:
 		err = results.AsFJSON(opts.ShowDetails, log.ParseLevel(opts.LogLevel), doc, output)
 	case options.FormatPJSON:
@@ -164,7 +164,7 @@ func FormatResults(
 
 // AsString returns ScorecardResult in string format.
 func (r *ScorecardResult) AsString(showDetails bool,
-	showMaintainersAnnotation bool, logLevel log.Level,
+	showAnnotations bool, logLevel log.Level,
 	checkDocs docChecks.Doc, writer io.Writer,
 ) error {
 	data := make([][]string, len(r.Checks))
@@ -194,8 +194,8 @@ func (r *ScorecardResult) AsString(showDetails bool,
 			}
 		}
 		x = append(x, doc)
-		if showMaintainersAnnotation {
-			_, reasons := row.IsExempted(r.MaintainersAnnotation)
+		if showAnnotations {
+			_, reasons := row.IsExempted(r.Config)
 			x = append(x, strings.Join(reasons, "\n"))
 		}
 		data[i] = x
@@ -218,8 +218,8 @@ func (r *ScorecardResult) AsString(showDetails bool,
 		header = append(header, "Details")
 	}
 	header = append(header, "Documentation/Remediation")
-	if showMaintainersAnnotation {
-		header = append(header, "Maintainers Annotation")
+	if showAnnotations {
+		header = append(header, "Annotation")
 	}
 	table.SetHeader(header)
 	table.SetBorders(tablewriter.Border{Left: true, Top: true, Right: true, Bottom: true})