vcs

package

Go to main page

Versions in this module

v0

v0.1.15

Sep 8, 2026

v0.1.14

Aug 30, 2026

v0.1.13

Aug 30, 2026

v0.1.12

Aug 30, 2026

v0.1.11

Aug 30, 2026

v0.1.10

Aug 30, 2026

v0.1.9

Aug 30, 2026

v0.1.8

Aug 30, 2026

v0.1.7

Aug 16, 2026

v0.1.6

Aug 16, 2026

v0.1.5

Aug 15, 2026

v0.1.4

Aug 15, 2026

v0.1.3

Jul 28, 2026

v0.1.2

Jul 28, 2026

Changes in this version

+ func ChangeBranchNameForFile(filePath string) string

+ func ChangeCommitMessageForFile(filePath string, ruleCount int) string

+ func ChangeRequestBodyForFile(filePath string, ruleIDs []scanner.RuleID, fixesCount int) string

+ func ChangeRequestTitleForFile(filePath string) string

type ChangeRequestResult

+ RuleIDs []scanner.RuleID

type GitHubClient

+ func (g *GitHubClient) FixWorkflowFileRules(ctx context.Context, token, owner, repo, defaultBranch, filePath string, ...) (ChangeRequestResult, error)

+ func (g *GitHubClient) FixWorkflowRules(ctx context.Context, token string, repo RepoCoord, ...) (ChangeRequestResult, error)

type GitLabClient

+ func (g *GitLabClient) FixWorkflowRules(ctx context.Context, token string, repo RepoCoord, ...) (ChangeRequestResult, error)

v0.1.1

Jul 22, 2026

v0.1.0

Jul 12, 2026

Changes in this version

+ const ProviderGitHub

+ const ProviderGitLab

+ var ErrChangeRequestNoChange = errors.New("change request produced no change")

+ var ErrSettingsNotSupported = errors.New("repository-settings surface not supported for this provider")

+ func AutoFixableRepoSettingRules() []scanner.RuleID

+ func AutoFixableWorkflowRules() []scanner.RuleID

+ func ChangeBranchName(ruleID scanner.RuleID, filePath string) string

+ func ChangeCommitMessage(ruleID scanner.RuleID, filePath string) string

+ func ChangeRequestBody(ruleID scanner.RuleID, filePath string, fixesCount int) string

+ func ChangeRequestTitle(ruleID scanner.RuleID) string

+ func IsAutoFixableRepoSetting(ruleID scanner.RuleID) bool

+ func IsAutoFixableWorkflowRule(ruleID scanner.RuleID) bool

+ func IsWorkflowPath(p string) bool

+ func StatusOf(err error) int

+ type ChangeRequestResult struct

+ BranchName string

+ File string

+ FixesApplied int

+ NoChange bool

+ Number int

+ Provider string

+ Reused bool

+ RuleID scanner.RuleID

+ URL string

+ type CheckRunAnnotation struct

+ EndLine int

+ Level string

+ Message string

+ Path string

+ StartLine int

+ Title string

+ type CheckRunParams struct

+ Annotations []CheckRunAnnotation

+ Conclusion string

+ HeadSHA string

+ Name string

+ Summary string

+ Title string

+ type GitHubAPIError struct

+ Body string

+ Method string

+ Status int

+ URL string

+ func (e *GitHubAPIError) Error() string

+ type GitHubClient struct

+ func NewBareGitHubClient(opts ...Option) *GitHubClient

+ func NewGitHubAppClient(appID, privateKeyPEM string, opts ...Option) (*GitHubClient, error)

+ func (g *GitHubClient) AuditSettings(ctx context.Context, token string, repo RepoCoord, ...) ([]scanner.Finding, error)

+ func (g *GitHubClient) CreateCheckRun(ctx context.Context, token, owner, repo string, p CheckRunParams) error

+ func (g *GitHubClient) DiscoverRepos(ctx context.Context, token string) ([]RepoView, error)

+ func (g *GitHubClient) FetchRepoConfig(ctx context.Context, token, owner, repo, ref string) ([]byte, error)

+ func (g *GitHubClient) FetchRepoMeta(ctx context.Context, token, owner, repo string) (*RepoMeta, error)

+ func (g *GitHubClient) FetchRepositorySettings(ctx context.Context, token, owner, repo, defaultBranch, htmlURL string) (*scanner.RepositoryContext, error)

+ func (g *GitHubClient) FetchWorkflows(ctx context.Context, token, owner, repo, ref string) ([]WorkflowFile, error)

+ func (g *GitHubClient) FetchWorkflowsLimited(ctx context.Context, token, owner, repo, ref string, ...) (files []WorkflowFile, truncated bool, err error)

+ func (g *GitHubClient) FixRepositorySettings(ctx context.Context, token, owner, repo, defaultBranch string, ...) SettingsFixResult

+ func (g *GitHubClient) FixSetting(ctx context.Context, token string, repo RepoCoord, defaultBranch string, ...) (SettingsFixAction, error)

