Laravel Task Runner：本地与远程服务器的Shell脚本新纪元

滕璇萱Russell

于 2024-09-08 08:30:35 发布

阅读量499

点赞数 22

本文链接：https://blog.csdn.net/gitblog_01131/article/details/142013411

版权

Laravel Task Runner：本地与远程服务器的Shell脚本新纪元

laravel-task-runnerA package to write Shell scripts like Blade Components and run them locally or on a remote server项目地址:https://gitcode.com/gh_mirrors/la/laravel-task-runner

项目介绍

Laravel Task Runner 是一个高度创新的包，它允许开发者以类似Blade组件的方式编写Shell脚本，并在本地或远程服务器上执行这些任务。此工具设计巧妙，支持任务后台运行及测试断言，构建于Laravel框架的Process特性之上。特别适合那些寻求优雅解决方案来自动化日常部署、维护和其他服务器操作的Laravel开发者。适用于PHP版本8.2及以上，并要求Laravel环境至少为10.x。

项目快速启动

安装步骤：

首先，确保你的开发环境已准备就绪，包括符合要求的PHP版本。然后，通过Composer添加此包到你的全局工具中：

composer global require "protonemedia/laravel-task-runner"

记得更新环境变量，使得envoy命令可直接从终端访问，通常你需要将~/.composer/vendor/bin加入PATH中。

随后，在你的项目目录下，可以通过以下命令安装配置文件（此步骤为可选，但便于自定义）：

php artisan vendor:publish --provider="ProtoneMedia\LaravelTaskRunner\LaravelTaskRunnerServiceProvider"

创建一个新的.envoy文件并编写你的首个任务示例。例如，模拟一个简单的服务器部署流程：

@servers(['web' => 'your.server.com'])

@task('deploy', ['on' => 'web'])
    cd /path/to/your/project
    git pull origin master
    composer install --no-dev --optimize-autoloader
    php artisan migrate
@endtask

之后，只需在终端键入envoy run deploy，即可执行上述部署任务。

应用案例和最佳实践

在持续集成/持续部署（CI/CD）流程中，Laravel Task Runner发挥着核心作用。你可以定义一系列自动化的任务，如编译资产、数据库迁移、测试执行等，确保每次部署都是无缝且一致的。此外，利用任务宏来封装重复性命令，比如设置一个setup任务来完成项目的初始化配置工作，从而简化团队成员的本地开发环境搭建过程。

@macro('setup')
    npm install
    bower install
    composer install
@endmacro

@task('local-setup', ['on' => 'localhost'])
    {{ macro('setup') }}
@endtask