auditor

Documentation

Index

• type GithubAuditor
  • func NewGithubAuditor(token string) (*GithubAuditor, error)
  • func (gs GithubAuditor) AuditOrg(name string, enableUserPermissionStats bool) ([]issue.Issue, map[issue.IssueID]error, error)

Types

type GithubAuditor

type GithubAuditor struct {
	// contains filtered or unexported fields
}

func NewGithubAuditor

func NewGithubAuditor(token string) (*GithubAuditor, error)

func (GithubAuditor) AuditOrg

func (gs GithubAuditor) AuditOrg(
	name string,
	enableUserPermissionStats bool,
) ([]issue.Issue, map[issue.IssueID]error, error)

AuditOrg runs a series of checks on a given organization and returns the issues found, execution state for each check run (whether it was successful or yielded in an error), and a generic overall error if audit fails overall