Heroku San 使用与技术文档

1. 安装指南

###Rails 3+ 用户

在 Gemfile 文件中添加以下内容：

group :development do
  gem 'heroku_san'
end

Rails 2 用户

在 config/environment.rb 文件中添加以下内容：

config.gem 'heroku_san'

Rakefile 需要添加以下内容，以便加载 rake 任务：

begin
  require 'heroku_san/tasks'
rescue LoadError
  STDERR.puts "运行 `rake gems:install` 来安装 heroku_san"
end

Sinatra 用户

更新 Gemfile 文件：

group :development do
  gem 'heroku_san'
end

更新 Rakefile 文件：

require "bundler/setup"
begin
  require "heroku_san"
  config_file = File.join(File.expand_path(File.dirname(__FILE__)), 'config', 'heroku.yml')
  HerokuSan.project = HerokuSan::Project.new(config_file, :deploy => HerokuSan::Deploy::Sinatra)
  load "heroku_san/tasks.rb"
rescue LoadError
  # 该 gem 不应在生产环境中安装
end

2. 项目使用说明

在 config/heroku.yml 文件中，你需要添加你想附加到该项目的 Heroku 应用。你可以通过运行以下命令来生成这个文件：

Rails 3+ 用户

rails generate heroku_san

其他用户

rake heroku:create_config

为你的项目定制这个文件。如果是新项目，heroku_san 可以为你创建所有应用，并设置每个应用的 RACK_ENV。

rake all heroku:create heroku:rack_env

根据 config/heroku.yml 配置你的 Heroku 应用：

rake all heroku:config

配置完成后，你可以使用 rake 任务来控制应用。

rake production deploy

每个应用都有一个简短名称的 rake 任务，它会添加到后续命令将执行的服务器列表中。由于这个列表是累加的，你可以轻松选择要运行命令的服务器。

rake demo staging restart

有一个特殊的 rake 任务 'all'，它会使得任何后续命令在所有 Heroku 应用上执行。

rake all restart

如果需要为每个应用添加远程？

rake all heroku:remotes

提供的完整任务列表如下：

rake heroku:addons                # 为应用安装插件。
rake heroku:addons:local          # 列出已配置的插件，而不安装它们
rake heroku:apps                  # 列出已配置的应用
rake heroku:apps:local            # 列出已配置的应用，而不访问 Heroku
rake heroku:config                # 为每个应用添加 config:vars
rake heroku:config:list           # 列出在 Heroku 上设置的配置变量
rake heroku:config:list:local     # 列出本地配置变量，而不设置它们
rake heroku:config:rack_env       # 为每个应用添加正确的 RACK_ENV
rake heroku:console               # 打开远程控制台
rake heroku:create                # 创建 Heroku 应用
rake heroku:create_config         # 创建示例配置文件
rake heroku:db:migrate            # 迁移并重启远程服务器
rake heroku:db:pull               # 从阶段拉取数据库到本地开发数据库
rake heroku:deploy[commit]        # 推送指定的提交，迁移并重启（默认：HEAD）
rake heroku:deploy:after          # 部署后的回调
rake heroku:deploy:before         # 部署前的回调
rake heroku:deploy:force[commit]  # 强制推送指定的提交，迁移并重启（默认：HEAD）
rake heroku:logs                  # 显示 Heroku 日志
rake heroku:logs:tail             # 尾随 Heroku 日志（需要 logging:expanded）
rake heroku:maintenance           # 启用维护模式
rake heroku:maintenance_off       # 禁用维护模式
rake heroku:maintenance_on        # 启用维护模式
rake heroku:push[commit]          # 推送指定的提交（默认：HEAD）
rake heroku:push:force[commit]    # 强制推送指定的提交（默认：HEAD）
rake heroku:rake[task]            # 远程运行一个 rake 任务
rake heroku:remotes               # 为这个项目的所有应用添加 git 远程
rake heroku:restart               # 重启远程服务器
rake heroku:shell                 # 在应用内打开 bash shell
rake heroku:stage:all             # 为后续命令选择所有 Heroku 应用

常用任务已别名为全局命名空间：

task :all           => 'heroku:stage:all'
task :deploy        => 'heroku:deploy'
task 'deploy:force' => 'heroku:deploy:force'
task :before_deploy => 'heroku:deploy:before'
task :after_deploy  => 'heroku:deploy:after'
task :console       => 'heroku:console'
task :restart       => 'heroku:restart'
task :migrate       => 'heroku:db:migrate'
task :logs          => 'heroku:logs:default'
task 'logs:tail'    => 'heroku:logs:tail'
task :shell        => 'heroku:shell'

3. 项目API使用文档

目前，该项目没有提供专门的 API 文档。用户需要根据项目的代码库和已提供的任务来自行探索和使用。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明，这里不再赘述。

请按照上述步骤进行安装和使用，以确保项目的正常运行。