diff --git a/README.md b/README.md index 0ac6c51..42b8585 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ Library webhooks ================ - -![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) -[![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) -[![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) Library webhooks allows for easy recieving and parsing of GitHub & Bitbucket Webhook Events @@ -24,20 +24,18 @@ Installation Use go get. - go get gopkg.in/go-playground/webhooks.v1 - -or to update - - go get -u gopkg.in/go-playground/webhooks.v1 +```shell + go get -u gopkg.in/go-playground/webhooks.v2 +``` 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 ------ -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: @@ -49,8 +47,8 @@ import ( "fmt" "strconv" - "gopkg.in/go-playground/webhooks.v1" - "gopkg.in/go-playground/webhooks.v1/github" + "gopkg.in/go-playground/webhooks.v2" + "gopkg.in/go-playground/webhooks.v2/github" ) const ( @@ -59,6 +57,7 @@ const ( ) func main() { + hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"}) hook.RegisterEvents(HandleRelease, github.ReleaseEvent) hook.RegisterEvents(HandlePullRequest, github.PullRequestEvent) @@ -95,6 +94,7 @@ func HandlePullRequest(payload interface{}, header webhooks.Header) { // Do whatever you want from here... fmt.Printf("%+v", pl) } + ``` Single receiver for events you subscribe to @@ -105,8 +105,8 @@ import ( "fmt" "strconv" - "gopkg.in/go-playground/webhooks.v1" - "gopkg.in/go-playground/webhooks.v1/github" + "gopkg.in/go-playground/webhooks.v2" + "gopkg.in/go-playground/webhooks.v2/github" ) const ( @@ -115,6 +115,7 @@ const ( ) func main() { + hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"}) hook.RegisterEvents(HandleMultiple, github.ReleaseEvent, github.PullRequestEvent) // Add as many as you want diff --git a/bitbucket/bitbucket.go b/bitbucket/bitbucket.go index 961630b..754307c 100644 --- a/bitbucket/bitbucket.go +++ b/bitbucket/bitbucket.go @@ -5,7 +5,7 @@ import ( "io/ioutil" "net/http" - "gopkg.in/go-playground/webhooks.v1" + "gopkg.in/go-playground/webhooks.v2" ) // Webhook instance contains all methods needed to process events diff --git a/bitbucket/bitbucket_test.go b/bitbucket/bitbucket_test.go index da2b1c2..88134eb 100644 --- a/bitbucket/bitbucket_test.go +++ b/bitbucket/bitbucket_test.go @@ -9,7 +9,7 @@ import ( "time" . "gopkg.in/go-playground/assert.v1" - "gopkg.in/go-playground/webhooks.v1" + "gopkg.in/go-playground/webhooks.v2" ) // NOTES: diff --git a/examples/multiple-handlers/main.go b/examples/multiple-handlers/main.go index d1524d9..89f91b1 100644 --- a/examples/multiple-handlers/main.go +++ b/examples/multiple-handlers/main.go @@ -4,8 +4,8 @@ import ( "fmt" "strconv" - "gopkg.in/go-playground/webhooks.v1" - "gopkg.in/go-playground/webhooks.v1/github" + "gopkg.in/go-playground/webhooks.v2" + "gopkg.in/go-playground/webhooks.v2/github" ) const ( @@ -14,6 +14,7 @@ const ( ) func main() { + hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"}) hook.RegisterEvents(HandleRelease, github.ReleaseEvent) hook.RegisterEvents(HandlePullRequest, github.PullRequestEvent) diff --git a/examples/single-handler/main.go b/examples/single-handler/main.go index 484211c..e637476 100644 --- a/examples/single-handler/main.go +++ b/examples/single-handler/main.go @@ -4,8 +4,8 @@ import ( "fmt" "strconv" - "gopkg.in/go-playground/webhooks.v1" - "gopkg.in/go-playground/webhooks.v1/github" + "gopkg.in/go-playground/webhooks.v2" + "gopkg.in/go-playground/webhooks.v2/github" ) const ( @@ -14,6 +14,7 @@ const ( ) func main() { + hook := github.New(&github.Config{Secret: "MyGitHubSuperSecretSecrect...?"}) hook.RegisterEvents(HandleMultiple, github.ReleaseEvent, github.PullRequestEvent) // Add as many as you want diff --git a/github/github.go b/github/github.go index 5790e77..c46dce8 100644 --- a/github/github.go +++ b/github/github.go @@ -8,7 +8,7 @@ import ( "io/ioutil" "net/http" - "gopkg.in/go-playground/webhooks.v1" + "gopkg.in/go-playground/webhooks.v2" ) // Webhook instance contains all methods needed to process events diff --git a/github/github_test.go b/github/github_test.go index 7bde7a4..2a06816 100644 --- a/github/github_test.go +++ b/github/github_test.go @@ -9,7 +9,7 @@ import ( "time" . "gopkg.in/go-playground/assert.v1" - "gopkg.in/go-playground/webhooks.v1" + "gopkg.in/go-playground/webhooks.v2" ) // NOTES: