github

package

v0.0.21 Latest Latest Go to latest Published: Jan 19, 2023 License: MPL-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/leg100/otf

Links

Open Source Insights

Documentation ¶

Overview ¶

Package github provides github related code

Index ¶

Constants
func Defaults() cloud.Config
func HandleEvent(w http.ResponseWriter, r *http.Request, opts cloud.HandleEventOptions) cloud.VCSEvent
func NewEnterpriseClient(hostname string, httpClient *http.Client) (*github.Client, error)
func OAuthDefaults() *oauth2.Config
type Client
- func NewClient(ctx context.Context, cfg cloud.ClientOptions) (*Client, error)
type Cloud
- func (Cloud) HandleEvent(w http.ResponseWriter, r *http.Request, opts cloud.HandleEventOptions) cloud.VCSEvent
- func (g *Cloud) NewClient(ctx context.Context, opts cloud.ClientOptions) (cloud.Client, error)
type TestServer
- func NewTestServer(t *testing.T, opts ...TestServerOption) *TestServer
type TestServerOption

Constants ¶

View Source

const (
	DefaultGithubHostname string = "github.com"
)

Variables ¶

This section is empty.

Functions ¶

func Defaults ¶

func Defaults() cloud.Config

func HandleEvent ¶

func HandleEvent(w http.ResponseWriter, r *http.Request, opts cloud.HandleEventOptions) cloud.VCSEvent

HandleEvent handles incoming events from github

func NewEnterpriseClient ¶

func NewEnterpriseClient(hostname string, httpClient *http.Client) (*github.Client, error)

func OAuthDefaults ¶

func OAuthDefaults() *oauth2.Config

Types ¶

type Client ¶

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

func NewClient ¶

func NewClient(ctx context.Context, cfg cloud.ClientOptions) (*Client, error)

func (*Client) CreateWebhook ¶

func (g *Client) CreateWebhook(ctx context.Context, opts cloud.CreateWebhookOptions) (string, error)

CreateWebhook creates a webhook on a github repository.

func (*Client) DeleteWebhook ¶

func (g *Client) DeleteWebhook(ctx context.Context, opts cloud.DeleteWebhookOptions) error

func (*Client) GetRepoTarball ¶

func (g *Client) GetRepoTarball(ctx context.Context, topts cloud.GetRepoTarballOptions) ([]byte, error)

func (*Client) GetRepository ¶

func (g *Client) GetRepository(ctx context.Context, identifier string) (cloud.Repo, error)

func (*Client) GetUser ¶

func (g *Client) GetUser(ctx context.Context) (*cloud.User, error)

func (*Client) GetWebhook ¶

func (g *Client) GetWebhook(ctx context.Context, opts cloud.GetWebhookOptions) (cloud.Webhook, error)

func (*Client) ListRepositories ¶

func (g *Client) ListRepositories(ctx context.Context, opts cloud.ListRepositoriesOptions) ([]cloud.Repo, error)

func (g *Client) ListTags(ctx context.Context, opts cloud.ListTagsOptions) ([]string, error)

func (*Client) SetStatus ¶

func (g *Client) SetStatus(ctx context.Context, opts cloud.SetStatusOptions) error

func (*Client) UpdateWebhook ¶

func (g *Client) UpdateWebhook(ctx context.Context, opts cloud.UpdateWebhookOptions) error

type Cloud ¶

type Cloud struct{}

func (Cloud) HandleEvent ¶

func (Cloud) HandleEvent(w http.ResponseWriter, r *http.Request, opts cloud.HandleEventOptions) cloud.VCSEvent

func (*Cloud) NewClient ¶

func (g *Cloud) NewClient(ctx context.Context, opts cloud.ClientOptions) (cloud.Client, error)

type TestServer ¶

type TestServer struct {
	WebhookURL    *string // populated once a webhook is created
	WebhookSecret *string // populated once a webhook is created

	*httptest.Server
	// contains filtered or unexported fields
}

func NewTestServer ¶

func NewTestServer(t *testing.T, opts ...TestServerOption) *TestServer

type TestServerOption ¶

type TestServerOption func(*TestServer)

func WithArchive ¶

func WithArchive(tarball []byte) TestServerOption

func WithRefs ¶

func WithRefs(refs ...string) TestServerOption

func WithRepo ¶

func WithRepo(repo cloud.Repo) TestServerOption

func WithStatusCallback ¶

func WithStatusCallback(callback statusCallback) TestServerOption

func WithUser ¶

func WithUser(user *cloud.User) TestServerOption

Source Files ¶

View all Source files

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