scanner

May 18, 2026

Changes in this version

+ type MergeGate struct

+ EnforcesPRFlow bool

+ RequiredReviewers int

+ RequiredStatusChecks []string

type Repo

+ MergeGate *MergeGate

May 18, 2026

Changes in this version

type BranchProtection

+ EnforcesPRFlow bool

May 6, 2026

Changes in this version

+ const Version

+ type HasRequiredChecks struct

+ func (r HasRequiredChecks) Category() RuleCategory

+ func (r HasRequiredChecks) Check(repo Repo) bool

+ func (r HasRequiredChecks) Description() string

+ func (r HasRequiredChecks) Name() string

May 4, 2026

Changes in this version

type GitHubClient

+ GetBranchInfo func(ctx context.Context, owner, repo, branch string) (*BranchProtection, error)

type HasRequiredReviewers

+ func (r HasRequiredReviewers) RequiresAdmin() bool

type Option

+ func WithAdmin(b bool) Option

type Repo

+ License string

type ScanResult

+ RulesAdditional []Rule

+ RulesScored []Rule

May 2, 2026

Changes in this version

+ func Score(sr ScanResult) (score int, defined bool)

+ type Bucket struct

+ MaxPct int

+ MinPct int

+ Name string

+ func BucketOf(rr RepoResult) (b Bucket, scoredPassing, scoredTotal, scorePct int)

+ func Buckets() []Bucket

type HasActivity

+ func (r HasActivity) Category() RuleCategory

type HasBranchProtection

+ func (r HasBranchProtection) Category() RuleCategory

type HasCIWorkflow

+ func (r HasCIWorkflow) Category() RuleCategory

type HasCodeowners

+ func (r HasCodeowners) Category() RuleCategory

type HasLicense

+ func (r HasLicense) Category() RuleCategory

+ type HasReadme struct

+ func (r HasReadme) Category() RuleCategory

+ func (r HasReadme) Check(repo Repo) bool

+ func (r HasReadme) Description() string

+ func (r HasReadme) HowToFix() string

+ func (r HasReadme) Name() string

type HasRepoDescription

+ func (r HasRepoDescription) Category() RuleCategory

type HasRequiredReviewers

+ func (r HasRequiredReviewers) Category() RuleCategory

type HasRequiredStatusChecks

+ func (r HasRequiredStatusChecks) Category() RuleCategory

type HasSecurityMd

+ func (r HasSecurityMd) Category() RuleCategory

type Rule

+ func AdditionalRules() []Rule

+ func ScoredRules() []Rule

+ Category func() RuleCategory

+ type RuleCategory string

+ const CategoryAdditional

+ const CategoryScored

May 1, 2026

Changes in this version

+ func IsRateLimitError(err error) bool

type Repo

+ Fork bool

type RepoResult

+ MostRecentCommit time.Time

+ type ScanResult struct

+ ArchivedExcluded int

+ ForksExcluded int

+ Org string

+ Results []RepoResult

+ ScannedAt time.Time

+ Skipped []RepoResult

+ TotalRepos int

Apr 29, 2026

Changes in this version

+ type HasActivity struct

+ Now time.Time

+ func (r HasActivity) Check(repo Repo) bool

+ func (r HasActivity) Description() string

+ func (r HasActivity) HowToFix() string

+ func (r HasActivity) Name() string

type Repo

+ PushedAt time.Time

Apr 25, 2026

Changes in this version

type HasBranchProtection

+ func (r HasBranchProtection) Description() string

+ func (r HasBranchProtection) HowToFix() string

type HasCIWorkflow

+ func (r HasCIWorkflow) Description() string

+ func (r HasCIWorkflow) HowToFix() string

type HasCodeowners

+ func (r HasCodeowners) Description() string

+ func (r HasCodeowners) HowToFix() string

type HasGitignore

+ func (r HasGitignore) Description() string

+ func (r HasGitignore) HowToFix() string

type HasLicense

+ func (r HasLicense) Description() string

+ func (r HasLicense) HowToFix() string

type HasRepoDescription

+ func (r HasRepoDescription) Description() string

+ func (r HasRepoDescription) HowToFix() string

type HasRequiredReviewers

+ func (r HasRequiredReviewers) Description() string

+ func (r HasRequiredReviewers) HowToFix() string

type HasRequiredStatusChecks

+ func (r HasRequiredStatusChecks) Description() string

