pkg

Documentation

Overview

Package pkg defines fns for running Scorecard checks on a Repo.

Index

• func DetailToString(d *checker.CheckDetail, logLevel zapcore.Level) string
• func GetArch() string
• func GetBuildDate() string
• func GetCommit() string
• func GetCompiler() string
• func GetGoVersion() string
• func GetOS() string
• func GetSemanticVersion() string
• func GetTagVersion() string
• func GetTreeState() string
• type RepoInfo
• type ScorecardInfo
• type ScorecardResult
  • func RunScorecards(ctx context.Context, repo clients.Repo, checksToRun checker.CheckNameToFnMap, ...) (ScorecardResult, error)
  • func (r *ScorecardResult) AsJSON(showDetails bool, logLevel zapcore.Level, writer io.Writer) error
  • func (r *ScorecardResult) AsJSON2(showDetails bool, logLevel zapcore.Level, checkDocs docs.Doc, writer io.Writer) error
  • func (r *ScorecardResult) AsSARIF(showDetails bool, logLevel zapcore.Level, writer io.Writer, checkDocs docs.Doc, ...) error
  • func (r *ScorecardResult) AsString(showDetails bool, logLevel zapcore.Level, checkDocs docs.Doc, writer io.Writer) error
  • func (r *ScorecardResult) GetAggregateScore(checkDocs docs.Doc) (float64, error)

Functions

func DetailToString

func DetailToString(d *checker.CheckDetail, logLevel zapcore.Level) string

DetailToString turns a detail information into a string.

func GetArch

func GetArch() string

GetArch returns the architecture (e.g., x86) the build can run on.

func GetBuildDate

func GetBuildDate() string

GetBuildDate returns the date scorecard was build.

func GetCommit

func GetCommit() string

GetCommit returns the GitHub's commit hash that scorecard was built from.

func GetCompiler

func GetCompiler() string

GetCompiler returns the compiler that was used to build scorecard.

func GetGoVersion

func GetGoVersion() string

GetGoVersion returns the Go version used to build scorecard.

func GetOS

func GetOS() string

GetOS returns the OS the build can run on.

func GetSemanticVersion

func GetSemanticVersion() string

GetSemanticVersion returns the semantic version, i.e., X.Y.Z.

func GetTagVersion

func GetTagVersion() string

GetTagVersion returns the scorecard version fr the release GitHub tag, i.e. v.X.Y.Z.

func GetTreeState

func GetTreeState() string

GetTreeState returns the git tree state.

Types

type RepoInfo

type RepoInfo struct {
	Name      string
	CommitSHA string
}

RepoInfo contains information about the repo that was analyzed.

type ScorecardInfo

type ScorecardInfo struct {
	Version   string
	CommitSHA string
}

ScorecardInfo contains information about the scorecard code that was run.

type ScorecardResult

type ScorecardResult struct {
	Repo      RepoInfo
	Date      time.Time
	Scorecard ScorecardInfo
	Checks    []checker.CheckResult
	Metadata  []string
}

ScorecardResult struct is returned on a successful Scorecard run.

func RunScorecards

func RunScorecards(ctx context.Context,
	repo clients.Repo,
	checksToRun checker.CheckNameToFnMap,
	repoClient clients.RepoClient,
	ossFuzzRepoClient clients.RepoClient,
	ciiClient clients.CIIBestPracticesClient) (ScorecardResult, error)

RunScorecards runs enabled Scorecard checks on a Repo.

func (*ScorecardResult) AsJSON

func (r *ScorecardResult) AsJSON(showDetails bool, logLevel zapcore.Level, writer io.Writer) error

AsJSON exports results as JSON for new detail format.

func (*ScorecardResult) AsJSON2

func (r *ScorecardResult) AsJSON2(showDetails bool,
	logLevel zapcore.Level, checkDocs docs.Doc, writer io.Writer) error

AsJSON2 exports results as JSON for new detail format.

func (*ScorecardResult) AsSARIF

func (r *ScorecardResult) AsSARIF(showDetails bool, logLevel zapcore.Level,
	writer io.Writer, checkDocs docs.Doc, policy *spol.ScorecardPolicy,
	policyFile string) error

AsSARIF outputs ScorecardResult in SARIF 2.1.0 format.

func (*ScorecardResult) AsString

func (r *ScorecardResult) AsString(showDetails bool, logLevel zapcore.Level,
	checkDocs docs.Doc, writer io.Writer) error

AsString returns ScorecardResult in string format.

func (*ScorecardResult) GetAggregateScore

func (r *ScorecardResult) GetAggregateScore(checkDocs docs.Doc) (float64, error)

GetAggregateScore returns the aggregate score.