GitHub自动部署项目教程

GitHub自动部署项目教程

Github-Auto-Deploya server that allows you to automatically deploy the latest version of your github project at each git push项目地址:https://gitcode.com/gh_mirrors/gi/Github-Auto-Deploy

1. 项目的目录结构及介绍

Github-Auto-Deploy/
├── deploy.php
├── README.md
├── .htaccess
├── config.php
└── logs/
    └── deploy.log

• deploy.php: 项目的核心文件，用于处理GitHub的Webhook请求并执行自动部署。
• README.md: 项目的说明文档，包含项目的基本信息和使用方法。
• .htaccess: Apache服务器的配置文件，用于处理URL重写和访问控制。
• config.php: 项目的配置文件，包含GitHub Webhook的密钥和其他配置选项。
• logs/: 日志文件夹，用于存储部署日志。
  • deploy.log: 部署日志文件，记录每次部署的详细信息。

2. 项目的启动文件介绍

deploy.php

deploy.php 是项目的启动文件，主要负责以下任务：

• 接收GitHub的Webhook请求。
• 验证请求的签名。
• 执行Git pull命令以更新代码。
• 记录部署日志。

以下是 deploy.php 的核心代码片段：

<?php
// 引入配置文件
require_once 'config.php';

// 验证GitHub的Webhook签名
if (!isset($_SERVER['HTTP_X_HUB_SIGNATURE'])) {
    die('Permission denied.');
}

list($algo, $hash) = explode('=', $_SERVER['HTTP_X_HUB_SIGNATURE'], 2) + array('', '');
$payload = file_get_contents('php://input');
if ($hash !== hash_hmac($algo, $payload, GITHUB_WEBHOOK_SECRET)) {
    die('Permission denied.');
}

// 执行Git pull命令
$output = shell_exec('git pull 2>&1');

// 记录部署日志
file_put_contents('logs/deploy.log', date('Y-m-d H:i:s') . " " . $output . PHP_EOL, FILE_APPEND);

echo "Deployment successful.";
?>

3. 项目的配置文件介绍

config.php

config.php 是项目的配置文件，包含以下关键配置项：

• GITHUB_WEBHOOK_SECRET: GitHub Webhook的密钥，用于验证请求的签名。

以下是 config.php 的示例内容：

<?php
// GitHub Webhook 密钥
define('GITHUB_WEBHOOK_SECRET', 'your_secret_key_here');
?>

请根据实际情况修改 your_secret_key_here 为你的GitHub Webhook密钥。

---

以上是GitHub自动部署项目的详细教程，包括项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

Github-Auto-Deploya server that allows you to automatically deploy the latest version of your github project at each git push项目地址:https://gitcode.com/gh_mirrors/gi/Github-Auto-Deploy