GitLab can trigger events with well configured webhooks. When that event occurs, the source app makes an HTTP request to the URI configured for the webhook, you can use the Crystal HTTP class to manage that. The action taken may be anything... Common uses are to trigger builds with continuous integration systems or to notify deployments.
Docs Generated in latest commit.
- Add the dependency to your
dependencies: gitlab-webhooks: github: chussenot/gitlab-webhooks version: 0.3.3
You just have to require the lib.
The Crystal language is new ... Crystal has downsides just like every other languages. To relay the catched Gitlab events on hundreds of Ruby, Python libraries made by thousands of open source contributors over the last decade or monitoring systems like Prometheus, few examples can be find below. You can contribute and add your example in the
This Crystal example show you how to implement where all endpoints can catch some events, parse them and print the values of some attributes.
require "json" require "http/server" require "gitlab-webhooks" server = HTTP::Server.new do |context| if body = context.request.body event : Gitlab::Event = Gitlab.event_from(JSON.parse(body).to_json.to_s) puts event.commit.message context.response.content_type = "text/plain" context.response.print "Hello world!" else context.response.print "You didn't POST any data :(" end end server.bind_tcp 8080 puts "Listening on http://0.0.0.0:8080" server.listen
Then you can curl the server with a sample file
curl -X POST --data @data.json http://localhost:8080/
- How to add a GitLab project hook documentation
- The Rake task to add a project hooks
- The Grape API endpoint implementation
- Fork it (https://github.com/chussenot/gitlab-webhooks.cr/fork)
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request
- Clement - creator and maintainer
- about 2 years ago
- April 3, 2019
Thu, 13 May 2021 12:16:57 GMT