Magallanes 技术文档

1. 安装指南

1.1 使用 Composer 安装

Magallanes 是一个基于 PHP 的部署工具，可以通过 Composer 进行安装。首先，确保你已经安装了 Composer。然后，在你的项目根目录下，打开 composer.json 文件，并添加以下依赖项：

{
    "require-dev": {
        "andres-montanez/magallanes": "^5.0"
    }
}

保存文件后，运行以下命令来安装 Magallanes：

composer install

1.2 验证安装

安装完成后，你可以通过以下命令验证 Magallanes 是否安装成功：

vendor/bin/mage version

如果安装成功，你应该会看到 Magallanes 的版本信息。

2. 项目的使用说明

2.1 基本使用

Magallanes 是一个非常简单易用的部署工具。你可以通过命令行来执行部署任务。以下是一个基本的部署命令示例：

vendor/bin/mage deploy production

这个命令会将你的代码部署到生产环境。

2.2 自定义任务

Magallanes 允许你定义自定义任务，以便在部署过程中执行特定的操作。你可以在项目的根目录下创建一个 mage.yml 文件，并在其中定义你的任务。例如：

tasks:
  pre-deploy:
    - name: composer:install
  post-deploy:
    - name: cache:clear

在这个例子中，composer:install 任务会在部署开始前执行，而 cache:clear 任务会在部署完成后执行。

3. 项目 API 使用文档

3.1 内置任务

Magallanes 提供了一些内置任务，可以直接在部署过程中使用。以下是一些常用的内置任务：

• composer:install: 安装 Composer 依赖。
• cache:clear: 清除缓存。
• git:checkout: 从 Git 仓库检出代码。

3.2 自定义任务 API

你可以通过编写自定义任务来扩展 Magallanes 的功能。自定义任务需要继承 Magallanes\Task\AbstractTask 类，并实现 execute 方法。例如：

namespace YourNamespace\Task;

use Magallanes\Task\AbstractTask;

class CustomTask extends AbstractTask
{
    public function execute()
    {
        // 自定义任务逻辑
    }
}

然后在 mage.yml 文件中注册你的自定义任务：

tasks:
  custom:
    - name: yournamespace:customtask

4. 项目安装方式

4.1 通过 Composer 安装

如前所述，Magallanes 可以通过 Composer 进行安装。这是最常用的安装方式，适用于大多数 PHP 项目。

4.2 手动安装

如果你不想使用 Composer，也可以手动下载 Magallanes 的源代码，并将其放置在你的项目目录中。然后，你需要手动配置环境变量和路径，以便能够从命令行调用 Magallanes。

4.3 使用 Docker

Magallanes 也可以通过 Docker 进行安装和使用。你可以创建一个包含 Magallanes 的 Docker 镜像，并在容器中运行部署任务。

FROM php:8.0-cli
RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
RUN composer require andres-montanez/magallanes

然后，你可以通过以下命令运行 Magallanes：

docker run -v $(pwd):/app your-magallanes-image vendor/bin/mage deploy production

通过以上步骤，你可以轻松地安装和使用 Magallanes 进行 PHP 项目的部署。