cursorius/webhooks
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

cleanup imports + README for v2

Browse Source
This commit is contained in:
Dean Karn
2016-10-20 19:51:20 -04:00
parent 60d6ca11e3
commit 1e0ece40df
7 changed files with 26 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -15
View File
@@ -1,11 +1,11 @@
Library webhooks Library webhooks
================ ================
<img align="right" src="https://raw.githubusercontent.com/go-playground/webhooks/v1/logo.png"> <img align="right" src="https://raw.githubusercontent.com/go-playground/webhooks/v2/logo.png">
![Project status](https://img.shields.io/badge/version-1.0-green.svg) ![Project status](https://img.shields.io/badge/version-2.0.0-green.svg)
[![Build Status](https://semaphoreci.com/api/v1/projects/5b9e2eda-8f8d-40aa-8cb4-e3f6120171fe/587820/badge.svg)](https://semaphoreci.com/joeybloggs/webhooks) [![Build Status](https://semaphoreci.com/api/v1/projects/5b9e2eda-8f8d-40aa-8cb4-e3f6120171fe/587820/badge.svg)](https://semaphoreci.com/joeybloggs/webhooks)
[![Coverage Status](https://coveralls.io/repos/go-playground/webhooks/badge.svg?branch=v1&service=github)](https://coveralls.io/github/go-playground/webhooks?branch=v1) [![Coverage Status](https://coveralls.io/repos/go-playground/webhooks/badge.svg?branch=v2&service=github)](https://coveralls.io/github/go-playground/webhooks?branch=v2)
[![Go Report Card](https://goreportcard.com/badge/go-playground/webhooks)](https://goreportcard.com/report/go-playground/webhooks) [![Go Report Card](https://goreportcard.com/badge/go-playground/webhooks)](https://goreportcard.com/report/go-playground/webhooks)
[![GoDoc](https://godoc.org/gopkg.in/go-playground/webhooks.v1?status.svg)](https://godoc.org/gopkg.in/go-playground/webhooks.v1) [![GoDoc](https://godoc.org/gopkg.in/go-playground/webhooks.v2?status.svg)](https://godoc.org/gopkg.in/go-playground/webhooks.v2)
![License](https://img.shields.io/dub/l/vibe-d.svg) ![License](https://img.shields.io/dub/l/vibe-d.svg)
Library webhooks allows for easy recieving and parsing of GitHub & Bitbucket Webhook Events Library webhooks allows for easy recieving and parsing of GitHub & Bitbucket Webhook Events
@@ -24,20 +24,18 @@ Installation
Use go get. Use go get.
go get gopkg.in/go-playground/webhooks.v1 ```shell
go get -u gopkg.in/go-playground/webhooks.v2
or to update ```
go get -u gopkg.in/go-playground/webhooks.v1
Then import the validator package into your own code. Then import the validator package into your own code.
import "gopkg.in/go-playground/webhooks.v1" import "gopkg.in/go-playground/webhooks.v2"
Usage and documentation Usage and documentation
------ ------
Please see http://godoc.org/gopkg.in/go-playground/webhooks.v1 for detailed usage docs. Please see http://godoc.org/gopkg.in/go-playground/webhooks.v2 for detailed usage docs.
##### Examples: ##### Examples:
@@ -49,8 +47,8 @@ import (
"fmt" "fmt"
"strconv" "strconv"
"gopkg.in/go-playground/webhooks.v1" "gopkg.in/go-playground/webhooks.v2"
"gopkg.in/go-playground/webhooks.v1/github" "gopkg.in/go-playground/webhooks.v2/github"
) )
const ( const (
@@ -59,6 +57,7 @@ const (
) )
func main() { func main() {
hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"}) hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"})
hook.RegisterEvents(HandleRelease, github.ReleaseEvent) hook.RegisterEvents(HandleRelease, github.ReleaseEvent)
hook.RegisterEvents(HandlePullRequest, github.PullRequestEvent) hook.RegisterEvents(HandlePullRequest, github.PullRequestEvent)
@@ -95,6 +94,7 @@ func HandlePullRequest(payload interface{}, header webhooks.Header) {
// Do whatever you want from here... // Do whatever you want from here...
fmt.Printf("%+v", pl) fmt.Printf("%+v", pl)
} }
``` ```
Single receiver for events you subscribe to Single receiver for events you subscribe to
@@ -105,8 +105,8 @@ import (
"fmt" "fmt"
"strconv" "strconv"
"gopkg.in/go-playground/webhooks.v1" "gopkg.in/go-playground/webhooks.v2"
"gopkg.in/go-playground/webhooks.v1/github" "gopkg.in/go-playground/webhooks.v2/github"
) )
const ( const (
@@ -115,6 +115,7 @@ const (
) )
func main() { func main() {
hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"}) hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"})
hook.RegisterEvents(HandleMultiple, github.ReleaseEvent, github.PullRequestEvent) // Add as many as you want hook.RegisterEvents(HandleMultiple, github.ReleaseEvent, github.PullRequestEvent) // Add as many as you want
bitbucket/bitbucket.go
+1 -1
View File
@@ -5,7 +5,7 @@ import (
"io/ioutil" "io/ioutil"
"net/http" "net/http"
"gopkg.in/go-playground/webhooks.v1" "gopkg.in/go-playground/webhooks.v2"
) )
// Webhook instance contains all methods needed to process events // Webhook instance contains all methods needed to process events
bitbucket/bitbucket_test.go
+1 -1
View File
@@ -9,7 +9,7 @@ import (
"time" "time"
. "gopkg.in/go-playground/assert.v1" . "gopkg.in/go-playground/assert.v1"
"gopkg.in/go-playground/webhooks.v1" "gopkg.in/go-playground/webhooks.v2"
) )
// NOTES: // NOTES:
examples/multiple-handlers/main.go
+3 -2
View File
@@ -4,8 +4,8 @@ import (
"fmt" "fmt"
"strconv" "strconv"
"gopkg.in/go-playground/webhooks.v1" "gopkg.in/go-playground/webhooks.v2"
"gopkg.in/go-playground/webhooks.v1/github" "gopkg.in/go-playground/webhooks.v2/github"
) )
const ( const (
@@ -14,6 +14,7 @@ const (
) )
func main() { func main() {
hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"}) hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"})
hook.RegisterEvents(HandleRelease, github.ReleaseEvent) hook.RegisterEvents(HandleRelease, github.ReleaseEvent)
hook.RegisterEvents(HandlePullRequest, github.PullRequestEvent) hook.RegisterEvents(HandlePullRequest, github.PullRequestEvent)
examples/single-handler/main.go
+3 -2
View File
@@ -4,8 +4,8 @@ import (
"fmt" "fmt"
"strconv" "strconv"
"gopkg.in/go-playground/webhooks.v1" "gopkg.in/go-playground/webhooks.v2"
"gopkg.in/go-playground/webhooks.v1/github" "gopkg.in/go-playground/webhooks.v2/github"
) )
const ( const (
@@ -14,6 +14,7 @@ const (
) )
func main() { func main() {
hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"}) hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"})
hook.RegisterEvents(HandleMultiple, github.ReleaseEvent, github.PullRequestEvent) // Add as many as you want hook.RegisterEvents(HandleMultiple, github.ReleaseEvent, github.PullRequestEvent) // Add as many as you want
github/github.go
+1 -1
View File
@@ -8,7 +8,7 @@ import (
"io/ioutil" "io/ioutil"
"net/http" "net/http"
"gopkg.in/go-playground/webhooks.v1" "gopkg.in/go-playground/webhooks.v2"
) )
// Webhook instance contains all methods needed to process events // Webhook instance contains all methods needed to process events
github/github_test.go
+1 -1
View File
@@ -9,7 +9,7 @@ import (
"time" "time"
. "gopkg.in/go-playground/assert.v1" . "gopkg.in/go-playground/assert.v1"
"gopkg.in/go-playground/webhooks.v1" "gopkg.in/go-playground/webhooks.v2"
) )
// NOTES: // NOTES: