package
3.2.1
Repository: https://github.com/ossf/scorecard.git
Documentation: pkg.go.dev

# Packages

Package githubrepo implements clients.RepoClient for GitHub.
Package localdir is local repo containing source code.
Package mockrepo is a generated GoMock package.

# Functions

BlobCIIBestPracticesClient returns a blob-based implementation of the interface.
DefaultCIIBestPracticesClient returns http-based implementation of the interface.
ParseBadgeResponseFromJSON parses input []byte value into []BadgeResponse.

# Constants

Gold level for CII Best Practices badge.
InProgress state of CII Best Practices badge.
NotFound represents when CII Best Practices returns an empty response for a project.
Passing level for CII Best Practices badge.
Silver level for CII Best Practices badge.
Unknown or non-parsable CII Best Practices badge.

# Variables

ErrUnsupportedFeature indicates an API that is not supported by the client.

# Structs

BadgeResponse struct is used to read/write CII Best Practices badge data.
BranchProtectionRule captures the settings enabled on a branch for security.
BranchRef represents a single branch reference and its protection rules.
CheckRun is a single instance of a VCS CheckRun.
CheckRunApp is the app running the Check.
Commit represents a Git commit.
Contributor represents a contributor to a repo.
Issue represents a thread like GitHub issue comment thread.
Label represents a PR label.
PullRequest struct represents a PR as returned by RepoClient.
PullRequestReviewRule captures settings on a PullRequest.
Release represents a release version of a package/repo.
ReleaseAsset is part of the Release bundle.
Review represents a PR review.
SearchRequest queries a repo for `Query`.
SearchResponse returns the results from a search request on a repo.
SearchResult represents a matching result from the search query.
Status for a Git object/ref.
StatusChecksRule captures settings on status checks.
User represents a Git user.
WorkflowRun represents VCS WorkflowRun.

# Interfaces

CIIBestPracticesClient interface returns the BadgeLevel for a repo URL.
Repo interface uniquely identifies a repo.
RepoClient interface is used by Scorecard checks to access a repo.

# Type aliases

BadgeLevel corresponds to CII-Best-Practices badge levels.