Git-deliver社区贡献指南：如何开发预设脚本与提交代码改进

【免费下载链接】git-deliverDelivery system based on git push and ssh项目地址: https://gitcode.com/gh_mirrors/gi/git-deliver

Git-deliver是一个基于git push和ssh的部署系统，它通过预设脚本实现自动化部署流程，帮助开发者简化项目交付过程。本指南将详细介绍如何为Git-deliver开发预设脚本并提交代码改进，让你轻松成为社区贡献者。

一、了解预设脚本结构

Git-deliver的预设脚本存放在项目的presets目录下，采用分类组织的方式管理不同类型的部署任务。每个分类（如core、drupal、php等）都包含特定阶段的脚本，主要分为以下几个阶段：

• pre-delivery：部署前检查脚本，如磁盘空间检查、代码语法验证
• pre-symlink：创建符号链接前执行的操作
• post-symlink：创建符号链接后执行的操作
• post-checkout：代码检出后执行的操作

每个脚本文件以数字前缀命名（如01-disk-space.sh），确保按顺序执行。你可以通过查看现有脚本了解具体实现，例如：

• 磁盘空间检查脚本：01-disk-space.sh
• PHP语法检查脚本：01-syntax-check.sh

二、开发预设脚本的步骤

1. 确定脚本类型和阶段

首先明确你的脚本属于哪个分类（core、php、drupal等）和哪个执行阶段。如果是通用功能，建议放在core目录下；如果是特定框架或语言相关功能，则放在对应分类目录。

2. 创建脚本文件

创建以数字前缀开头的.sh文件，例如02-custom-check.sh。脚本必须以bash shebang开头：

#!/bin/bash

3. 实现核心功能

根据部署需求实现脚本功能。以下是两个常见示例：

磁盘空间检查示例

SAFETY_MARGIN=$(( 10 * 1024 * 1024 )) # 10MB安全余量 FREE_KBYTES=`run_remote "df -k \"$REMOTE_PATH\" | awk '/[0-9]%/{print \\\$(NF-2)}'"` FREE_BYTES=$(($FREE_KBYTES * 1024)) NECESSARY_BYTES=$(( `git archive --format=tar $VERSION | wc -c` + $SAFETY_MARGIN )) if [[ $FREE_BYTES -gt $NECESSARY_BYTES ]]; then exit 0 else echo "Not enough disk space available on remote" exit 1 fi

PHP语法检查示例

PHPL=`find ./ -type f -name \*.php -exec php -l {} \; 2>&1` echo "$PHPL" | grep "Parse error" if [[ $? -gt 0 ]]; then exit 0; else exit 1; fi

4. 添加执行权限

确保脚本具有可执行权限：

chmod +x presets/[分类]/[阶段]/[脚本文件名].sh

5. 编写info文件

在分类目录下的info文件中添加脚本说明，格式如下：

[脚本文件名] = 简短描述

三、远程操作脚本开发

对于需要在远程服务器执行的操作，Git-deliver提供了远程脚本支持，文件扩展名为.remote.sh。这类脚本通常用于启动/停止服务、切换配置等操作，例如：

• 01-stop-puppetmaster.remote.sh
• 01-start-puppetmaster.remote.sh

开发远程脚本时，需注意：

• 使用run_remote函数执行远程命令
• 确保脚本具有良好的错误处理
• 避免长时间运行的操作

四、提交代码改进的流程

1. 克隆仓库

首先克隆Git-deliver仓库到本地：

git clone https://gitcode.com/gh_mirrors/gi/git-deliver

2. 创建分支

为你的贡献创建一个新分支：

git checkout -b feature/new-preset-script

3. 编写代码并测试

实现你的功能并进行充分测试。可以使用项目提供的测试脚本进行验证：

./tests.sh

4. 提交变更

提交你的代码变更，确保提交信息清晰描述功能：

git add presets/[你的脚本路径] git commit -m "Add [功能描述] preset script for [分类]"

5. 提交PR

将你的分支推送到仓库并创建Pull Request，等待社区审核。

五、贡献最佳实践

1. 保持简洁：脚本功能应单一明确，避免过于复杂的实现
2. 错误处理：确保脚本有完善的错误检查和提示
3. 兼容性：考虑不同环境下的兼容性，避免使用特定系统命令
4. 文档：为新功能添加清晰的注释和说明
5. 测试：编写测试用例验证脚本功能

通过遵循以上指南，你可以轻松为Git-deliver项目贡献代码，帮助完善这个强大的部署系统。无论是添加新的预设脚本还是改进现有功能，每一个贡献都能让Git-deliver变得更加完善！

【免费下载链接】git-deliverDelivery system based on git push and ssh项目地址: https://gitcode.com/gh_mirrors/gi/git-deliver