github

Documentation

Index

• Constants
• type Client
  • func NewClient(ctx context.Context, token string) (*Client, error)
  • func (c *Client) GetOrgActionsPermissions(ctx context.Context, org string) (*github.ActionsPermissions, error)
  • func (c *Client) GetOrgRepos(ctx context.Context, org string) <-chan analyze.RepoBatch
  • func (c *Client) GetOrgWorkflowsPermissions(ctx context.Context, org string) (*github.DefaultWorkflowPermissionOrganization, error)
  • func (c *Client) GetRepoActionsPermissions(ctx context.Context, org string, repo string) (*github.ActionsPermissionsRepository, error)
  • func (c *Client) GetRepoWorkflowsPermissions(ctx context.Context, org string, repo string) (*github.DefaultWorkflowPermissionRepository, error)
  • func (c *Client) GetRepository(ctx context.Context, owner, name string) (*GithubRepository, error)
• type GithubRepository
  • func (gh GithubRepository) BuildGitURL(baseURL string) string
  • func (gh GithubRepository) GetIsFork() bool
  • func (gh GithubRepository) GetProviderName() string
  • func (gh GithubRepository) GetRepoIdentifier() string
• type ScmClient
  • func NewGithubSCMClient(ctx context.Context, baseURL string, token string) (*ScmClient, error)
  • func (s *ScmClient) GetOrgRepos(ctx context.Context, org string) <-chan analyze.RepoBatch
  • func (s *ScmClient) GetProviderBaseURL() string
  • func (s *ScmClient) GetProviderName() string
  • func (s *ScmClient) GetProviderVersion(ctx context.Context) (string, error)
  • func (s *ScmClient) GetRepo(ctx context.Context, org string, name string) (analyze.Repository, error)
  • func (s *ScmClient) GetToken() string
  • func (s *ScmClient) ParseRepoAndOrg(repoString string) (string, string, error)

Constants

const GitHub string = "github"

Types

type Client

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

func NewClient

func NewClient(ctx context.Context, token string) (*Client, error)

func (*Client) GetOrgActionsPermissions

func (c *Client) GetOrgActionsPermissions(ctx context.Context, org string) (*github.ActionsPermissions, error)

func (*Client) GetOrgRepos

func (c *Client) GetOrgRepos(ctx context.Context, org string) <-chan analyze.RepoBatch

func (*Client) GetOrgWorkflowsPermissions

func (c *Client) GetOrgWorkflowsPermissions(ctx context.Context, org string) (*github.DefaultWorkflowPermissionOrganization, error)

func (*Client) GetRepoActionsPermissions

func (c *Client) GetRepoActionsPermissions(ctx context.Context, org string, repo string) (*github.ActionsPermissionsRepository, error)

func (*Client) GetRepoWorkflowsPermissions

func (c *Client) GetRepoWorkflowsPermissions(ctx context.Context, org string, repo string) (*github.DefaultWorkflowPermissionRepository, error)

func (*Client) GetRepository

func (c *Client) GetRepository(ctx context.Context, owner, name string) (*GithubRepository, error)

type GithubRepository

type GithubRepository struct {
	analyze.Repository
	NameWithOwner  string `graphql:"nameWithOwner"`
	IsFork         bool   `graphql:"isFork"`
	IsPrivate      bool   `graphql:"isPrivate"`
	IsMirror       bool   `graphql:"isMirror"`
	IsDisabled     bool   `graphql:"isDisabled"`
	IsEmpty        bool   `graphql:"isEmpty"`
	IsTemplate     bool   `graphql:"isTemplate"`
	StargazerCount int    `graphql:"stargazerCount"`
	ForkCount      int    `graphql:"forkCount"`
}

func (GithubRepository) BuildGitURL

func (gh GithubRepository) BuildGitURL(baseURL string) string

func (GithubRepository) GetIsFork

func (gh GithubRepository) GetIsFork() bool

func (GithubRepository) GetProviderName

func (gh GithubRepository) GetProviderName() string

func (GithubRepository) GetRepoIdentifier

func (gh GithubRepository) GetRepoIdentifier() string

type ScmClient

type ScmClient struct {
	analyze.ScmClient
	// contains filtered or unexported fields
}

func NewGithubSCMClient

func NewGithubSCMClient(ctx context.Context, baseURL string, token string) (*ScmClient, error)

func (*ScmClient) GetOrgRepos

func (s *ScmClient) GetOrgRepos(ctx context.Context, org string) <-chan analyze.RepoBatch

func (*ScmClient) GetProviderBaseURL

func (s *ScmClient) GetProviderBaseURL() string

func (*ScmClient) GetProviderName

func (s *ScmClient) GetProviderName() string

func (*ScmClient) GetProviderVersion

func (s *ScmClient) GetProviderVersion(ctx context.Context) (string, error)

func (*ScmClient) GetRepo

func (s *ScmClient) GetRepo(ctx context.Context, org string, name string) (analyze.Repository, error)

func (*ScmClient) GetToken

func (s *ScmClient) GetToken() string

func (*ScmClient) ParseRepoAndOrg

func (s *ScmClient) ParseRepoAndOrg(repoString string) (string, string, error)