Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ischeme4u/sc-gitlab-webhook

A simple Gitlab WebHook
https://github.com/ischeme4u/sc-gitlab-webhook

gitlab webhooks

Last synced: about 2 months ago
JSON representation

A simple Gitlab WebHook

Awesome Lists containing this project

README

        

.. image:: https://badge.fury.io/py/sc-gitlab-webhook.svg
:target: https://badge.fury.io/py/sc-gitlab-webhook
.. image:: https://img.shields.io/pypi/pyversions/sc-gitlab-webhook
:alt: PyPI - Python Version

A simple Gitlab WebHook
========================================

This project provides a Gitlab web hook to receive Gitlab events and process these events.

Installation
------------

It is possible to install the tool with `pip`::

pip install sc-gitlab-webhook

Configuration
-------------

First, make sure /var/opt/sc directory exists, if not create this directory and make sure current user has the right
to create files in this directory.

You can copy `default.yml `_
to /var/opt/sc/.sc-gitlab-webhook/production.yml to initialize the production configuration.

The default configuration file looks like this::

dev:
# whether this program is running is development mode
dev_mode: False

# flask server info
server:
# flask server IP
ip: "localhost"
# flask server port
port: 8080

# rocketmq configurations
rocketmq:
# name server ip
name_server_ip: "localhost"
# name server port
name_server_port: 9876
# group id
group_id: "GITLAB_WEBHOOK_MSG"
# message topic
msg_topic: "GITLAB_WEBHOOK"
# message keys
msg_keys: "GITLAB"
# message tags
msg_tags: "GITLAB"

Dependencies
------------

* `sc-utilities `_ >= 0.0.2
* `sc-config `_ >= 0.0.3
* `flask `_ >= 1.1.2
* `rocketmq-client-python `_ >= 2.0.0

License
-------

The script is released under the MIT License. The MIT License is registered
with and approved by the Open Source Initiative [1]_.

.. [1] https://opensource.org/licenses/MIT