+ func (g *GitHubClient) FixSingleRepositorySetting(ctx context.Context, token, owner, repo, defaultBranch string, ...) (SettingsFixAction, error)

+ func (g *GitHubClient) FixWorkflow(ctx context.Context, token string, repo RepoCoord, ...) (ChangeRequestResult, error)

+ func (g *GitHubClient) FixWorkflowFile(ctx context.Context, token, owner, repo, defaultBranch, filePath string, ...) (ChangeRequestResult, error)

+ func (g *GitHubClient) GetInstallation(ctx context.Context, installationID int64) (*Installation, error)

+ func (g *GitHubClient) InstallationToken(ctx context.Context, installationID int64) (string, error)

+ func (g *GitHubClient) ListOwnerRepos(ctx context.Context, token, owner string) ([]Repo, error)

+ func (g *GitHubClient) ListPullRequestFiles(ctx context.Context, token, owner, repo string, number int) ([]string, error)

+ func (g *GitHubClient) ListRepos(ctx context.Context, token string) ([]Repo, error)

+ func (g *GitHubClient) LoadRepoConfig(ctx context.Context, token string, repo RepoCoord, ref string) ([]byte, error)

+ func (g *GitHubClient) LoadWorkflows(ctx context.Context, token string, repo RepoCoord, ref string) ([]WorkflowFile, error)

+ func (g *GitHubClient) Provider() string

+ type GitLabAPIError struct

+ Body string

+ Method string

+ Status int

+ URL string

+ func (e *GitLabAPIError) Error() string

+ type GitLabClient struct

+ func NewBareGitLabClient(host string, opts ...Option) *GitLabClient

+ func NewGitLabClient(defaultHost string, opts ...Option) *GitLabClient

+ func (g *GitLabClient) AuditSettings(ctx context.Context, token string, repo RepoCoord, ...) ([]scanner.Finding, error)

+ func (g *GitLabClient) CurrentUser(ctx context.Context, host, token string) (login, avatarURL string, err error)

+ func (g *GitLabClient) DiscoverRepos(ctx context.Context, token string) ([]RepoView, error)

+ func (g *GitLabClient) FetchProjectSettings(ctx context.Context, token string, repo RepoCoord, ...) (*scanner.GitLabProjectContext, error)

+ func (g *GitLabClient) FixSetting(ctx context.Context, token string, repo RepoCoord, _ string, ...) (SettingsFixAction, error)

+ func (g *GitLabClient) FixWorkflow(ctx context.Context, token string, repo RepoCoord, ...) (ChangeRequestResult, error)

+ func (g *GitLabClient) LoadRepoConfig(ctx context.Context, token string, repo RepoCoord, ref string) ([]byte, error)

+ func (g *GitLabClient) LoadWorkflows(ctx context.Context, token string, repo RepoCoord, ref string) ([]WorkflowFile, error)

+ func (g *GitLabClient) Provider() string

+ type Installation struct

+ Account struct{ ... }

+ ID int64

+ type Option func(*clientOptions)

+ func WithBaseURL(u string) Option

+ func WithHTTPClient(h *http.Client) Option

+ type OrgScanOptions struct

+ Concurrency int

+ MinConfidence scanner.Confidence

+ Online bool

+ Persona scanner.Persona

+ Ruleset string

+ type OrgScanResult struct

+ Owner string

+ Repos []RepoScanResult

+ func (r *OrgScanResult) Errors() []string

+ func (r *OrgScanResult) Flatten() ([]scanner.Finding, []scanner.ToxicCombo)

+ func (r *OrgScanResult) SeverityLines() []string

+ type OrgScanner struct

+ Client *GitHubClient

+ func NewOrgScanner() *OrgScanner

+ func (o *OrgScanner) Scan(ctx context.Context, token, owner string, opts OrgScanOptions) (*OrgScanResult, error)

+ type Repo struct

+ DefaultBranch string

+ FullName string

+ HTMLURL string

+ ID int64

+ Name string

+ Owner struct{ ... }

+ Private bool

+ type RepoCoord struct

+ ID string

+ Name string

+ Owner string

+ type RepoMeta struct

+ DefaultBranch string

+ FullName string

+ Private bool

+ type RepoScanResult struct

+ Combos []scanner.ToxicCombo

+ Err error

+ Findings []scanner.Finding

+ FullName string

+ type RepoView struct

+ DefaultBranch string

+ FullName string

+ HTMLURL string

+ Name string

+ Owner string

+ Private bool

+ ProviderRepoID string

+ type SettingsFixAction struct

+ Description string

+ Endpoint string

+ RuleID scanner.RuleID

+ type SettingsFixError struct

+ Message string

+ RuleID scanner.RuleID

+ type SettingsFixResult struct

+ Applied []SettingsFixAction

+ DryRun bool

+ Errors []SettingsFixError

+ Skipped []scanner.RuleID

+ type WorkflowFile struct

+ Content []byte

+ Path string

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