pull

package module

v0.0.0-...-425d40c Latest Latest Go to latest Published: Sep 24, 2015 License: MIT Imports: 9 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

Repository

github.com/hansrodtang/pull

Links

Open Source Insights

README ¶

Pull

A pull request checker library for Go.

❗ Still in heavy development. Not everything in this document is accurate. Please wait for the 0.1 release ❗

Example

handler := pull.New(
    pull.Configuration{
        Middlewares: pull.Middlewares{
            "reopened": {
                signed.Signed,
                changelog.New("CHANGELOG.md")},
            "opened": {
                deny.New("We do not accept pull requests!")}},
    })

http.Handle("/webhook", handler)
log.Fatal(http.ListenAndServe(":8080", nil))

Installation

Install with go get

  go get github.com/hansrodtang/pull

For those who prefer stable releases, you can also use gopkg.in:

  go get gopkg.in/hansrodtang/pull.v0

License

This software is licensed under the MIT license.

Documentation ¶

Index ¶

func Data(req *github.PullRequest) (user string, repository string, number int)
func Failure(url string, desc string, c string) *github.RepoStatus
func Success(url string, desc string, c string) *github.RepoStatus
type Configuration
type Handler
- func New(c Configuration) *Handler
- func (l *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)
type Middleware
type Middlewares

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Data ¶

func Data(req *github.PullRequest) (user string, repository string, number int)

func Failure ¶

func Failure(url string, desc string, c string) *github.RepoStatus

func Success ¶

func Success(url string, desc string, c string) *github.RepoStatus

Types ¶

type Configuration ¶

type Configuration struct {
	Client      *http.Client
	Middlewares Middlewares
	Secret      string
}

type Handler ¶

type Handler struct {
	Client *github.Client
	*Configuration
}

func New ¶

func New(c Configuration) *Handler

func (*Handler) ServeHTTP ¶

func (l *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)

type Middleware ¶

type Middleware func(*github.Client, *github.PullRequest)

type Middlewares ¶

type Middlewares map[string][]Middleware

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
handlers
changelog
cla
deny
signed

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