Mirakle 使用教程

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

Mirakle 是一个 Gradle 插件，它允许用户将构建过程从本地机器移动到远程机器。以下是项目的目录结构及其简单介绍：

• benchmark/: 包含性能测试相关的代码。
• docs/: 存放项目的文档文件。
• gradle/: 包含项目使用的 Gradle 脚本和相关配置。
• plugin-test/: 包含插件测试的代码。
• plugin/: 包含 Mirakle 插件的主要实现代码。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE.txt: Apache-2.0 许可证文件。
• README.md: 项目的自述文件，介绍项目的功能和用法。
• build.gradle: 项目的主构建脚本。
• gradlew 和 gradlew.bat: Gradle Wrapper 脚本，用于在未安装 Gradle 的环境中执行 Gradle 任务。

2. 项目的启动文件介绍

项目的启动主要是通过 build.gradle 文件来完成的。以下是 build.gradle 的基本结构：

// 应用插件
apply plugin: 'Mirakle'

// 配置项目
mirakle {
    host "your_remote_machine" // 远程机器的主机名
    // 其他配置...
}

// 定义任务
task heavyBuild {
    // 任务实现...
}

在本地机器的 USER_HOME/.gradle/init.d/mirakle_init.gradle 文件中，你需要配置 Mirakle 插件的初始化脚本，如下所示：

initscript {
    repositories {
        mavenCentral() // 使用 Maven 中央仓库
    }
    dependencies {
        classpath 'io.github.adambl4:mirakle:1.6.0' // 添加 Mirakle 插件的依赖
    }
}

然后，你可以通过执行以下命令来启动构建过程：

./gradlew build

3. 项目的配置文件介绍

项目的配置文件主要是在 build.gradle 文件中进行设置。以下是可配置的一些参数及其默认值：

• host: 远程机器的主机名（必填）。
• remoteFolder: 远程文件夹路径，用于存放项目文件（默认为 ~/mirakle）。
• excludeLocal: 本地文件排除模式列表，用于上传时排除文件（默认为 ["**/build"]）。
• excludeRemote: 远程文件排除模式列表，用于下载时排除文件（默认为 ["**/src/"]）。
• excludeCommon: 共享排除模式列表，用于上传和下载时排除文件（默认为 [".gradle", ".idea", "**/.git/", "**/local.properties", "**/mirakle.properties", "**/mirakle_local.properties"]）。
• rsyncToRemoteArgs: rsync 上传时的参数列表（默认为 ["--archive", "--delete"]）。
• rsyncFromRemoteArgs: rsync 下载时的参数列表（默认为 ["--archive", "--delete"]）。
• sshArgs: SSH 连接的参数列表（默认为空列表）。
• fallback: 如果上传失败，是否在本地执行构建（默认为 false）。
• downloadInParallel: 是否在执行远程构建时并行下载文件（默认为 false）。
• downloadInterval: 并行下载的时间间隔（默认为 2000 毫秒）。
• breakOnTasks: 结束远程构建并继续在本地执行的任务模式列表（默认为空列表）。
• remoteBashCommand: 在执行 Gradle 构建之前执行的远程 Bash 命令（默认为 null）。

你可以根据需要修改这些配置以适应你的项目需求。