SSHKit与Rake集成：构建自动化部署任务的10个实用示例

SSHKit与Rake集成：构建自动化部署任务的10个实用示例

【免费下载链接】sshkitA toolkit for deploying code and assets to servers in a repeatable, testable, reliable way.项目地址: https://gitcode.com/gh_mirrors/ss/sshkit

SSHKit是一个强大的Ruby工具包，用于以可重复、可测试且可靠的方式将代码和资产部署到服务器。结合Rake任务运行器，它能帮助开发者构建高效的自动化部署流程，显著提升开发效率。

1. 基础部署任务配置

在项目根目录的Rakefile中添加基础部署任务，实现代码拉取和依赖安装：

require 'sshkit' desc "基础部署任务：拉取代码并安装依赖" task :deploy do include SSHKit::DSL on "example.com" do |host| within "/opt/app" do execute :git, :pull execute :bundle, :install, '--deployment' end end end

2. 多服务器并行部署

通过SSHKit的并行执行功能，同时部署到多台服务器：

desc "并行部署到多台服务器" task :deploy_parallel do include SSHKit::DSL servers = %w[app1.example.com app2.example.com] on servers, in: :parallel do |host| within "/opt/app" do execute :git, :pull execute :bundle, :install end end end

3. 数据库迁移与资产预编译

扩展部署任务，添加数据库迁移和资产处理步骤：

desc "完整部署流程：代码更新+数据库迁移+资产预编译" task :deploy_full do include SSHKit::DSL on "example.com" do within "/opt/app" do execute :git, :pull execute :bundle, :install execute :rake, 'db:migrate' execute :rake, 'assets:precompile' execute :touch, 'tmp/restart.txt' end end end

4. 命令映射自定义配置

通过lib/sshkit/command_map.rb自定义命令路径：

# 在Rake任务中配置命令映射 SSHKit.config.command_map[:rake] = "./bin/rake" SSHKit.config.command_map[:bundle] = "/usr/local/rvm/gems/ruby-3.2.0/bin/bundle" desc "使用自定义命令路径部署" task :deploy_custom do include SSHKit::DSL on "example.com" do within "/opt/app" do execute :bundle, :install execute :rake, 'db:migrate' end end end

5. 环境变量管理

为不同环境设置特定环境变量：

desc "带环境变量的部署任务" task :deploy_staging do include SSHKit::DSL SSHKit.config.default_env = { path: '/usr/local/bin:$PATH', rails_env: 'staging' } on "staging.example.com" do within "/opt/staging/app" do execute :git, :pull execute :bundle, :install execute :rake, 'db:migrate' end end end

6. 文件上传与下载

实现服务器与本地之间的文件传输：

desc "上传配置文件并下载日志" task :file_transfer do include SSHKit::DSL on "example.com" do # 上传本地配置文件 upload! 'config/database.yml', '/opt/app/shared/database.yml' # 下载远程日志文件 download! '/var/log/app.log', 'log/remote_app.log' end end

7. 条件执行与错误处理

根据服务器状态执行不同操作：

desc "条件部署任务" task :deploy_conditional do include SSHKit::DSL on "example.com" do |host| within "/opt/app" do if test "[ -d .git ]" execute :git, :pull else execute :git, :clone, 'https://gitcode.com/gh_mirrors/ss/sshkit', '.' end # 错误处理示例 begin execute :rake, 'db:migrate' rescue SSHKit::Command::Failed => e error "数据库迁移失败: #{e.message}" # 可以添加回滚逻辑 end end end end

8. 切换用户与工作目录

以特定用户身份在指定目录执行命令：

desc "以指定用户身份执行命令" task :deploy_as_user do include SSHKit::DSL on "example.com" do as 'deploy' do within '/home/deploy/app' do execute :git, :pull execute :bundle, :install execute :touch, 'tmp/restart.txt' end end end end

9. 自定义输出格式化

配置部署过程的输出格式：

desc "自定义输出格式的部署任务" task :deploy_formatted do include SSHKit::DSL # 设置简洁输出格式 SSHKit.config.use_format :simpletext on "example.com" do within "/opt/app" do info "开始部署..." execute :git, :pull info "代码拉取完成" execute :bundle, :install info "依赖安装完成" end end end

10. 本地命令执行

在本地执行命令，与远程操作结合：

desc "本地与远程结合的部署任务" task :deploy_with_local do include SSHKit::DSL # 本地打包资产 run_locally do execute :rake, 'assets:precompile' execute :tar, 'czf assets.tar.gz public/assets' end # 远程部署 on "example.com" do upload! 'assets.tar.gz', '/tmp/assets.tar.gz' within "/opt/app" do execute :tar, 'xzf /tmp/assets.tar.gz' execute :rm, '/tmp/assets.tar.gz' execute :touch, 'tmp/restart.txt' end end end

以上示例展示了SSHKit与Rake集成的核心功能，涵盖了从简单部署到复杂条件执行的各种场景。通过这些示例，开发者可以构建符合自身需求的自动化部署流程，提高部署效率和可靠性。所有示例代码均可在项目的examples/目录中找到更详细的使用说明。

【免费下载链接】sshkitA toolkit for deploying code and assets to servers in a repeatable, testable, reliable way.项目地址: https://gitcode.com/gh_mirrors/ss/sshkit