clients

package

Go to main page

Versions in this module

v3

v3.2.1

Nov 20, 2021

Changes in this version

+ var ErrUnsupportedFeature = errors.New("unsupported feature")

+ type BadgeLevel uint

+ const Gold

+ const InProgress

+ const NotFound

+ const Passing

+ const Silver

+ const Unknown

+ type BadgeResponse struct

+ BadgeLevel string

+ func ParseBadgeResponseFromJSON(data []byte) ([]BadgeResponse, error)

+ func (resp BadgeResponse) AsJSON() ([]byte, error)

type BranchProtectionRule

+ CheckRules StatusChecksRule

+ type CIIBestPracticesClient interface

+ GetBadgeLevel func(ctx context.Context, uri string) (BadgeLevel, error)

+ func BlobCIIBestPracticesClient(bucketURL string) CIIBestPracticesClient

+ func DefaultCIIBestPracticesClient() CIIBestPracticesClient

+ type Issue struct

+ URI *string

+ UpdatedAt *time.Time

type RepoClient

+ ListIssues func() ([]Issue, error)

type StatusChecksRule

+ RequiresStatusChecks *bool

+ UpToDateBeforeMerge *bool

v3.1.1

Oct 26, 2021

v3.1.0

Oct 25, 2021

Changes in this version

type Repo

+ URI func() string

type RepoClient

+ URI func() string

v3.0.1

Oct 7, 2021

Changes in this version

+ var File_clients_branch_proto protoreflect.FileDescriptor

+ type AllowDeletions struct

+ Enabled bool

+ func (*AllowDeletions) Descriptor() ([]byte, []int)

+ func (*AllowDeletions) ProtoMessage()

+ func (x *AllowDeletions) GetEnabled() bool

+ func (x *AllowDeletions) ProtoReflect() protoreflect.Message

+ func (x *AllowDeletions) Reset()

+ func (x *AllowDeletions) String() string

+ type AllowForcePushes struct

+ Enabled bool

+ func (*AllowForcePushes) Descriptor() ([]byte, []int)

+ func (*AllowForcePushes) ProtoMessage()

+ func (x *AllowForcePushes) GetEnabled() bool

+ func (x *AllowForcePushes) ProtoReflect() protoreflect.Message

+ func (x *AllowForcePushes) Reset()

+ func (x *AllowForcePushes) String() string

+ type BranchProtectionRule struct

+ AllowDeletions *AllowDeletions

+ AllowForcePushes *AllowForcePushes

+ EnforceAdmins *EnforceAdmins

+ RequireLinearHistory *RequireLinearHistory

+ RequiredPullRequestReviews *PullRequestReviewRule

+ RequiredStatusChecks *StatusChecksRule

+ func (*BranchProtectionRule) Descriptor() ([]byte, []int)

+ func (*BranchProtectionRule) ProtoMessage()

+ func (x *BranchProtectionRule) GetAllowDeletions() *AllowDeletions

+ func (x *BranchProtectionRule) GetAllowForcePushes() *AllowForcePushes

+ func (x *BranchProtectionRule) GetEnforceAdmins() *EnforceAdmins

+ func (x *BranchProtectionRule) GetRequireLinearHistory() *RequireLinearHistory

+ func (x *BranchProtectionRule) GetRequiredPullRequestReviews() *PullRequestReviewRule

+ func (x *BranchProtectionRule) GetRequiredStatusChecks() *StatusChecksRule

+ func (x *BranchProtectionRule) ProtoReflect() protoreflect.Message

+ func (x *BranchProtectionRule) Reset()

+ func (x *BranchProtectionRule) String() string

+ type BranchRef struct

+ BranchProtectionRule *BranchProtectionRule

+ Name string

+ Protected bool

+ func (*BranchRef) Descriptor() ([]byte, []int)

+ func (*BranchRef) ProtoMessage()

+ func (x *BranchRef) GetBranchProtectionRule() *BranchProtectionRule

+ func (x *BranchRef) GetName() string

+ func (x *BranchRef) GetProtected() bool

+ func (x *BranchRef) ProtoReflect() protoreflect.Message

+ func (x *BranchRef) Reset()

+ func (x *BranchRef) String() string

+ type CheckRun struct

+ App CheckRunApp

+ Conclusion string

+ Status string

+ URL string

+ type CheckRunApp struct

+ Slug string

+ type Commit struct

