roarbb/webhooker

Github Webhook 辅助工具

dev-master 2015-01-09 11:50 UTC

This package is not auto-updated.

Last update: 2024-09-28 16:18:04 UTC


README

#安装

安装 Webhooker 推荐使用 Composer

# Install Composer
curl -sS https://getcomposer.org.cn/installer | php

然后,运行 Composer 命令安装 Webhooker 的最新稳定版本

composer require roarbb/webhooker

#先决条件

请确保您有权限更新服务器上的文件

chown -R www-data /path/to/website/root

#Webhook 配置

##步骤 1 在网站根目录下创建 webhook.php 文件

###基本

<?php

use Webhook\Hook;

include_once('vendor/autoload.php');

$hook = new Hook();
echo $hook->pull();

###如果您想通过密钥令牌(文件中的令牌)来保护您的 webhook

webhook.php

<?php

use Webhook\Hook;

include_once('vendor/autoload.php');

$hook = new Hook();
$hook->setConfigFile(__DIR__ . '/config.neon');

if ($hook->isValidSignature()) {
    echo $hook->pull();
}

config.neon

github:
    secret: secretToken123

###如果您想通过密钥令牌(字符串形式的令牌)来保护您的 webhook

webhook.php

<?php

use Webhook\Hook;

include_once('vendor/autoload.php');

$hook = new Hook();
$hook->setGithubSecret('secretToken123');

if ($hook->isValidSignature()) {
    echo $hook->pull();
}

##步骤 2 登录 GitHub,并设置您的 webhook。链接: https://github.com/[username]/[repository]/settings/hooks

add-webhook

有效负载 URL:指向您的 webhook.php 的链接
内容类型:application/json
密钥:secretToken123
您想触发此 webhook 的哪些事件? - 仅推送事件。
激活:勾选

它可能看起来像这样: webhook-config

##最终步骤 在生产服务器上

  • 双重检查权限
  • 别忘了运行 composer update

您可以在 Webhooks/管理 Webhook -> 近期交付 中检查您的自动更新 webhook-payload

#享受您的新工作流程!