Categorygithub.com/ldez/ghwebhook/v3
modulepackage
3.0.0
Repository: https://github.com/ldez/ghwebhook.git
Documentation: pkg.go.dev

# README

GHWebHook

release Build Status PkgGoDev

Sponsor

Create a Github WebHook in 5 seconds!

Description

  • Default port: 80
  • Default path: /postreceive
  • Default event type: push

Examples

Basic:

package main

import (
	"log"
	"net/url"

	"github.com/google/go-github/v44/github"
	ghw "github.com/ldez/ghwebhook/v3"
)

func main() {
	eventHandlers := ghw.NewEventHandlers().
		OnIssues(func(uri *url.URL, event *github.IssuesEvent) {
			go func() {
				log.Println(uri, event.GetAction(), event.Issue)
			}()
		}).
		OnPullRequest(func(uri *url.URL, event *github.PullRequestEvent) {
			log.Println(uri, event.GetAction(), event.GetNumber(), event.PullRequest)
		})

	webHook := ghw.NewWebHook(eventHandlers, ghw.WithAllEventTypes)

	err := webHook.ListenAndServe()
	if err != nil {
		log.Fatal(err)
	}
}

Secured WebHook with custom port and path:

package main

import (
	"log"
	"net/url"

	"github.com/google/go-github/v44/github"
	ghw "github.com/ldez/ghwebhook/v3"
	"github.com/ldez/ghwebhook/v3/eventtype"
)

func main() {
	eventHandlers := ghw.NewEventHandlers().
		OnIssues(func(uri *url.URL, event *github.IssuesEvent) {
			go func() {
				log.Println(uri, event.GetAction(), event.Issue)
			}()
		}).
		OnPullRequest(func(uri *url.URL, event *github.PullRequestEvent) {
			log.Println(uri, event.GetAction(), event.GetNumber(), event.PullRequest)
		})

	webhook := ghw.NewWebHook(
		eventHandlers,
		ghw.WithPort(5000),
		ghw.WithPath("/github"),
		ghw.WithSecret("SECRET"),
		ghw.Debug,
		ghw.WithEventTypes(eventtype.Issues, eventtype.PullRequest))

	err := webhook.ListenAndServe()
	if err != nil {
		log.Fatal(err)
	}
}

References

# Packages

No description provided by the author

# Functions

Debug activate debug mode.
NewEventHandlers create a new event handlers.
NewWebHook create a new server as a GitHub WebHook.
WithAllEventTypes accept all possible event types.
WithEventTypes define accepted event types.
WithPath define the HTTP handler path.
WithPort define the server port.
WithSecret define the GitHub secret.

# Structs

EventHandlers all event handlers.
WebHook server.