Webhookit

Это минималистичный вариант git webhook для командной строки, который легко развернуть. Можно легко развернуть сервер webhook. Поддерживает GitHub, GitLab, GitOsc, Gogs, Coding. Поддерживаются Python 2 и Python 3.

Онлайн-демонстрация | English README

1. Установка

pip install webhookit

Поддерживаются Python 2 и 3. После установки в системе появятся два инструмента командной строки: webhookit и webhookit_config.

2. Использование

Чтобы получить справку по командам, выполните webhookit --help. Вот что вы увидите:

# webhookit --help
Usage: webhookit [OPTIONS]

Options:
  -c, --config PATH      The web hook configure file path.
  -p, --port INTEGER     The listening port of HTTP server.
  --help                 Show this message and exit.

Выполните webhookit_config, чтобы получить шаблон конфигурации инструмента.

Запустите webhookit -c config.py -p 18340, чтобы запустить HTTP-сервер webhook.

3. Пример

Вот простой пример использования инструмента:

# 1. Установите webhookit
pip install webhookit

# 2. Создайте шаблон конфигурации
webhookit_config > /home/hustcc/webhook-configs/config4hustcc.py

# 3. Измените содержимое config4hustcc.py
vim config4hustcc.py

# 4. Запустите http server
webhookit -c config4hustcc.py

Затем откройте http://host:18340 в браузере, чтобы увидеть следующую информацию:

1. Состояние webhook;
2. URL-адрес webhook;
3. Конфигурация webhook (личные данные скрыты).

4. Описание файла конфигурации

# -*- coding: utf-8 -*-
'''
Created on Mar-03-17 15:14:34
@author: hustcc/webhookit
'''

# Это означает:
# Когда приходит запрос webhook от `repo_name` на ветке `branch_name`,
# будет выполняться SCRIPT на серверах, указанных в массиве.
WEBHOOKIT_CONFIGURE = {
    # Запрос webhook может запускать несколько серверов.
    'repo_name/branch_name': [{
        # Если нужно выполнить команду оболочки на локальном сервере, оставьте пустым.
        'HOST': '',  # Выполнить команду оболочки на каком сервере.
        'PORT': '',  # Порт ssh, по умолчанию 22.
        'USER': '',  # Имя пользователя linux
        'PWD': '',  # Пароль пользователя или закрытый ключ.

        # Путь к сценарию оболочки webhook.
        'SCRIPT': '/home/hustcc/exec_hook_shell.sh'
    }, 
	...],
	...
}

Не рекомендуется изменять имя переменной Python WEBHOOKIT_CONFIGURE.

Каждый webhook использует имя репозитория и имя ветки как ключ, каждый webhook может активировать группу серверов, конфигурация которых хранится в массиве.

Серверы могут быть удаленными или локальными. Если вы хотите запустить скрипт на локальной машине, то оставьте HOST, PORT, USER, PWD пустыми или удалите эти ключи.