githubapp

package
v0.1.0-alpha.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 10, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrNotFound = errors.New("github resource not found")

Functions

This section is empty.

Types

type Client

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

func New

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

func (*Client) Archive

func (c *Client) Archive(ctx context.Context, installationID, repositoryID int64, commitSHA string, destination io.Writer) error

func (*Client) Commit

func (c *Client) Commit(ctx context.Context, installationID, repositoryID int64, ref string) (domain.CommitMetadata, error)

func (*Client) DeleteInstallation

func (c *Client) DeleteInstallation(ctx context.Context, installationID int64) error

func (*Client) Installation

func (c *Client) Installation(ctx context.Context, installationID int64) (Installation, error)

func (*Client) InstallationURL

func (c *Client) InstallationURL(state string) string

func (*Client) Repositories

func (c *Client) Repositories(ctx context.Context, installationID int64) ([]domain.GitHubRepository, error)

func (*Client) ResolveCommit

func (c *Client) ResolveCommit(ctx context.Context, installationID, repositoryID int64, ref string) (string, error)

func (*Client) UserAuthorizationURL

func (c *Client) UserAuthorizationURL(state string) string

func (*Client) UserCanAccessInstallation

func (c *Client) UserCanAccessInstallation(ctx context.Context, code string, installationID int64) (allowed bool, resultErr error)

type Config

type Config struct {
	AppID        int64
	Slug         string
	ClientID     string
	ClientSecret string
	PrivateKey   []byte
	CallbackURL  string
	APIBaseURL   string
	WebBaseURL   string
	HTTPClient   *http.Client
	Now          func() time.Time
}

type Installation

type Installation struct {
	ID                  int64
	AccountID           int64
	AccountLogin        string
	AccountType         string
	RepositorySelection string
}

type Service

type Service interface {
	InstallationURL(state string) string
	UserAuthorizationURL(state string) string
	Installation(context.Context, int64) (Installation, error)
	UserCanAccessInstallation(context.Context, string, int64) (bool, error)
	Repositories(context.Context, int64) ([]domain.GitHubRepository, error)
	ResolveCommit(context.Context, int64, int64, string) (string, error)
	Commit(context.Context, int64, int64, string) (domain.CommitMetadata, error)
	Archive(context.Context, int64, int64, string, io.Writer) error
	DeleteInstallation(context.Context, int64) error
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL