Gitlab使用system hooks新建项目时自动添加webhooks

由于生产中项目仓库通过触发tag push行为来接管CI后的行为,需要给每个代码仓库都添加webhooks,这个时候使用系统钩子来实现就很合适了,不用每次手动添加。

以下行为可以触发system hooks:

  • project_create

  • project_destroy

  • project_rename

  • project_transfer

  • project_update

  • user_add_to_team

  • user_remove_from_team

  • user_create

  • user_destroy

  • user_failed_login

  • user_rename

  • key_create

  • key_destroy

  • group_create

  • group_destroy

  • group_rename

  • user_add_to_group

  • user_remove_from_group

php实现脚本,当创建和删除项目时触发system hook:

<?php

$sql_host = "gitlab.mysql01.chegva.com";
$sql_user = "git";
$sql_password = "chegva.com";
$database = "gitlabhq_production";
$port = '3306';
$logfile = '/home/anzhihe/data/www/hook/gitlab_webhook.log';

function log_append($message, $time = null)
{
    global $logfile;
    $time = $time === null ? time() : $time;
    $date = date('Y-m-d H:i:s');
    $pre  = $date . ' (' . $_SERVER['REMOTE_ADDR'] . '): ';
    file_put_contents($logfile, $pre . $message . "\n", FILE_APPEND);
}

$sql = mysqli_connect($sql_host, $sql_user, $sql_password, $database, $port);
if (mysqli_connect_errno()) {
    exit;
}
$file = fopen("/home/anzhihe/data/www/hook/sql_error.log", "a"); // you can use this as debug log too 😉

$input = json_decode(file_get_contents('php://input'), true);
$pid = $input['project_id'];
$path_with_namespace = $input['path_with_namespace'];

if ($input['event_name'] == "project_create") {
    log_append('add webhook start... -> pid: ' . $pid);
    $url = 'http://chegva.com/api/v1/fs/webhook';
    // this creates a project hook, specify it for your needs..
    $q = mysqli_query($sql, "INSERT INTO gitlabhq_production.web_hooks(url, project_id, push_events, tag_push_events) VALUES('$url', '$pid', '0', '1')");
    if (!$q) {
fwrite($file, $sql->error);
    } else {
log_append('add web_hook succeed -> path: ' . $path_with_namespace);
    }
} elseif ($input['event_name'] == "project_destroy") {
    $q = mysqli_query($sql, "DELETE FROM gitlabhq_production.web_hooks WHERE project_id='$pid'");
    log_append('project destroy and remove webhook -> pid: ' . $pid);
    log_append('project destroy succeed -> path: ' . $path_with_namespace);
    mysqli_close($sql);
} else {
    exit;
}

?>

Gitlab的nginx配置文件加下如下配置:

location = /explore {
    return 301 https://$http_host;
}

location = /add_webhook.php {
    root /home/anzhihe/data/www/hook;
    fastcgi_pass   127.0.0.1:9000;
    fastcgi_index  index.php;
    set $real_script_name $fastcgi_script_name;
    if ($fastcgi_script_name ~ "^(.+?\\.php)(/.*)?$") {
            set $real_script_name $1;
            set $path_info $2;
    }
    include        fastcgi_params;
    fastcgi_param SCRIPT_REAL_SCRIPT_NAME $real_script_name;
    fastcgi_param SCRIPT_FILENAME $document_root$real_script_name;
    fastcgi_param SCRIPT_NAME $real_script_name;
    fastcgi_param PATH_INFO $path_info;
    fastcgi_param HTTP_X_FORWARDED_PORT 80;
}

现在可以开始测试了。首先,添加system hooks,点击 Admin area -> System Hooks -> Add system hook

Gitlab使用system hooks新建项目时自动添加webhooks

创建一个测试仓库:

Gitlab使用system hooks新建项目时自动添加webhooks

可以看到新建的仓库自动添加了webhooks:

Gitlab使用system hooks新建项目时自动添加webhooks

查看system hooks详细的执行过程:

Gitlab使用system hooks新建项目时自动添加webhooks删除刚才创建的项目,会自动删除数据库webhook记录:

Gitlab使用system hooks新建项目时自动添加webhooks

查看日志记录:

Gitlab使用system hooks新建项目时自动添加webhooks

之后所有新建仓库的时候都会自动加上webhooks,删除仓库时也会删除添加的webhooks,并且还有了日志记录,重要的是不用再手动一个个添加啦!

参考:https://docs.gitlab.com/ee/system_hooks/system_hooks.html

anzhihe安志合个人博客,版权所有丨 如未注明,均为原创 丨转载请注明转自:https://chegva.com/3457.html | ☆★★每天进步一点点,加油!★★☆

您可能还感兴趣的文章!

发表评论

电子邮件地址不会被公开。 必填项已用*标注