The highest tagged major version is v5.

pkg

package

v2.1.3 Latest Latest Go to latest Published: Aug 9, 2021 License: Apache-2.0 Imports: 22 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ossf/scorecard

Links

Open Source Insights

Documentation ¶

Overview ¶

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

Index ¶

type ScorecardResult
- func RunScorecards(ctx context.Context, repo repos.RepoURL, checksToRun checker.CheckNameToFnMap, ...) (ScorecardResult, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ScorecardResult ¶

type ScorecardResult struct {
	Repo     string
	Date     string
	Checks   []checker.CheckResult
	Metadata []string
}

ScorecardResult struct is returned on a successful Scorecard run.

func RunScorecards ¶

func RunScorecards(ctx context.Context,
	repo repos.RepoURL,
	checksToRun checker.CheckNameToFnMap,
	repoClient clients.RepoClient,
	httpClient *http.Client,
	githubClient *github.Client,
	graphClient *githubv4.Client) (ScorecardResult, error)

RunScorecards runs enabled Scorecard checks on a RepoURL.

func (*ScorecardResult) AsCSV ¶

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

AsCSV outputs ScorecardResult in CSV format.

func (*ScorecardResult) AsJSON ¶

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

AsJSON outputs the result in JSON format with a newline at the end. If called on []ScorecardResult will create NDJson formatted output.

func (*ScorecardResult) AsString ¶

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

AsString returns ScorecardResult in string format.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL