githubclient

Documentation

Index

• func IsExecution(err error) bool
• func IsInstallationNotFound(err error) bool
• func IsInvalidConfig(err error) bool
• func IsNotFound(err error) bool
• type Client
  • func New(config Config) (*Client, error)
  • func (c *Client) AddRepoToRenovatePermissions(ctx context.Context, org string, repo *github.Repository) error
  • func (c *Client) GetFile(ctx context.Context, owner, repo, path, ref string) (RepositoryFile, error)
  • func (c *Client) GetRepository(ctx context.Context, owner, repo string) (*github.Repository, error)
  • func (c *Client) ListRepositories(ctx context.Context, owner string) ([]Repository, error)
  • func (c *Client) RemoveRepoFromRenovatePermissions(ctx context.Context, org string, repo *github.Repository) error
  • func (c *Client) RemoveRepositoryBranchProtection(ctx context.Context, repository *github.Repository) (err error)
  • func (c *Client) SetRepositoryBranchProtection(ctx context.Context, repository *github.Repository, checkNames []string, ...) (err error)
  • func (c *Client) SetRepositoryDefaultBranch(ctx context.Context, repository *github.Repository, newDefaultBranch string) (err error)
  • func (c *Client) SetRepositoryPermissions(ctx context.Context, repository *github.Repository, ...) error
  • func (c *Client) SetRepositorySettings(ctx context.Context, repository, repositorySettings *github.Repository) (*github.Repository, error)
  • func (c *Client) SetRepositoryWebhooks(ctx context.Context, repository *github.Repository, hook *github.Hook) error
• type Config
• type Repository
• type RepositoryFile

Functions

func IsExecution

func IsExecution(err error) bool

IsExecution asserts executionError.

func IsInstallationNotFound

func IsInstallationNotFound(err error) bool

IsInstallationNotFound asserts installationNotFoundError.

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound asserts notFoundError.

Types

type Client

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

func New

func New(config Config) (*Client, error)

func (*Client) AddRepoToRenovatePermissions

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

Add repository to the Renovate installation. Corresponds to https://docs.github.com/en/rest/apps/installations?apiVersion=2022-11-28#add-a-repository-to-an-app-installation

func (*Client) GetFile

func (c *Client) GetFile(ctx context.Context, owner, repo, path, ref string) (RepositoryFile, error)

func (*Client) GetRepository

func (c *Client) GetRepository(ctx context.Context, owner, repo string) (*github.Repository, error)

func (*Client) ListRepositories

func (c *Client) ListRepositories(ctx context.Context, owner string) ([]Repository, error)

func (*Client) RemoveRepoFromRenovatePermissions

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

Remove repository from the Renovate installation. Corresponds to https://docs.github.com/en/rest/apps/installations?apiVersion=2022-11-28#remove-a-repository-from-an-app-installation

func (*Client) RemoveRepositoryBranchProtection

func (c *Client) RemoveRepositoryBranchProtection(ctx context.Context, repository *github.Repository) (err error)

func (*Client) SetRepositoryBranchProtection

func (c *Client) SetRepositoryBranchProtection(ctx context.Context, repository *github.Repository, checkNames []string, checksFilter *regexp.Regexp) (err error)

func (*Client) SetRepositoryDefaultBranch

func (c *Client) SetRepositoryDefaultBranch(ctx context.Context, repository *github.Repository, newDefaultBranch string) (err error)

func (*Client) SetRepositoryPermissions

func (c *Client) SetRepositoryPermissions(ctx context.Context, repository *github.Repository, permissions map[string]string) error

func (*Client) SetRepositorySettings

func (c *Client) SetRepositorySettings(ctx context.Context, repository, repositorySettings *github.Repository) (*github.Repository, error)

func (*Client) SetRepositoryWebhooks

func (c *Client) SetRepositoryWebhooks(ctx context.Context, repository *github.Repository, hook *github.Hook) error

type Config

type Config struct {
	DryRun bool
	Logger *logrus.Logger

	AccessToken string
}

type Repository

type Repository struct {
	Name      string
	Language  string
	Owner     string
	UpdatedAt time.Time
}

type RepositoryFile

type RepositoryFile struct {
	Data []byte
	Path string
}