Python基于Webhook實(shí)現(xiàn)github自動(dòng)化部署
一. 分析需求
1. 需求說(shuō)明
在項(xiàng)目開發(fā)過(guò)程中,我們有時(shí)會(huì)頻繁的更新代碼, 流程大概為:
(1) 本地git push提交代碼至git托管平臺(tái)
(2) 登陸到部署有網(wǎng)站源碼的線上服務(wù)器
(3) cd到項(xiàng)目根目錄, 執(zhí)行g(shù)it pull 指令拉取最新代碼
整個(gè)流程純手動(dòng)更新,每次耗時(shí)在1分鐘左右, 這樣一天下來(lái),浪費(fèi)了很多時(shí)間在這些瑣碎的事情上.
現(xiàn)在的需求是,在每次本地提交代碼后,線上服務(wù)器自動(dòng)拉取最新代碼,完成部署更新.即所謂的自動(dòng)化部署.
2. 方案
現(xiàn)在一些主流代碼托管平臺(tái)如github、 gitlab、git@osc 等均已提供webhook功能,在用戶push了代碼后,會(huì)自動(dòng)回調(diào)一個(gè)您設(shè)定的http地址。 用戶可以自己根據(jù)不同的需求,來(lái)編寫自己的腳本程序(比如發(fā)郵件,自動(dòng)部署等);目前,webhook支持多種觸發(fā)方式,如Push、 Tag Push、 Issue、評(píng)論、合并請(qǐng)求 等。
附webhook的簡(jiǎn)介:
Webhook就是用戶通過(guò)自定義回調(diào)函數(shù)(callback)的方式來(lái)改變Web應(yīng)用的一種行為,這些回調(diào)函數(shù)可以由不是該Web應(yīng)用官方的第三方用戶或者開發(fā)人員來(lái)維護(hù),修改。通過(guò)Webhook,你可以自定義一些行為通知到指定的URL去。Webhook的“自定義回調(diào)函數(shù)”通常是由一些事件觸發(fā)的,比如推送代碼到代碼庫(kù)或者博客下新增一個(gè)評(píng)論,源站點(diǎn)會(huì)為Webhook進(jìn)行HTTP請(qǐng)求的URI配置。用戶通過(guò)配置,就可以使一個(gè)網(wǎng)站上的事件調(diào)用在另一個(gè)網(wǎng)站上表現(xiàn)出來(lái),這些事件調(diào)用可以是任何事件,但通常應(yīng)用的是系統(tǒng)集成和消息通知。
方案流程:
所以自動(dòng)部署主要實(shí)現(xiàn)方式就是:
- 修改代碼 push
- github(其他倉(cāng)庫(kù)平臺(tái))發(fā)送請(qǐng)求給你的網(wǎng)站服務(wù)器
- 網(wǎng)站服務(wù)器收到更新請(qǐng)求,執(zhí)行自動(dòng)部署腳本
- 自動(dòng)部署腳本執(zhí)行代碼拉取,打包,修改文件等動(dòng)作完成網(wǎng)站的更新部署
二、具體實(shí)現(xiàn)
Github倉(cāng)庫(kù)設(shè)置
在GitHub上需要更新的代碼倉(cāng)庫(kù)添加webhooks, 在指定倉(cāng)庫(kù)→settings→webhooks
編寫GitHub推送回調(diào)
python開啟web服務(wù)(hook.py)
import hmacimport osfrom flask import Flask, request, jsonifyapp = Flask(__name__)# github中webhooks的secretgithub_secret = ’xxxxxxxx’def encryption(data): key = github_secret.encode(’utf-8’) obj = hmac.new(key, msg=data, digestmod=’sha1’) return obj.hexdigest()@app.route(’/hook’, methods=[’POST’])def post_data(): ''' github加密是將post提交的data和WebHooks的secret通過(guò)hmac的sha1加密,放到HTTP headers的 X-Hub-Signature參數(shù)中 ''' post_data = request.data token = encryption(post_data) # 認(rèn)證簽名是否有效 signature = request.headers.get(’X-Hub-Signature’, ’’).split(’=’)[-1] if signature != token: return 'token認(rèn)證無(wú)效', 401 # 運(yùn)行shell腳本,更新代碼 os.system(’sh deploy.sh’) return jsonify({'status': 200})if __name__ == ’__main__’: app.run(port=8989)
編寫shell腳本(deploy.sh)
cd '$(dirname '$0')'echo ’--------Git pull------------’git pullecho ’-----Already up-to-date------’echo ’----- restart supervision-----’supervisorctl restart blogecho ’----- reload nginx-----’nginx -s reload
注意: 此次部署的hook.py 和deploy.sh都是在倉(cāng)庫(kù)的同一目錄下
開啟服務(wù)
supervisor部署webhook
[program:webhook]directory=/data/wwwroot/docscommand=/home/dukenan/.envs/flask_py3/bin/python3 hook.pyautostart=trueautorestart=falsestartsecs=1;使用root賬戶user=rootstderr_logfile=/etc/supervisor/logs/webhooks/stderr.log stdout_logfile=/etc/supervisor/logs/webhooks/stdout.log redirect_stderr=trueloginfo=info
部署NGINX的參考
server { listen 80; server_name 服務(wù)器IP; # 配置域名 client_max_body_size 300M; location / { proxy_pass http://127.0.0.1:8989; #轉(zhuǎn)發(fā)本地8989端口 proxy_set_header X-Real-IP $remote_addr; proxy_set_header Host $host; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; } }
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持好吧啦網(wǎng)。
相關(guān)文章:
1. 使用Hangfire+.NET 6實(shí)現(xiàn)定時(shí)任務(wù)管理(推薦)2. Xml簡(jiǎn)介_動(dòng)力節(jié)點(diǎn)Java學(xué)院整理3. 如何在jsp界面中插入圖片4. jsp實(shí)現(xiàn)登錄驗(yàn)證的過(guò)濾器5. phpstudy apache開啟ssi使用詳解6. JSP之表單提交get和post的區(qū)別詳解及實(shí)例7. jsp文件下載功能實(shí)現(xiàn)代碼8. 詳解瀏覽器的緩存機(jī)制9. vue3+ts+elementPLus實(shí)現(xiàn)v-preview指令10. xml中的空格之完全解說(shuō)
