# Packages
Package git defines helper functions for clients.RepoClient interface.
Package githubrepo implements clients.RepoClient for GitHub.
NOTE: In GitLab repositories are called projects, however to ensure compatibility, this package will regard to GitLab projects as repositories.
Package localdir is local repo containing source code.
Package mockrepo is a generated GoMock package.
No description provided by the author
# Functions
BlobCIIBestPracticesClient returns a blob-based implementation of the interface.
DefaultCIIBestPracticesClient returns http-based implementation of the interface.
DefaultVulnerabilitiesClient returns a new OSV Vulnerabilities client.
ExperimentalLocalOSVClient returns an OSV Vulnerabilities client which takes advantage of their experimental local database option.
ParseBadgeResponseFromJSON parses input []byte value into []BadgeResponse.
# Constants
All indicates all programming languages.
C: https://www.open-std.org/jtc1/sc22/wg14/.
CMake: https://cmake.org/.
C++: https://cplusplus.com/.
C#: https://docs.microsoft.com/en-us/dotnet/csharp/.
Dockerfile: https://docs.docker.com/engine/reference/builder/.
Go: https://go.dev/.
Gold level for CII Best Practices badge.
Haskell: https://www.haskell.org/.
HeadSHA is default commitSHA value used to denote git HEAD.
InProgress state of CII Best Practices badge.
Java: https://www.java.com/en/.
JavaScript: https://www.javascript.com/.
Kotlin: https://kotlinlang.org/.
NotFound represents when CII Best Practices returns an empty response for a project.
ObjectiveC: the objective c language.
Other indicates other languages not listed by the GitHub API.
Passing level for CII Best Practices badge.
PHP: https://www.php.net/.
Python: https://www.python.org/.
Collaborator: Author has been invited to collaborate on the repository.
Contributor: Author has been a contributor to the repository.
FirstTimeContributor: Author has not previously committed to the repository.
FirstTimer: Author has not previously committed to the VCS.
Maintainer: Author is part of the maintenance team for the repository (GitLab).
Mannequin: Author is a placeholder for an unclaimed user.
Member: Author is a member of the organization that owns the repository.
None: Author has no association with the repository.
Owner: Author is the owner of the repository.
Ruby: https://www.ruby-lang.org/.
Rust: https://github.com/rust-lang/rust.
Scala: https://www.scala-lang.org/.
Silver level for CII Best Practices badge.
Starlark: https://github.com/bazelbuild/starlark.
Swift: https://github.com/apple/swift.
TypeScript: https://www.typescriptlang.org/.
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.
Issue represents a thread like GitHub issue comment thread.
IssueComment represents a comment on an issue.
Label represents a PR label.
Language represents a customized struct for languages used by clients.
License represents a customized struct for licenses used by clients.
PullRequest struct represents a PR as returned by RepoClient.
PullRequestRule 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.
SearchCommitsOptions represents the parameters in the search commit query.
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.
VulnerabilitiesResponse is the response from the vuln DB.
Vulnerability uniquely identifies a reported security vuln.
Webhook represents VCS Webhook.
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.
VulnerabilitiesClient checks for vulnerabilities in vuln DB.
# Type aliases
BadgeLevel corresponds to CII-Best-Practices badge levels.
LanguageName is the name of a language, a customized type of string.
RepoAssociation is how a user is associated with a repository.