github

Documentation

Index

• type Client
  • func NewClient(ctx context.Context, token string, githubEndpoint string, org []string, ...) (*Client, error)
  • func (c *Client) Client() *gh.Client
  • func (c *Client) CollectEnterprises() ([]githubcollected.Enterprise, error)
  • func (c *Client) CollectOrganizations() ([]githubcollected.ExtendedOrg, error)
  • func (c *Client) GetActionsTokenPermissions(url string) (*types.TokenPermissions, error)
  • func (c *Client) GetActionsTokenPermissionsForOrganization(organization string) (*types.TokenPermissions, error)
  • func (c *Client) GetActionsTokenPermissionsForRepository(organization string, repository string) (*types.TokenPermissions, error)
  • func (c *Client) GetRulesForBranch(organization, repository, branch string) ([]*types.RepositoryRule, error)
  • func (c *Client) GetSecurityAndAnalysisForEnterprise(enterprise string) (*types.AnalysisAndSecurityPolicies, error)
  • func (c *Client) GraphQLClient() *githubv4.Client
  • func (c *Client) IsAnalyzable(repository commontypes.RepositoryWithOwner) (bool, error)
  • func (c *Client) IsGithubCloud() bool
  • func (c *Client) Organization(login string) (*githubcollected.ExtendedOrg, error)
  • func (c *Client) Organizations() ([]commontypes.Organization, error)
  • func (c *Client) Orgs() []string
  • func (c *Client) Repositories() ([]commontypes.RepositoryWithOwner, error)
  • func (c *Client) Scopes() permissions.TokenScopes

Types

type Client

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

func NewClient

func NewClient(ctx context.Context, token string, githubEndpoint string, org []string, enterprises []string) (*Client, error)

func (*Client) Client

func (c *Client) Client() *gh.Client

func (*Client) CollectEnterprises

func (c *Client) CollectEnterprises() ([]githubcollected.Enterprise, error)

func (*Client) CollectOrganizations

func (c *Client) CollectOrganizations() ([]githubcollected.ExtendedOrg, error)

func (*Client) GetActionsTokenPermissions

func (c *Client) GetActionsTokenPermissions(url string) (*types.TokenPermissions, error)

func (*Client) GetActionsTokenPermissionsForOrganization

func (c *Client) GetActionsTokenPermissionsForOrganization(organization string) (*types.TokenPermissions, error)

func (*Client) GetActionsTokenPermissionsForRepository

func (c *Client) GetActionsTokenPermissionsForRepository(organization string, repository string) (*types.TokenPermissions, error)

func (*Client) GetRulesForBranch

func (c *Client) GetRulesForBranch(organization, repository, branch string) ([]*types.RepositoryRule, error)

func (*Client) GetSecurityAndAnalysisForEnterprise

func (c *Client) GetSecurityAndAnalysisForEnterprise(enterprise string) (*types.AnalysisAndSecurityPolicies, error)

func (*Client) GraphQLClient

func (c *Client) GraphQLClient() *githubv4.Client

func (*Client) IsAnalyzable

func (c *Client) IsAnalyzable(repository commontypes.RepositoryWithOwner) (bool, error)

func (*Client) IsGithubCloud

func (c *Client) IsGithubCloud() bool

func (*Client) Organization

func (c *Client) Organization(login string) (*githubcollected.ExtendedOrg, error)

func (*Client) Organizations

func (c *Client) Organizations() ([]commontypes.Organization, error)

func (*Client) Orgs

func (c *Client) Orgs() []string

func (*Client) Repositories

func (c *Client) Repositories() ([]commontypes.RepositoryWithOwner, error)

func (*Client) Scopes

func (c *Client) Scopes() permissions.TokenScopes