+ func (r HasRequiredStatusChecks) HowToFix() string

type HasSecurityMd

+ func (r HasSecurityMd) Description() string

+ func (r HasSecurityMd) HowToFix() string

type HasSubstantialReadme

+ func (r HasSubstantialReadme) Description() string

+ func (r HasSubstantialReadme) HowToFix() string

type HasTestDirectory

+ func (r HasTestDirectory) Description() string

+ func (r HasTestDirectory) HowToFix() string

type Rule

+ Description func() string

+ HowToFix func() string

Apr 19, 2026

Changes in this version

+ type Auth interface

type GitHubClient

+ ListReposByAccount func(ctx context.Context, name string) ([]Repo, error)

+ ListReposByInstallation func(ctx context.Context) ([]Repo, error)

+ type InstallationAuth struct

+ Name string

+ Token string

+ type PATAuth struct

+ Name string

+ Token string

Apr 14, 2026

Changes in this version

+ var ErrEmptyRepo = errors.New("repository is empty")

+ var ErrTruncatedTree = errors.New("tree truncated by GitHub API")

+ type Option func(*scanOptions)

+ func WithBaseURL(url string) Option

type RepoResult

+ KnownSkipReason string

+ UnknownSkipError string

+ func (rr RepoResult) Skipped() bool

Apr 6, 2026

Changes in this version

+ func GenerateReport(org string, results []RepoResult) string

+ func Run(ctx context.Context, cfg Config) error

+ type BranchProtection struct

+ RequiredReviewers int

+ RequiredStatusChecks []string

+ type Config struct

+ Org string

+ ReportRepo string

+ Token string

+ type FileEntry struct

+ Path string

+ Size int

+ Type string

+ type GitHubClient interface

+ CreateIssue func(ctx context.Context, owner, repo, title, body string) error

+ GetBranchProtection func(ctx context.Context, owner, repo, branch string) (*BranchProtection, error)

+ GetRulesets func(ctx context.Context, owner, repo, branch string) (*BranchProtection, error)

+ GetTree func(ctx context.Context, owner, repo, branch string) ([]FileEntry, error)

+ ListRepos func(ctx context.Context, org string) ([]Repo, error)

+ func NewGitHubClient(token string) GitHubClient

+ type HasBranchProtection struct

+ func (r HasBranchProtection) Check(repo Repo) bool

+ func (r HasBranchProtection) Name() string

+ type HasCIWorkflow struct

+ func (r HasCIWorkflow) Check(repo Repo) bool

+ func (r HasCIWorkflow) Name() string

+ type HasCodeowners struct

+ func (r HasCodeowners) Check(repo Repo) bool

+ func (r HasCodeowners) Name() string

+ type HasGitignore struct

+ func (r HasGitignore) Check(repo Repo) bool

+ func (r HasGitignore) Name() string

+ type HasLicense struct

+ func (r HasLicense) Check(repo Repo) bool

+ func (r HasLicense) Name() string

+ type HasRepoDescription struct

+ func (r HasRepoDescription) Check(repo Repo) bool

+ func (r HasRepoDescription) Name() string

+ type HasRequiredReviewers struct

+ func (r HasRequiredReviewers) Check(repo Repo) bool

+ func (r HasRequiredReviewers) Name() string

+ type HasRequiredStatusChecks struct

+ func (r HasRequiredStatusChecks) Check(repo Repo) bool

+ func (r HasRequiredStatusChecks) Name() string

+ type HasSecurityMd struct

+ func (r HasSecurityMd) Check(repo Repo) bool

+ func (r HasSecurityMd) Name() string

+ type HasSubstantialReadme struct

+ func (r HasSubstantialReadme) Check(repo Repo) bool

+ func (r HasSubstantialReadme) Name() string

+ type HasTestDirectory struct

+ func (r HasTestDirectory) Check(repo Repo) bool

+ func (r HasTestDirectory) Name() string

+ type Repo struct

+ Archived bool

+ BranchProtection *BranchProtection

+ DefaultBranch string

+ Description string

+ Files []FileEntry

+ Name string

+ type RepoResult struct

+ RepoName string

+ Results []RuleResult

+ func Scan(ctx context.Context, client GitHubClient, org string) ([]RepoResult, error)

+ type Rule interface

+ Check func(repo Repo) bool

+ Name func() string

+ func AllRules() []Rule

+ type RuleResult struct

+ Passed bool

+ RuleName string