probot

package

v0.0.0-...-99e6061 Latest Latest Go to latest Published: Sep 9, 2020 License: ISC Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func NewEnterpriseClient(app *App, installation Installation) (*github.Client, error)

NewEnterpriseClient instantiates a new GitHub Client using the App and Installation

func NewMiddleware() mux.MiddlewareFunc

NewMiddleware returns a mux.MiddlewareFunc encapsulating Probot features

type App struct {
	BaseURL string
	ID      int64
	Key     []byte
	Secret  string
}

App encapsulates the fields needed to define a GitHub App

func NewApp() *App

NewApp instantiates a GitHub App from environment variables

type Context struct {
	App     *App
	Payload interface{}
	GitHub  *github.Client
}

Context encapsulates the fields passed to webhook handlers

func FromContext(context ctx.Context) (*Context, bool)

FromContext exposes probot features to request handlers

func NewContext(app *App) *Context

NewContext instantiates a new context

type Installation struct {
	ID int64
}

Installation encapsulates the fields needed to define an installation of a GitHub App

type PayloadInstallation struct {
	Installation *github.Installation `json:"installation"`
}

PayloadInstallation represents the incoming installation part of the payload