Class Nanoc::Extra::Deployer
In: lib/nanoc/extra/deployer.rb
Parent: Object

Represents a deployer, an object that allows uploading the compiled site to a specific (remote) location.

@abstract Subclass and override {run} to implement a custom filter.

Methods

new   run  

External Aliases

dry_run -> dry_run?

Attributes

config  [R]  @return [Hash] The deployer configuration
dry_run  [R]  @return [Boolean] true if the deployer should only show what would be
  deployed instead of doing the actual deployment
source_path  [R]  @return [String] The path to the directory that contains the files to
  upload. It should not have a trailing slash.

Public Class methods

@param [String] source_path The path to the directory that contains the

  files to upload. It should not have a trailing slash.

@return [Hash] config The deployer configuration

@option params [Boolean] :dry_run (false) true if the deployer should

  only show what would be deployed instead actually deploying

Public Instance methods

Performs the actual deployment.

@abstract

[Validate]