Documentation
¶
Overview ¶
Package github adapts GitHub (cloud or enterprise) to the platform interface: org webhook parsing and repo discovery.
Index ¶
- type GitHub
- func (g *GitHub) AllowsRepo(fullName string) bool
- func (g *GitHub) DiscoverRepos(ctx context.Context) ([]platform.Repo, error)
- func (g *GitHub) Name() string
- func (g *GitHub) ParseWebhook(r *http.Request, body []byte) (*platform.Event, error)
- func (g *GitHub) Schedule() config.Schedule
- func (g *GitHub) WebhookPath() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GitHub ¶
type GitHub struct {
// contains filtered or unexported fields
}
GitHub implements platform.Platform for github.com or GitHub Enterprise.
func (*GitHub) AllowsRepo ¶ added in v0.5.0
AllowsRepo reports whether the repo is inside the configured orgs.
func (*GitHub) DiscoverRepos ¶
DiscoverRepos lists all repos of the configured orgs, honoring the archived filter.
func (*GitHub) ParseWebhook ¶
ParseWebhook verifies the HMAC signature and maps supported events (edited PR/issue with newly checked boxes, default-branch push) to a run request; unsupported or irrelevant events return (nil, nil).
func (*GitHub) WebhookPath ¶
WebhookPath returns the HTTP path this platform's webhooks arrive on.
Source Files
Click to show internal directories.
Click to hide internal directories.