Class: Capistrano::Configuration

Inherits:
Object
  • Object
show all
Includes:
Actions::FileTransfer, Actions::Inspect, Actions::Invocation, Callbacks, Connections, Execution, Loading, Namespaces, Roles, Servers, Variables
Defined in:
lib/capistrano/configuration.rb,
lib/capistrano/configuration/roles.rb,
lib/capistrano/configuration/loading.rb,
lib/capistrano/configuration/servers.rb,
lib/capistrano/configuration/callbacks.rb,
lib/capistrano/configuration/execution.rb,
lib/capistrano/configuration/variables.rb,
lib/capistrano/configuration/namespaces.rb,
lib/capistrano/configuration/connections.rb,
lib/capistrano/configuration/actions/inspect.rb,
lib/capistrano/configuration/actions/invocation.rb,
lib/capistrano/configuration/actions/file_transfer.rb

Overview

Represents a specific Capistrano configuration. A Configuration instance may be used to load multiple recipe files, define and describe tasks, define roles, and set configuration variables.

Defined Under Namespace

Modules: Actions, Callbacks, Connections, Execution, Loading, Namespaces, Roles, Servers, Variables

Constant Summary

Constants included from Namespaces

Namespaces::DEFAULT_TASK

Instance Attribute Summary collapse

Attributes included from Callbacks

#callbacks

Attributes included from Loading

#load_paths

Attributes included from Namespaces

#name, #namespaces, #parent, #tasks

Attributes included from Roles

#roles

Attributes included from Variables

#variables

Instance Method Summary collapse

Methods included from Callbacks

#after, #before, included, #initialize_with_callbacks, #invoke_task_directly_with_callbacks, #on, #trigger

Methods included from Actions::FileTransfer

#download, #get, #put, #transfer, #upload

Methods included from Actions::Inspect

#capture, #stream

Methods included from Actions::Invocation

#add_default_command_options, #continue_execution, #continue_execution_for_branch, included, #initialize_with_invocation, #invoke_command, #parallel, #run, #run_tree, #sudo, #sudo_behavior_callback, #sudo_prompt

Methods included from Connections

#connect!, #connection_factory, #establish_connections_to, #execute_on_servers, #failed!, #has_failed?, included, #initialize_with_connections, #sessions, #teardown_connections_to

Methods included from Execution

#current_task, #execute_task, #find_and_execute_task, included, #on_rollback, #rollback_requests, #rollback_requests=, #task_call_frames, #transaction, #transaction?

Methods included from Loading

included, #load, #require

Methods included from Namespaces

#default_task, #desc, #find_task, #fully_qualified_name, included, #namespace, #next_description, #search_task, #task, #task_list, #top

Methods included from Roles

included, #initialize_with_roles, #role, #server

Methods included from Servers

#find_servers, #find_servers_for_task

Methods included from Variables

#[], #exists?, #fetch, included, #method_missing_with_variables, #reset!, #respond_to_with_variables?, #scope, #set, #unset, #variables_has_key?

Constructor Details

#initialize(options = {}) ⇒ Configuration

:nodoc:


24
25
26
27
28
29
# File 'lib/capistrano/configuration.rb', line 24

def initialize(options={}) #:nodoc:
  @debug = false
  @dry_run = false
  @preserve_roles = false
  @logger = Logger.new(options)
end

Instance Attribute Details

#debugObject

The logger instance defined for this configuration.


22
23
24
# File 'lib/capistrano/configuration.rb', line 22

def debug
  @debug
end

#dry_runObject

The logger instance defined for this configuration.


22
23
24
# File 'lib/capistrano/configuration.rb', line 22

def dry_run
  @dry_run
end

#loggerObject

The logger instance defined for this configuration.


22
23
24
# File 'lib/capistrano/configuration.rb', line 22

def logger
  @logger
end

#preserve_rolesObject

The logger instance defined for this configuration.


22
23
24
# File 'lib/capistrano/configuration.rb', line 22

def preserve_roles
  @preserve_roles
end