Module: Middleman::Deploy

Defined in:
lib/middleman-deploy/pkg-info.rb,
lib/middleman-deploy/extension.rb,
lib/middleman-deploy/methods/ftp.rb,
lib/middleman-deploy/methods/git.rb,
lib/middleman-deploy/methods/base.rb,
lib/middleman-deploy/methods/sftp.rb,
lib/middleman-deploy/methods/rsync.rb,
lib/middleman-deploy/strategies/git/base.rb,
lib/middleman-deploy/strategies/git/submodule.rb,
lib/middleman-deploy/strategies/git/force_push.rb

Defined Under Namespace

Modules: Helpers, Methods, Strategies Classes: Options

Constant Summary collapse

PACKAGE = 
'middleman-deploy'
VERSION = 
'0.3.0'
TAGLINE = 
'Deploy a middleman built site over rsync, ftp, sftp, or git (e.g. gh-pages on github).'
README = 
%Q{
You should follow one of the four examples below to setup the deploy
extension in config.rb.

# To deploy the build directory to a remote host via rsync:
activate :deploy do |deploy|
  deploy.method = :rsync
  # host and path *must* be set
  deploy.host = "www.example.com"
  deploy.path = "/srv/www/site"
  # user is optional (no default)
  deploy.user = "tvaughan"
  # port is optional (default is 22)
  deploy.port  = 5309
  # clean is optional (default is false)
  deploy.clean = true
  # flags is optional (default is -avze)
  deploy.flags = "-rltgoDvzO --no-p --del -e"
end

# To deploy to a remote branch via git (e.g. gh-pages on github):
activate :deploy do |deploy|
  deploy.method = :git
  # remote is optional (default is "origin")
  # run `git remote -v` to see a list of possible remotes
  deploy.remote = "some-other-remote-name"

  # branch is optional (default is "gh-pages")
  # run `git branch -a` to see a list of possible branches
  deploy.branch = "some-other-branch-name"

  # strategy is optional (default is :force_push)
  deploy.strategy = :submodule
end

# To deploy the build directory to a remote host via ftp:
activate :deploy do |deploy|
  deploy.method = :ftp
  # host, user, passwword and path *must* be set
  deploy.host = "ftp.example.com"
  deploy.path = "/srv/www/site"
  deploy.user = "tvaughan"
  deploy.password = "secret"
end

# To deploy the build directory to a remote host via sftp:
activate :deploy do |deploy|
  deploy.method = :sftp
  # host, user, passwword and path *must* be set
  deploy.host = "sftp.example.com"
  deploy.port = 22
  deploy.path = "/srv/www/site"
  # user is optional (no default)
  deploy.user = "tvaughan"
  # password is optional (no default)
  deploy.password = "secret"
end}

Class Method Summary collapse

Class Method Details

.options ⇒ Object 



10
11
12
 
# File 'lib/middleman-deploy/extension.rb', line 10

def options
  @@options
end

.registered(app, options_hash = {}) {|options| ... } ⇒ Object Also known as: included

Yields:



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/middleman-deploy/extension.rb', line 14

def registered(app, options_hash = {}, &block)
  options = Options.new(options_hash)
  yield options if block_given?

  # Default options for the rsync method.
  options.port ||= 22
  options.clean ||= false

  # Default options for the git method.
  options.remote ||= 'origin'
  options.branch ||= 'gh-pages'
  options.strategy ||= :force_push
  options.commit_message  ||= nil

  options.build_before ||= false

  @@options = options

  app.send :include, Helpers
end