System.Hapistrano.Config

Definitions for types and functions related to the configuration of the Hapistrano tool.

Documentation

data Config

Hapistrano configuration typically loaded from hap.yaml file.

Constructors

Config

Fields

• configDeployPath :: !(Path Abs Dir)

  Top-level deploy directory on target machine

• configHosts :: ![Target]

  Hosts/ports/shell/ssh args to deploy to. If empty, localhost will be assumed.

• configSource :: !Source

  Location of the Source that contains the code to deploy

• configRestartCommand :: !(Maybe GenericCommand)

  The command to execute when switching to a different release (usually after a deploy or rollback).

• configBuildScript :: !(Maybe [GenericCommand])

  Build script to execute to build the project

• configCopyFiles :: ![CopyThing]

  Collection of files to copy over to target machine before building

• configCopyDirs :: ![CopyThing]

  Collection of directories to copy over to target machine before building

• configLinkedFiles :: ![FilePath]

  Collection of files to link from each release to _shared_

• configLinkedDirs :: ![FilePath]

  Collection of directories to link from each release to _shared_

• configVcAction :: !Bool

  Perform version control related actions. By default, it's assumed to be True.

• configRunLocally :: !(Maybe [GenericCommand])

  Perform a series of commands on the local machine before communication with target server starts

• configTargetSystem :: !TargetSystem

  Optional parameter to specify the target system. It's GNU/Linux by default

• configReleaseFormat :: !(Maybe ReleaseFormat)

  The release timestamp format, the --release-format argument passed via the CLI takes precedence over this value. If neither CLI or configuration file value is specified, it defaults to short

• configKeepReleases :: !(Maybe Natural)

  The number of releases to keep, the --keep-releases argument passed via the CLI takes precedence over this value. If neither CLI or configuration file value is specified, it defaults to 5

• configKeepOneFailed :: !Bool

  Specifies whether to keep all failed releases along with the successful releases or just the latest failed (at least this one should be kept for debugging purposes). The --keep-one-failed argument passed via the CLI takes precedence over this value. If neither CLI or configuration file value is specified, it defaults to False (i.e. keep all failed releases).

• configWorkingDir :: !(Maybe (Path Rel Dir))
• configMaintenanceDirectory :: !(Path Rel Dir)
• configMaintenanceFileName :: !(Path Rel File)

Instances

FromJSON Config

Defined in System.Hapistrano.Config

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

Show Config

Defined in System.Hapistrano.Config

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

Eq Config

Defined in System.Hapistrano.Config

Methods

(==) :: Config -> Config -> Bool

(/=) :: Config -> Config -> Bool

Ord Config

Defined in System.Hapistrano.Config

Methods

compare :: Config -> Config -> Ordering

(<) :: Config -> Config -> Bool

(<=) :: Config -> Config -> Bool

(>) :: Config -> Config -> Bool

(>=) :: Config -> Config -> Bool

max :: Config -> Config -> Config

min :: Config -> Config -> Config

data CopyThing

Information about source and destination locations of a file/directory to copy.

Constructors

CopyThing FilePath FilePath

Instances

FromJSON CopyThing

Defined in System.Hapistrano.Config

Methods

parseJSON :: Value -> Parser CopyThing

parseJSONList :: Value -> Parser [CopyThing]

Show CopyThing

Defined in System.Hapistrano.Config

Methods

showsPrec :: Int -> CopyThing -> ShowS

show :: CopyThing -> String

showList :: [CopyThing] -> ShowS

Eq CopyThing

Defined in System.Hapistrano.Config

Methods

(==) :: CopyThing -> CopyThing -> Bool

(/=) :: CopyThing -> CopyThing -> Bool

Ord CopyThing

Defined in System.Hapistrano.Config

Methods

compare :: CopyThing -> CopyThing -> Ordering

(<) :: CopyThing -> CopyThing -> Bool

(<=) :: CopyThing -> CopyThing -> Bool

(>) :: CopyThing -> CopyThing -> Bool

(>=) :: CopyThing -> CopyThing -> Bool

max :: CopyThing -> CopyThing -> CopyThing

min :: CopyThing -> CopyThing -> CopyThing

data Target

Datatype that holds information about the target host.

Constructors

Target

Fields

• targetHost :: String
• targetPort :: Word
• targetShell :: Shell
• targetSshArgs :: [String]

Instances

Show Target

Defined in System.Hapistrano.Config

Methods

showsPrec :: Int -> Target -> ShowS

show :: Target -> String

showList :: [Target] -> ShowS

Eq Target

Defined in System.Hapistrano.Config

Methods

(==) :: Target -> Target -> Bool

(/=) :: Target -> Target -> Bool

Ord Target

Defined in System.Hapistrano.Config

Methods

compare :: Target -> Target -> Ordering

(<) :: Target -> Target -> Bool

(<=) :: Target -> Target -> Bool

(>) :: Target -> Target -> Bool

(>=) :: Target -> Target -> Bool

max :: Target -> Target -> Target

min :: Target -> Target -> Target

deployStateFilename :: String

Constant with the name of the file used to store the deployment state information.

Orphan instances

FromJSON TargetSystem

Methods

parseJSON :: Value -> Parser TargetSystem

parseJSONList :: Value -> Parser [TargetSystem]