https://github.com/flc1125/go-gitlab-webhook
🚀 A lightweight Gitlab webhook dispatcher for efficient event handling
https://github.com/flc1125/go-gitlab-webhook
dispatcher event gitlab golang webhook
Last synced: 19 days ago
JSON representation
🚀 A lightweight Gitlab webhook dispatcher for efficient event handling
- Host: GitHub
- URL: https://github.com/flc1125/go-gitlab-webhook
- Owner: flc1125
- License: mit
- Created: 2024-08-19T11:48:50.000Z (almost 2 years ago)
- Default Branch: 3.x
- Last Pushed: 2026-05-02T15:04:20.000Z (19 days ago)
- Last Synced: 2026-05-02T16:27:36.350Z (19 days ago)
- Topics: dispatcher, event, gitlab, golang, webhook
- Language: Go
- Homepage: https://github.com/flc1125/go-gitlab-webhook
- Size: 581 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Gitlab Webhook Dispatcher 🚀
[](https://github.com/flc1125/go-gitlab-webhook/releases)
[](https://pkg.go.dev/github.com/flc1125/go-gitlab-webhook/v3)
[](https://codecov.io/gh/flc1125/go-gitlab-webhook)
[](https://goreportcard.com/report/github.com/flc1125/go-gitlab-webhook)
[](https://github.com/flc1125/go-gitlab-webhook/actions/workflows/ci.yml)
[](https://github.com/flc1125/go-gitlab-webhook/actions/workflows/test.yml)
[](https://opensource.org/licenses/MIT)
This is a simple webhook dispatcher for Gitlab. It listens for incoming webhooks and dispatches them to the appropriate handler.
## ✨ Features
- 📋 Very convenient registration of listeners
- 🔄 A single listener can implement multiple different webhook functions
- ⚡ Support asynchronous and efficient processing
- 🚀 Multiple dispatch methods
- 🔐 Token validation support for secure webhook handling
## 📦 Installation
```shell
go get github.com/flc1125/go-gitlab-webhook/v3
```
## 🔗 Compatibility
| go-gitlab-webhook | GitLab Go Client |
| --- | --- |
| `1.x` | [xanzy/go-gitlab](https://github.com/xanzy/go-gitlab) |
| `2.x` | [gitlab-org/api/client-go](https://gitlab.com/gitlab-org/api/client-go) |
| `3.x` | [gitlab-org/api/client-go/v2](https://gitlab.com/gitlab-org/api/client-go/v2) |
## 💻 Usage
```go
package main
import (
"context"
"log"
"net/http"
"github.com/flc1125/go-gitlab-webhook/v3"
"gitlab.com/gitlab-org/api/client-go/v2"
)
var (
_ gitlabwebhook.BuildListener = (*testBuildListener)(nil)
_ gitlabwebhook.CommitCommentListener = (*testCommitCommentListener)(nil)
_ gitlabwebhook.BuildListener = (*testBuildAndCommitCommentListener)(nil)
_ gitlabwebhook.CommitCommentListener = (*testBuildAndCommitCommentListener)(nil)
)
type testBuildListener struct{}
func (l *testBuildListener) OnBuild(ctx context.Context, event *gitlab.BuildEvent) error {
// do something
return nil
}
type testCommitCommentListener struct{}
func (l *testCommitCommentListener) OnCommitComment(ctx context.Context, event *gitlab.CommitCommentEvent) error {
// do something
return nil
}
type testBuildAndCommitCommentListener struct{}
func (l *testBuildAndCommitCommentListener) OnBuild(ctx context.Context, event *gitlab.BuildEvent) error {
// do something
return nil
}
func (l *testBuildAndCommitCommentListener) OnCommitComment(ctx context.Context, event *gitlab.CommitCommentEvent) error {
// do something
return nil
}
func main() {
dispatcher := gitlabwebhook.NewDispatcher(
gitlabwebhook.RegisterListeners(
&testBuildListener{},
&testCommitCommentListener{},
&testBuildAndCommitCommentListener{},
),
gitlabwebhook.WithMiddlewares(
loggingMiddleware,
// Only runs for push events.
gitlabwebhook.MiddlewareForEvent(func(ctx context.Context, event *gitlab.PushEvent) error {
log.Printf("push event: %s", event.Project.PathWithNamespace)
return nil
}),
),
)
dispatcher.RegisterListeners(
&testBuildListener{},
&testCommitCommentListener{},
&testBuildAndCommitCommentListener{},
)
http.Handle("/webhook", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if err := dispatcher.DispatchRequest(r,
gitlabwebhook.DispatchRequestWithToken("your-secret-token"), // validate token, if needed
gitlabwebhook.DispatchRequestWithContext(context.Background()), // custom context
gitlabwebhook.DispatchRequestWithMaxBodyBytes(10<<20), // limit payload size to 10 MiB
); err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.WriteHeader(http.StatusNoContent)
}))
if err := http.ListenAndServe(":8080", nil); err != nil {
panic(err)
}
}
func loggingMiddleware(next gitlabwebhook.HandlerFunc) gitlabwebhook.HandlerFunc {
return func(ctx context.Context, event any) error {
log.Printf("received webhook event: %T", event)
return next(ctx, event)
}
}
```
## 🔐 Security Notes
If your webhook endpoint is exposed publicly, limit request body size before parsing payloads. You can use `DispatchRequestWithMaxBodyBytes` when calling `DispatchRequest`, or enforce an equivalent limit in your HTTP server or reverse proxy.
## 📜 License
MIT License. See [LICENSE](LICENSE) for the full license text.
## 💖 Thanks
- [gitlab-org/api/client-go](https://gitlab.com/gitlab-org/api/client-go)(Formerly known as: [xanzy/go-gitlab](https://github.com/xanzy/go-gitlab)): Go library for accessing the GitLab API
- [stretchr/testify](github.com/stretchr/testify): A toolkit with common assertions and mocks that plays nicely with the standard library