README

hookdeploy是一个用于bitbucket git仓库的PHP部署脚本。它还与composer、npm、bower和gulp有基本的集成。

使用composer安装

composer create-project avirdz/hookdeploy

要求

• 您需要bitbucket账户的ssh访问权限。
• 如果您启用了composer、npm、bower或gulp，它们必须可通过www-data访问。
• www-data需要git_dir和分支路径的写权限。
• www-data需要访问配置的私钥。

资源

• SSH密钥生成：https://confluence.atlassian.com/bitbucket/configure-multiple-ssh-identities-for-gitbash-mac-osx-linux-271943168.html
• 添加部署密钥：https://confluence.atlassian.com/bitbucket/use-deployment-keys-294486051.html
• Webhook管理：https://confluence.atlassian.com/bitbucket/manage-webhooks-735643732.html
• 修复NPM权限：https://docs.npmjs.net.cn/getting-started/fixing-npm-permissions

全局配置

添加新文件config.php，复制config.example.php文件的内容并做出更改。

(*) 避免权限错误，通过设置这些命令的完整路径。

项目配置

• private_key | (字符串) | ssh私钥的完整路径
• git_dir | (字符串) | 本地克隆仓库的完整路径
• remote_repository | (字符串) | 远程仓库路径ssh格式
• 分支（数组）| 待部署的分支 |||'branch_name' => 'deployment path' 常见环境分支，如 master（生产），develop（开发）
• 发布版本（数组）| 待部署的发布版本 |||'deploy' => false, 部署发布版本 |||'name_regex' => '/^release\/v?[0-9]+\.[0-9]+(?:\.[0-9]+)?$/i', 发布版本名称的正则表达式 |||'path' => '/var/www/myproject-latest' 部署最新发布版本的路径
• run_composer | (布尔值) 默认：false | 运行 composer install 命令
• run_npm | (布尔值) 默认：false | 运行 npm install 命令
• run_bower | (布尔值) 默认：false | 运行 bower install 命令
• run_gulp | (布尔值) 默认：false | 运行 gulp 任务命令
• gulp_task | (字符串) 默认：live | 要运行的任务名称
• valid_gulp_tasks | (数组) | 可以通过提交消息运行的有效的 gulp 任务

通过提交消息运行 gulp 任务

您可以通过提交消息运行 gulp 任务，只需在您的最后一条提交消息中添加以下格式

#gulp <task>#

将 <task> 替换为项目配置中 valid_gulp_tasks 键上的有效任务。

提交示例

Removed some unused files #gulp clear:all#

测试

测试您的私钥并将 bitbucket 添加到 known_hosts

sudo -Hu www-data ssh -i ~/.ssh/myPrivateKey -T git@bitbucket.org

通过浏览器测试

这是测试您的设置的最好方法。

将 hookdeploy 配置为通过浏览器设置全局配置 "http_test" 键为 true 来运行脚本。然后暂时禁用 .htaccess 中的 IP 限制。在浏览器中输入 hookdeploy 脚本的 URL，使用以下 GET 参数

示例测试 URL

http://my-host/hookdeploy.php?run=composer&bg=1&r=myuser%2Fmyproject&b=develop

许可证

MIT