+ CommittedDate time.Time

+ Committer User

+ Message string

+ SHA string

+ type Contributor struct

+ Company string

+ NumContributions int

+ Organizations []User

+ User User

+ type EnforceAdmins struct

+ Enabled bool

+ func (*EnforceAdmins) Descriptor() ([]byte, []int)

+ func (*EnforceAdmins) ProtoMessage()

+ func (x *EnforceAdmins) GetEnabled() bool

+ func (x *EnforceAdmins) ProtoReflect() protoreflect.Message

+ func (x *EnforceAdmins) Reset()

+ func (x *EnforceAdmins) String() string

+ type Label struct

+ Name string

+ type PullRequest struct

+ Author User

+ HeadSHA string

+ Labels []Label

+ MergeCommit Commit

+ MergedAt time.Time

+ Number int

+ Reviews []Review

+ type PullRequestReviewRule struct

+ DismissStaleReviews bool

+ RequireCodeOwnerReviews bool

+ RequiredApprovingReviewCount int32

+ func (*PullRequestReviewRule) Descriptor() ([]byte, []int)

+ func (*PullRequestReviewRule) ProtoMessage()

+ func (x *PullRequestReviewRule) GetDismissStaleReviews() bool

+ func (x *PullRequestReviewRule) GetRequireCodeOwnerReviews() bool

+ func (x *PullRequestReviewRule) GetRequiredApprovingReviewCount() int32

+ func (x *PullRequestReviewRule) ProtoReflect() protoreflect.Message

+ func (x *PullRequestReviewRule) Reset()

+ func (x *PullRequestReviewRule) String() string

+ type Release struct

+ Assets []ReleaseAsset

+ TagName string

+ TargetCommitish string

+ URL string

+ type ReleaseAsset struct

+ Name string

+ URL string

+ type Repo interface

+ AppendMetadata func(metadata ...string)

+ IsScorecardRepo func() bool

+ IsValid func() error

+ Metadata func() []string

+ Org func() Repo

+ String func() string

+ URL func() string

+ type RepoClient interface

+ Close func() error

+ GetDefaultBranch func() (*BranchRef, error)

+ GetFileContent func(filename string) ([]byte, error)

+ InitRepo func(repo Repo) error

+ IsArchived func() (bool, error)

+ ListBranches func() ([]*BranchRef, error)

+ ListCheckRunsForRef func(ref string) ([]CheckRun, error)

+ ListCommits func() ([]Commit, error)

+ ListContributors func() ([]Contributor, error)

+ ListFiles func(predicate func(string) (bool, error)) ([]string, error)

+ ListMergedPRs func() ([]PullRequest, error)

+ ListReleases func() ([]Release, error)

+ ListStatuses func(ref string) ([]Status, error)

+ ListSuccessfulWorkflowRuns func(filename string) ([]WorkflowRun, error)

+ Search func(request SearchRequest) (SearchResponse, error)

+ URL func() string

+ type RequireLinearHistory struct

+ Enabled bool

+ func (*RequireLinearHistory) Descriptor() ([]byte, []int)

+ func (*RequireLinearHistory) ProtoMessage()

+ func (x *RequireLinearHistory) GetEnabled() bool

+ func (x *RequireLinearHistory) ProtoReflect() protoreflect.Message

+ func (x *RequireLinearHistory) Reset()

+ func (x *RequireLinearHistory) String() string

+ type Review struct

+ State string

+ type SearchRequest struct

+ Filename string

+ Path string

+ Query string

+ type SearchResponse struct

+ Hits int

+ Results []SearchResult

+ type SearchResult struct

+ Path string

+ type Status struct

+ Context string

+ State string

+ URL string

+ type StatusChecksRule struct

+ Contexts []string

+ Strict bool

+ func (*StatusChecksRule) Descriptor() ([]byte, []int)

+ func (*StatusChecksRule) ProtoMessage()

+ func (x *StatusChecksRule) GetContexts() []string

+ func (x *StatusChecksRule) GetStrict() bool

+ func (x *StatusChecksRule) ProtoReflect() protoreflect.Message

+ func (x *StatusChecksRule) Reset()

+ func (x *StatusChecksRule) String() string

+ type User struct

+ Login string

+ type WorkflowRun struct

+ URL string

Other modules containing this package

github.com/ossf/scorecard/v2

github.com/ossf/scorecard/v4

github.com/ossf/scorecard/v5

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