README

自动将您的站点部署到托管平台

• 要求
• 通过 COMPOSER 开始使用
• 通过 NPM 开始使用
• 通过自定义命令进行扩展部署

要求

1. PHP 5.4 或更高版本
2. 有权执行 shell 命令
3. 在目标托管平台上安装了 GIT

通过 COMPOSER 开始使用

主要通过 composer 使用。

1. 安装包

   $ composer require optimistex/git-auto-deploy-ex

2. 创建一个包含以下内容的 deploy.php 文件

   <?php
   require_once 'vendor/autoload.php';
   // Add secret code in the first parameter for protection
   (new \optimistex\deploy\DeployApplication('ytJHvMHFdTYUryDhmJkjFjFiYk'))->run();

3. 配置 WebHook 以发送请求到

    http://your.domain/deploy.php?key=ytJHvMHFdTYUryDhmJkjFjFiYk
   

4. 访问页面 http://your.domain/deploy.php 检查日志历史记录

不要忘记更改密钥代码 ytJHvMHFdTYUryDhmJkjFjFiYk

通过 NPM 开始使用

如果您制作的是 SPA 且文件位于 PHP 托管平台上，则可以通过该包进行自动部署。

1. 安装包

   $ npm i git-auto-deploy-ex

2. 创建一个包含以下内容的 deploy.php 文件

   <?php
   require_once '\path\to\DeployApplication';
   // Add secret code in the first parameter for protection
   (new \optimistex\deploy\DeployApplication('ytJHvMHFdTYUryDhmJkjFjFiYk'))->run();

3. 配置 WebHook 以发送请求到

    http://your.domain/deploy.php?key=ytJHvMHFdTYUryDhmJkjFjFiYk
   

4. 访问页面 http://your.domain/deploy.php 检查日志历史记录

通过自定义命令进行扩展部署

对于扩展部署，创建一个包含以下代码的 deploy.php 文件

<?php

use optimistex\deploy\DeployApplication;

require_once 'vendor/autoload.php';

(new DeployApplication('security_key'))->run([  // executing custom commands
    'git branch',                               // equal: $ git branch
    'git pull',                                 // equal: $ git pull
    'php' => 'composer.phar install',           // equal: $ php composer.phar install
    ['php' => 'yii migrate --interactive=0'],   // equal: $ php yii migrate --interactive=0
]);

行 'php' => 'composer.phar install' 用于将 "php" 扩展到绝对路径。绝对路径是必需的，因为 "php" 使用相对路径时不起作用！

贡献

要运行测试，只需运行 $ make

许可证

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1   Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
2.  Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
3.  The name of the author may not be used to endorse or promote
    products derived from this software without specific prior written
    permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.