利用 github 的 webhooks 自动部署博客

原文发布于自己的博客平台【http://www.jetchen.cn/github-webhooks/


背景

博客原是 WordPress 搭建的,由于某些个人无法接受的原因,准备转成静态博客,之前转过,使用的是 HEXO,基本成功了,但是是部署在 github pages 上面的,如今准备部署在国内的阿里云服务器上。

问题

使用 HEXO 搭建的博客平台,进行写博客的流程是:

1、本地使用 Markdown 编写博客,
2、本地编译成 html 文件,
3、将 html 文件上传至服务器,一般免费的有 github page,gitee 等

所以此处需要改造的点其实很简单,就是把 github 仓库中的 html 文件全部下载至服务器上,然后利用 web 服务器做个反向代理即可,比如 nginx。

后续的部署流程:

1、本地写完博客,编译完成后上传至 github 仓库
2、登陆到服务器上面进行 git update 操作

问题就此暴露出来了,每次写完博客都要登陆下服务器去更新下 html 文件,我的天,这谁顶得住。

解决

于是自然而然想到了 git 仓库的 web 钩子,即当 git 仓库收到 push 或者其他命令时,会自动调我们的钩子程序(其实就是向我们指定的地址发送一个 post 请求),而我们只需要让我们的这个程序去跟新下服务器上面的代码(html 文件)即可。

流程示例图见下图:

流程示例图

从上面可以出,我们只剩 2 件事需要做,一是配置下 github 的 webhook,二是在我们的服务器上写一个 web 程序来处理 github 发送过来的请求。

1、webhook 配置

配置比较简单,需要注意的是,秘钥虽然是非必填的,但是最好还是加上,为了安全。


webhook 配置

请求的数据,每个平台都不一样,在此以 github 为例,数据内容见下图:
注:请求头中有一个很重要的签名参数,该参数前部分为加密方式,后部分为的签名,而明文就是我们在 webhook 中配置的秘钥。这点很重要哦。

webhook 请求示例图

2、程序编写

写一个简单是 web 程序。

本人主要是编写 java 代码的,如果要用 java 来写的话,比较麻烦,所以考虑选择一款解释性语言来编写,其实用啥语言都无所谓啦,毕竟代码处理逻辑很简单,选用自己熟悉的就行,例如 Python、PHP、nodejs 等都行。

此处选择的是使用 Python 来编写,web 框架是比较轻量的 Flask,操作 git 使用的是 gitPython,所以需要安装下:

pip install flask
pip install gitpython

代码比较简单,不多赘述,主要就是两点:

1、签名校验
2、git update

详细代码如下:


from flask import Flask, request, Blueprint, jsonify, current_app
from git import Repo
import hmac

app = Flask(__name__)

@app.route("/api/github_hook", methods=['POST'])
def github_web_hook():

    header_signature_origin = request.headers.get('X-Hub-Signature')
    if header_signature_origin is None:
        return '你没有权限访问!'
        
    hash_type, header_signature = header_signature_origin.split('=')
    if hash_type != 'sha1':
        return '不支持的加密方式!'
        
    secret = str.encode("http://www.jetchen.cn")
    
    hashhex = hmac.new(secret, request.data, digestmod='sha1').hexdigest()
    if hmac.compare_digest(hashhex, header_signature):
        repo = Repo('/data/blog-test/blog.github.io/') # 获取本地git仓库
        # repo = Repo('D:\project\mixed\\blog.github.io\\') # 获取本地git仓库
        # origin = repo.remotes.origin # 获取远程库 & 远程分支
        # origin.pull('--rebase') # 拉代码
        remote = repo.remote()
        remote.pull('master')
        
        if 'after' in request.json:
            commit = request.json['after'][0:6] # pull 的最新的commit
            print('Repository updated with commit {}'.format(commit))
            
    else:
        return '签名校验失败!'
        
    return jsonify({}), 200
    
if __name__ == "__main__":
    app.run(port=8001)
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容