github

Documentation

Index

• type Client
  • func (c *Client) GetRegistrationToken(ctx context.Context, enterprise, org, repo, name string) (*github.RegistrationToken, error)
  • func (r *Client) IsRunnerBusy(ctx context.Context, enterprise, org, repo, name string) (bool, error)
  • func (c *Client) ListRepositoryWorkflowRuns(ctx context.Context, user string, repoName string) ([]*github.WorkflowRun, error)
  • func (c *Client) ListRunners(ctx context.Context, enterprise, org, repo string) ([]*github.Runner, error)
  • func (c *Client) RemoveRunner(ctx context.Context, enterprise, org, repo string, runnerID int64) error
• type Config
  • func (c *Config) NewClient() (*Client, error)
• type RunnerNotFound
  • func (e *RunnerNotFound) Error() string
• type RunnerOffline
  • func (e *RunnerOffline) Error() string

Types

type Client

type Client struct {
	*github.Client

	// GithubBaseURL to Github without API suffix.
	GithubBaseURL string
	// contains filtered or unexported fields
}

Client wraps GitHub client with some additional

func (*Client) GetRegistrationToken

func (c *Client) GetRegistrationToken(ctx context.Context, enterprise, org, repo, name string) (*github.RegistrationToken, error)

GetRegistrationToken returns a registration token tied with the name of repository and runner.

func (*Client) IsRunnerBusy

func (r *Client) IsRunnerBusy(ctx context.Context, enterprise, org, repo, name string) (bool, error)

func (*Client) ListRepositoryWorkflowRuns

func (c *Client) ListRepositoryWorkflowRuns(ctx context.Context, user string, repoName string) ([]*github.WorkflowRun, error)

func (*Client) ListRunners

func (c *Client) ListRunners(ctx context.Context, enterprise, org, repo string) ([]*github.Runner, error)

ListRunners returns a list of runners of specified owner/repository name.

func (*Client) RemoveRunner

func (c *Client) RemoveRunner(ctx context.Context, enterprise, org, repo string, runnerID int64) error

RemoveRunner removes a runner with specified runner ID from repository.

type Config

type Config struct {
	EnterpriseURL     string `split_words:"true"`
	AppID             int64  `split_words:"true"`
	AppInstallationID int64  `split_words:"true"`
	AppPrivateKey     string `split_words:"true"`
	Token             string
}

Config contains configuration for Github client

func (*Config) NewClient

func (c *Config) NewClient() (*Client, error)

NewClient creates a Github Client

type RunnerNotFound

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

func (*RunnerNotFound) Error

func (e *RunnerNotFound) Error() string

type RunnerOffline

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

func (*RunnerOffline) Error

func (e *RunnerOffline) Error() string