【git】webhook 攻略

相关文章

webhook 攻略

一、Git WebHook 是什么

在 Git 中，Webhook 是一种机制，用于在代码仓库中发生特定事件时触发自动化操作。它通过在代码仓库中配置一个 HTTP 回调 URL，当特定事件发生时，会向这个 URL 发送 HTTP 请求，从而触发预定义的操作。

二、实现自动化部署

设置Webhook

在Git仓库管理界面中，找到Webhook设置选项。
添加一个新的Webhook，并指定触发事件（如代码推送、分支创建、合并请求等）和目标URL。

编写部署脚本

编写用于自动部署的脚本，该脚本负责从Git仓库中拉取最新的代码，并执行部署操作。
部署脚本可能涉及构建、测试、打包、上传至服务器、启动应用等操作，具体内容根据项目需求而定。

脚本案例

#!/bin/bash

# 定义相关路径和变量
PROJECT_DIR="/path/to/your/project"
GIT_REPO="https://github.com/yourusername/yourproject.git"
BRANCH="main"
REMOTE_HOST="your_remote_host"
REMOTE_USER="your_remote_user"
REMOTE_DIR="/path/to/remote/project"

# 切换到项目目录
cd $PROJECT_DIR

# 更新代码
git pull origin $BRANCH

# 备份当前版本（可选）
TIMESTAMP=$(date +"%Y%m%d%H%M%S")
BACKUP_DIR="/path/to/backup/$TIMESTAMP"
mkdir -p $BACKUP_DIR
cp -r $PROJECT_DIR/* $BACKUP_DIR

# 执行部署操作
# 此处可以根据需要执行其他部署操作，如构建、安装依赖、重启服务等
# 例如：npm install && npm run build

# 将代码部署到远程服务器
scp -r $PROJECT_DIR/* $REMOTE_USER@$REMOTE_HOST:$REMOTE_DIR

# 远程服务器操作
# 此处可以根据需要执行远程服务器上的其他操作，如重启服务等
# 例如：ssh $REMOTE_USER@$REMOTE_HOST "cd $REMOTE_DIR && npm install && npm run restart"

# 完成部署
echo "Deployment completed successfully."

编写接收 Webhook 请求的服务

你需要编写一个能够接收 Webhook 请求的服务，当收到请求时，触发部署脚本执行。这个服务可以是一个简单的 HTTP 服务器，可以使用 Node.js、Python 等编程语言实现。

const http = require('http');
const { exec } = require('child_process');

const server = http.createServer((req, res) => {
  if (req.method === 'POST' && req.url === '/webhook') {
    let data = '';
    req.on('data', (chunk) => {
      data += chunk;
    });

    req.on('end', () => {
      try {
        const payload = JSON.parse(data);
        if (payload && payload.ref === 'refs/heads/master') {
          exec('bash deploy.sh', (error, stdout) => {
            if (error) {
              console.error(`执行部署脚本失败: ${error.message}`);
              res.statusCode = 500;
              res.end('Deployment failed');
            } else {
              console.log(`部署脚本执行结果: ${stdout}`);
              res.statusCode = 200;
              res.end('Deployment successful');
            }
          });
        } else {
          res.statusCode = 200;
          res.end('Ignoring non-master branch push');
        }
      } catch (error) {
        console.error(`解析 Webhook 数据失败: ${error.message}`);
        res.statusCode = 400;
        res.end('Invalid Webhook payload');
      }
    });
  } else {
    res.statusCode = 404;
    res.end('Not found');
  }
});

const PORT = process.env.PORT || 3000;
server.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});